kotchasan

Uri extends KBase
in package
implements UriInterface

Class สำหรับจัดการ Uri (PSR-7)

Tags
author

Goragod Wiriya admin@goragod.com

since
1.0

Interfaces, Classes and Traits

UriInterface
Value object representing a URI.

Table of Contents

$cfg  : Config
Config class
$fragment  : string
Uri fragment หลัง #
$host  : string
Uri host
$path  : string
Uri path
$port  : int
Uri port
$query  : string
Uri query string หลัง ?
$request  : Request
Server request class
$scheme  : string
Uri scheme
$userInfo  : string
Uri user info
__construct()  : mixed
Create a new Uri
__toString()  : string
magic function ส่งออกคลาสเป็น String
createBackUri()  : string
ฟังก์ชั่นสร้าง URL สำหรับส่งต่อ Query string จากหน้าหนึ่งไปยังอีกหน้าหนึ่ง เพื่อให้สามารถสร้าง URL ที่สามารถส่งกลับไปยังหน้าเดิมได้โดย ฟังก์ชั่น back() ลบรายการที่ เป็น null ออก
createFromGlobals()  : static
สร้าง Uri จากตัวแปร $_SERVER
createFromUri()  : static
สร้างคลาสจากลิงค์
getAuthority()  : string
ตืนค่า authority ของ Uri [user-info@]host[:port]
getBack()  : string
แปลง GET เป็น query string สำหรับการส่งกลับไปหน้าเดิม ที่มาจากการโพสต์ด้วยฟอร์ม
getFragment()  : string
คืนค่า fragment (ข้อมูลหลัง # ใน Uri) ของ Uri
getHost()  : string
คืนค่า Hostname ของ Uri เช่น domain.tld
getPath()  : string
คืนค่า path ของ Uri เช่น /kotchasan
getPort()  : null|int
คืนค่าหมายเลข Port ของ Uri ไม่ระบุหรือเป็น default port (80,433) คืนค่า null
getQuery()  : string
คืนค่า query string (ข้อมูลหลัง ? ใน Uri) ของ Uri
getScheme()  : string
คืนค่า scheme ของ Uri ไม่รวม :// เช่น http, https
getUserInfo()  : string
คืนค่าข้อมูล user ของ Uri user[:password]
pagination()  : string
ฟังก์ชั่นแสดงผลตัวแบ่งหน้า
paramsToQuery()  : string
ฟังก์ชั่นแปลง Queryparams เป็น Querystring
parseQueryParams()  : array<string|int, mixed>
ฟังก์ชั่น แยก Querystring ออกเป็น array
postBack()  : string
แปลง POST เป็น query string สำหรับการส่งกลับไปหน้าเดิม ที่มาจากการโพสต์ด้วยฟอร์ม คืนค่า URL+query string
withFragment()  : static
กำหนดค่า fragment คืนค่า Object ใหม่
withHost()  : static
กำหนดชื่อ host คืนค่า Object ใหม่
withoutParams()  : static
ฟังก์ลบ Query params ออกจาก URL
withoutQuery()  : static
ลบ query string คืนค่า Object ใหม่
withParams()  : static
ฟังก์ชั่นแทนที่ Query params ลงใน URL
withPath()  : static
กำหนดชื่อ path path ต้องเริ่มต้นด้วย / เช่น /kotchasan หรือเป็นค่าว่าง ถ้าเป็นรากของโดเมน คืนค่า Object ใหม่
withPort()  : static
กำหนดค่า port คืนค่า Object ใหม่
withQuery()  : static
กำหนดค่า query string คืนค่า Object ใหม่
withScheme()  : static
กำหนดค่า scheme ของ Uri คืนค่า Object ใหม่
withUserInfo()  : static
กำหนดข้อมูล user ของ Uri คืนค่า Object ใหม่
createBack()  : string
แปลง POST เป็น query string สำหรับการส่งกลับไปหน้าเดิม ที่มาจากการโพสต์ด้วยฟอร์ม คืนค่า URL+query string
createUriString()  : string
สร้าง Uri เช่น http://domain.tld/
filterPath()  : string
ตรวจสอบ path
filterPort()  : int|null
ตรวจสอบ port
filterQueryFragment()  : string
ตรวจสอบ query และ fragment
filterScheme()  : string
ตรวจสอบ scheme
isNonStandardPort()  : bool
ตรวจสอบว่าเป็น port มาตรฐานหรือไม่ เช่น http เป็น 80 หรือ https เป็น 433

Properties

$fragment

Uri fragment หลัง #

protected string $fragment = ''

$host

Uri host

protected string $host = ''

$path

Uri path

protected string $path = ''

$port

Uri port

protected int $port

$query

Uri query string หลัง ?

protected string $query = ''

$request

Server request class

protected static Request $request

$scheme

Uri scheme

protected string $scheme = ''

$userInfo

Uri user info

protected string $userInfo = ''

Methods

__construct()

Create a new Uri

public __construct(mixed $scheme, mixed $host[, mixed $path = '/' ][, mixed $query = '' ][, mixed $port = null ][, mixed $user = '' ][, mixed $pass = '' ][, mixed $fragment = '' ]) : mixed
Parameters
$scheme : mixed
$host : mixed
$path : mixed = '/'
$query : mixed = ''
$port : mixed = null
$user : mixed = ''
$pass : mixed = ''
$fragment : mixed = ''
Tags
throws
InvalidArgumentException

ถ้า Uri ไม่ถูกต้อง

Return values
mixed

__toString()

magic function ส่งออกคลาสเป็น String

public __toString() : string
Return values
string

createBackUri()

ฟังก์ชั่นสร้าง URL สำหรับส่งต่อ Query string จากหน้าหนึ่งไปยังอีกหน้าหนึ่ง เพื่อให้สามารถสร้าง URL ที่สามารถส่งกลับไปยังหน้าเดิมได้โดย ฟังก์ชั่น back() ลบรายการที่ เป็น null ออก

public createBackUri(array<string|int, mixed> $query_string) : string
Parameters
$query_string : array<string|int, mixed>
Return values
string

createFromGlobals()

สร้าง Uri จากตัวแปร $_SERVER

public static createFromGlobals() : static
Tags
throws
InvalidArgumentException

ถ้า Uri ไม่ถูกต้อง

Return values
static

createFromUri()

สร้างคลาสจากลิงค์

public static createFromUri(string $uri) : static
Parameters
$uri : string
Tags
throws
InvalidArgumentException

ถ้า $uri ไม่ถูกต้อง

Return values
static

getAuthority()

ตืนค่า authority ของ Uri [user-info@]host[:port]

public getAuthority() : string
Return values
string

getBack()

แปลง GET เป็น query string สำหรับการส่งกลับไปหน้าเดิม ที่มาจากการโพสต์ด้วยฟอร์ม

public getBack(string $url[, array<string|int, mixed> $query_string = array() ]) : string
Parameters
$url : string

URL ที่ต้องการส่งกลับ เช่น index.php

$query_string : array<string|int, mixed> = array()

(option) query string ที่ต้องการส่งกลับไปด้วย array('key' => 'value', ...)

Return values
string

URL+query string

getFragment()

คืนค่า fragment (ข้อมูลหลัง # ใน Uri) ของ Uri

public getFragment() : string
Return values
string

getHost()

คืนค่า Hostname ของ Uri เช่น domain.tld

public getHost() : string
Return values
string

getPath()

คืนค่า path ของ Uri เช่น /kotchasan

public getPath() : string
Return values
string

getPort()

คืนค่าหมายเลข Port ของ Uri ไม่ระบุหรือเป็น default port (80,433) คืนค่า null

public getPort() : null|int
Return values
null|int

getQuery()

คืนค่า query string (ข้อมูลหลัง ? ใน Uri) ของ Uri

public getQuery() : string
Return values
string

getScheme()

คืนค่า scheme ของ Uri ไม่รวม :// เช่น http, https

public getScheme() : string
Return values
string

getUserInfo()

คืนค่าข้อมูล user ของ Uri user[:password]

public getUserInfo() : string
Return values
string

pagination()

ฟังก์ชั่นแสดงผลตัวแบ่งหน้า

public pagination(int $totalpage, int $page[, int $maxlink = 9 ]) : string
Parameters
$totalpage : int

จำนวนหน้าทั้งหมด

$page : int

หน้าปัจจุบัน

$maxlink : int = 9

(optional) จำนวนตัวเลือกแบ่งหน้าสูงสุด ค่าปกติ 9

Return values
string

paramsToQuery()

ฟังก์ชั่นแปลง Queryparams เป็น Querystring

public paramsToQuery(array<string|int, mixed> $params, bool $encode) : string
Parameters
$params : array<string|int, mixed>
$encode : bool

false เชื่อม Querystring ด้วย &, true เชื่อม Querystring ด้วย &

Return values
string

parseQueryParams()

ฟังก์ชั่น แยก Querystring ออกเป็น array

public parseQueryParams([string $query = null ]) : array<string|int, mixed>
Parameters
$query : string = null
Return values
array<string|int, mixed>

postBack()

แปลง POST เป็น query string สำหรับการส่งกลับไปหน้าเดิม ที่มาจากการโพสต์ด้วยฟอร์ม คืนค่า URL+query string

public postBack(string $url[, array<string|int, mixed> $query_string = array() ]) : string
Parameters
$url : string

URL ที่ต้องการส่งกลับ เช่น index.php

$query_string : array<string|int, mixed> = array()

(option) query string ที่ต้องการส่งกลับไปด้วย array('key' => 'value', ...)

Return values
string

withFragment()

กำหนดค่า fragment คืนค่า Object ใหม่

public withFragment(string $fragment) : static
Parameters
$fragment : string
Tags
throws
InvalidArgumentException

ถ้า fragment ไม่ถูกต้อง

Return values
static

withHost()

กำหนดชื่อ host คืนค่า Object ใหม่

public withHost(string $host) : static
Parameters
$host : string

ชื่อ host

Return values
static

withoutParams()

ฟังก์ลบ Query params ออกจาก URL

public withoutParams(string|array<string|int, mixed> $names[, bool $encode = false ]) : static
Parameters
$names : string|array<string|int, mixed>

ชื่อของ attributes ที่ต้องการลบ

$encode : bool = false

false (default) เชื่อม Querystring ด้วย &, true เชื่อม Querystring ด้วย &

Return values
static

withoutQuery()

ลบ query string คืนค่า Object ใหม่

public withoutQuery(array<string|int, mixed> $query) : static
Parameters
$query : array<string|int, mixed>

array('q1' => 'value1', 'q2' => 'value2')

Return values
static

withParams()

ฟังก์ชั่นแทนที่ Query params ลงใน URL

public withParams(array<string|int, mixed> $params[, bool $encode = false ]) : static
Parameters
$params : array<string|int, mixed>
$encode : bool = false

false (default) เชื่อม Querystring ด้วย &, true เชื่อม Querystring ด้วย &

Return values
static

withPath()

กำหนดชื่อ path path ต้องเริ่มต้นด้วย / เช่น /kotchasan หรือเป็นค่าว่าง ถ้าเป็นรากของโดเมน คืนค่า Object ใหม่

public withPath(string $path) : static
Parameters
$path : string

ชื่อ path

Return values
static

withPort()

กำหนดค่า port คืนค่า Object ใหม่

public withPort(null|int $port) : static
Parameters
$port : null|int

หมายเลข port 1- 65535 หรือ null

Tags
throws
InvalidArgumentException

ถ้า port ไม่ถูกต้อง

Return values
static

withQuery()

กำหนดค่า query string คืนค่า Object ใหม่

public withQuery(string $query) : static
Parameters
$query : string
Tags
throws
InvalidArgumentException

ถ้า query string ไม่ถูกต้อง

Return values
static

withScheme()

กำหนดค่า scheme ของ Uri คืนค่า Object ใหม่

public withScheme(string $scheme) : static
Parameters
$scheme : string

http หรือ https หรือค่าว่าง

Tags
throws
InvalidArgumentException

ถ้าไม่ใช่ ค่าว่าง http หรือ https

Return values
static

withUserInfo()

กำหนดข้อมูล user ของ Uri คืนค่า Object ใหม่

public withUserInfo(string $user[, string $password = null ]) : static
Parameters
$user : string
$password : string = null
Return values
static

createBack()

แปลง POST เป็น query string สำหรับการส่งกลับไปหน้าเดิม ที่มาจากการโพสต์ด้วยฟอร์ม คืนค่า URL+query string

private createBack(string $url, array<string|int, mixed> $source, array<string|int, mixed> $query_string) : string
Parameters
$url : string

URL ที่ต้องการส่งกลับ เช่น index.php

$source : array<string|int, mixed>

query string จาก $_POST หรือ $_GET

$query_string : array<string|int, mixed>

query string ที่ต้องการส่งกลับไปด้วย array('key' => 'value', ...)

Return values
string

createUriString()

สร้าง Uri เช่น http://domain.tld/

private static createUriString(string $scheme, string $authority, string $path, string $query, string $fragment) : string
Parameters
$scheme : string
$authority : string
$path : string
$query : string
$fragment : string
Return values
string

filterPath()

ตรวจสอบ path

private filterPath( $path) : string
Parameters
$path :
Return values
string

filterPort()

ตรวจสอบ port

private filterPort(string $scheme, string $host, int $port) : int|null
Parameters
$scheme : string
$host : string
$port : int
Tags
throws
InvalidArgumentException

ถ้า port ไม่ถูกต้อง

Return values
int|null

filterQueryFragment()

ตรวจสอบ query และ fragment

private filterQueryFragment( $str) : string
Parameters
$str :
Return values
string

filterScheme()

ตรวจสอบ scheme

private filterScheme(string $scheme) : string
Parameters
$scheme : string
Tags
throws
InvalidArgumentException

ถ้าไม่ใช่ ค่าว่าง http หรือ https

Return values
string

isNonStandardPort()

ตรวจสอบว่าเป็น port มาตรฐานหรือไม่ เช่น http เป็น 80 หรือ https เป็น 433

private isNonStandardPort(string $scheme, string $host, int $port) : bool
Parameters
$scheme : string
$host : string
$port : int
Return values
bool

Search results