Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Открытые члены | Открытые статические члены | Открытые атрибуты | Защищенные статические члены | Защищенные данные | Полный список членов класса
Класс HttpHeaders
+ Граф наследования:HttpHeaders:

Открытые члены

 __construct (array $headers=null)
 
 add ($name, $value)
 
 set ($name, $value)
 
 get ($name, $returnArray=false)
 
 delete ($name)
 
 has (string $name)
 
 clear ()
 
 toString ()
 
 toArray ()
 
 getContentType ()
 
 getContentTypeAttribute (string $attribute)
 
 getBoundary ()
 
 getCharset ()
 
 getContentDisposition ()
 
 getFilename ()
 
 getIterator ()
 
 getCookies ()
 
 getHeaders ()
 
 parseStatus (string $status)
 
 setStatus (int $status, ?string $reasonPhrase=null)
 
 getStatus ()
 
 setVersion (string $version)
 
 getVersion ()
 
 getReasonPhrase ()
 

Открытые статические члены

static createFromString (string $response)
 

Открытые атрибуты

const DEFAULT_HTTP_STATUS = 0
 

Защищенные статические члены

static validateName (string $name)
 
static validateValue (string $value)
 

Защищенные данные

array $headers = []
 
string $version = '1.1'
 
int $status
 
string $reasonPhrase = null
 

Подробное описание

См. определение в файле httpheaders.php строка 17

Конструктор(ы)

◆ __construct()

__construct ( array $headers = null)
Аргументы
string[]  |  string[][]  |  null$headers

См. определение в файле httpheaders.php строка 29

Методы

◆ add()

add ( $name,
$value )

Adds a header value.

Аргументы
string$name
string  |  array$value
Исключения

InvalidArgumentException

См. определение в файле httpheaders.php строка 46

◆ clear()

clear ( )

Clears all headers.

См. определение в файле httpheaders.php строка 178

◆ createFromString()

static createFromString ( string $response)
static

Creates an object from a http response string.

Аргументы
string$response
Возвращает
HttpHeaders

См. определение в файле httpheaders.php строка 391

◆ delete()

delete ( $name)

Deletes a header or headers by its name.

Аргументы
string$name
Возвращает
void

См. определение в файле httpheaders.php строка 152

◆ get()

get ( $name,
$returnArray = false )

Returns a header value by its name. If $returnArray is true then an array with multiple values is returned.

Аргументы
string$name
bool$returnArray
Возвращает
null | string | string[]

См. определение в файле httpheaders.php строка 129

◆ getBoundary()

getBoundary ( )

Returns the boundary value of the Content-Type header.

Возвращает
null|string

См. определение в файле httpheaders.php строка 257

◆ getCharset()

getCharset ( )

Returns the charset part of the Content-Type header.

Возвращает
null|string

См. определение в файле httpheaders.php строка 266

◆ getContentDisposition()

getContentDisposition ( )

Returns disposition-type part of the Content-Disposition header

Возвращает
null|string Disposition-type part of the Content-Disposition header if found or null otherwise.

См. определение в файле httpheaders.php строка 275

◆ getContentType()

getContentType ( )

Returns the content type part of the Content-Type header in lower case.

Возвращает
null|string

См. определение в файле httpheaders.php строка 214

◆ getContentTypeAttribute()

getContentTypeAttribute ( string $attribute)

Returns the specified attribute part of the Content-Type header.

Возвращает
null|string

См. определение в файле httpheaders.php строка 232

◆ getCookies()

getCookies ( )

Returns parsed cookies from 'set-cookie' headers.

Возвращает
HttpCookies

См. определение в файле httpheaders.php строка 360

◆ getFilename()

getFilename ( )

Returns a filename from the Content-disposition header.

Возвращает
string|null Filename if it was found in the Content-disposition header or null otherwise.

См. определение в файле httpheaders.php строка 293

◆ getHeaders()

getHeaders ( )

Retuns the headers as a two-dimentional array ('name' => values).

Возвращает
string[][]

См. определение в файле httpheaders.php строка 380

◆ getIterator()

getIterator ( )

Retrieve an external iterator Traversable An instance of an object implementing Iterator or Traversable 5.0.0

См. определение в файле httpheaders.php строка 345

◆ getReasonPhrase()

getReasonPhrase ( )

См. определение в файле httpheaders.php строка 480

◆ getStatus()

getStatus ( )

См. определение в файле httpheaders.php строка 463

◆ getVersion()

getVersion ( )

См. определение в файле httpheaders.php строка 475

◆ has()

has ( string $name)

Returns true if a header is set.

Аргументы
string$name
Возвращает
bool

См. определение в файле httpheaders.php строка 168

◆ parseStatus()

parseStatus ( string $status)
Аргументы
string$status
Возвращает
$this

См. определение в файле httpheaders.php строка 437

◆ set()

set ( $name,
$value )

Sets (replaces) a header value.

Аргументы
string$name
string  |  string[]$value

См. определение в файле httpheaders.php строка 117

◆ setStatus()

setStatus ( int $status,
?string $reasonPhrase = null )

Sets HTTP status code and prase.

Аргументы
int$status
string | null$reasonPhrase
Возвращает
$this

См. определение в файле httpheaders.php строка 455

◆ setVersion()

setVersion ( string $version)

См. определение в файле httpheaders.php строка 468

◆ toArray()

toArray ( )

Returns headers as a raw array.

Возвращает
array

См. определение в файле httpheaders.php строка 205

◆ toString()

toString ( )

Returns the string representation for an HTTP request.

Возвращает
string

См. определение в файле httpheaders.php строка 187

◆ validateName()

static validateName ( string $name)
staticprotected
См. также
https://tools.ietf.org/html/rfc7230#section-3.2 field-name = token token = 1*tchar tchar = "!" / "#" / "$" / "%" / "&" / "'" / "*" / "+" / "-" / "." / "^" / "_" / "`" / "|" / "~" / DIGIT / ALPHA

См. определение в файле httpheaders.php строка 94

◆ validateValue()

static validateValue ( string $value)
staticprotected
См. также
https://tools.ietf.org/html/rfc7230#section-3.2 field-value = *( field-content / obs-fold ) field-content = field-vchar [ 1*( SP / HTAB ) field-vchar ] field-vchar = VCHAR / obs-text VCHAR = x21-7E obs-text = x80-FF

См. определение в файле httpheaders.php строка 107

Данные класса

◆ $headers

array $headers = []
protected

См. определение в файле httpheaders.php строка 21

◆ $reasonPhrase

string $reasonPhrase = null
protected

См. определение в файле httpheaders.php строка 24

◆ $status

int $status
protected

См. определение в файле httpheaders.php строка 23

◆ $version

string $version = '1.1'
protected

См. определение в файле httpheaders.php строка 22

◆ DEFAULT_HTTP_STATUS

const DEFAULT_HTTP_STATUS = 0

См. определение в файле httpheaders.php строка 19