kotchasan

AbstractMessage
in package
implements MessageInterface

HTTP messages base class (PSR-7)

Tags
author

Goragod Wiriya admin@goragod.com

since
1.0

Interfaces, Classes and Traits

MessageInterface
HTTP messages consist of requests from a client to a server and responses from a server to a client. This interface defines the methods common to each.

Table of Contents

$headers  : array<string|int, mixed>
$protocol  : string
$stream  : StreamInterface
__construct()  : mixed
init Class
getBody()  : StreamInterface
อ่าน stream
getHeader()  : array<string|int, string>
อ่าน header ที่ต้องการ ผลลัพท์เป็น array คืนค่าแอเรย์ของ header ถ้าไม่พบคืนค่าแอเรย์ว่าง
getHeaderLine()  : string
อ่าน header ที่ต้องการ ผลลัพท์เป็น string คืนค่ารายการ header ทั้งหมดที่พบเชื่อมต่อด้วย ลูกน้ำ (,) หรือคืนค่าข้อความว่าง หากไม่พบ
getHeaders()  : array<string|int, mixed>
คืนค่า header ทั้งหมด ผลลัพท์เป็น array
getProtocolVersion()  : string
คืนค่าเวอร์ชั่นของโปรโตคอล เช่น 1.1, 1.0
hasHeader()  : bool
ตรวจสอบว่ามี header หรือไม่ คืนค่า true ถ้ามี
withAddedHeader()  : static
เพิ่ม header ใหม่
withBody()  : static
กำหนด stream
withHeader()  : static
กำหนด header แทนที่รายการเดิม
withHeaders()  : static
กำหนด header พร้อมกันหลายรายการ แทนที่รายการเดิม
withoutHeader()  : static
ลบ header
withProtocolVersion()  : static
กำหนดเวอร์ชั่นของโปรโตคอล
filterHeader()  : mixed
ตรวจสอบความถูกต้องของ header
getRequestHeaders()  : array<string|int, mixed>
ฟังก์ชั่นคืนค่า HTTP Header

Properties

Methods

__construct()

init Class

public __construct([bool $with_header = false ]) : mixed
Parameters
$with_header : bool = false

true คืนค่า HTTP Header ด้วย, false (default) ไม่รวม HTTP Header

Return values
mixed

getHeader()

อ่าน header ที่ต้องการ ผลลัพท์เป็น array คืนค่าแอเรย์ของ header ถ้าไม่พบคืนค่าแอเรย์ว่าง

public getHeader(string $name) : array<string|int, string>
Parameters
$name : string
Return values
array<string|int, string>

getHeaderLine()

อ่าน header ที่ต้องการ ผลลัพท์เป็น string คืนค่ารายการ header ทั้งหมดที่พบเชื่อมต่อด้วย ลูกน้ำ (,) หรือคืนค่าข้อความว่าง หากไม่พบ

public getHeaderLine(string $name) : string
Parameters
$name : string
Return values
string

getHeaders()

คืนค่า header ทั้งหมด ผลลัพท์เป็น array

public getHeaders() : array<string|int, mixed>
Return values
array<string|int, mixed>

getProtocolVersion()

คืนค่าเวอร์ชั่นของโปรโตคอล เช่น 1.1, 1.0

public getProtocolVersion() : string
Return values
string

hasHeader()

ตรวจสอบว่ามี header หรือไม่ คืนค่า true ถ้ามี

public hasHeader(string $name) : bool
Parameters
$name : string
Return values
bool

withAddedHeader()

เพิ่ม header ใหม่

public withAddedHeader(string $name, string|array<string|int, string> $value) : static
Parameters
$name : string

ชื่อของ Header

$value : string|array<string|int, string>

ค่าของ Header เป็น string หรือ แอเรย์ของ string

Tags
throws
InvalidArgumentException

ถ้าชื่อ header ไม่ถูกต้อง

Return values
static

withBody()

กำหนด stream

public withBody(streamInterface $body) : static
Parameters
$body : streamInterface
Return values
static

withHeader()

กำหนด header แทนที่รายการเดิม

public withHeader(string $name, string|array<string|int, string> $value) : static
Parameters
$name : string

ชื่อของ Header

$value : string|array<string|int, string>

ค่าของ Header เป็น string หรือ แอเรย์ของ string

Tags
throws
InvalidArgumentException

for invalid header names or values

Return values
static

withHeaders()

กำหนด header พร้อมกันหลายรายการ แทนที่รายการเดิม

public withHeaders(array<string|int, mixed> $headers) : static
Parameters
$headers : array<string|int, mixed>

array($key => $value, $key => $value...)

Tags
throws
InvalidArgumentException

for invalid header names or values

Return values
static

withoutHeader()

ลบ header

public withoutHeader(string $name) : static
Parameters
$name : string

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

Return values
static

withProtocolVersion()

กำหนดเวอร์ชั่นของโปรโตคอล

public withProtocolVersion(string $version) : static
Parameters
$version : string

เช่น 1.1, 1.0

Return values
static

filterHeader()

ตรวจสอบความถูกต้องของ header

protected filterHeader(string $name) : mixed
Parameters
$name : string
Tags
throws
InvalidArgumentException

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

Return values
mixed

getRequestHeaders()

ฟังก์ชั่นคืนค่า HTTP Header

protected getRequestHeaders() : array<string|int, mixed>
Return values
array<string|int, mixed>

Search results