Interface HeaderContract

Contract interfaces enforce expected behavior in a non-colliding way. They are tasked with enforcing methods, and extending interfaces provided by standards and other packages for compatibility.

All valid oroboros classes MUST extend at

least one Contract Interface to be considered valid.

oroboros\core\interfaces\contract\utilities\http\HeaderContract implements oroboros\core\interfaces\contract\utilities\UtilityContract

Direct known implementers

oroboros\core\abstracts\utilities\http\AbstractHeader, oroboros\core\abstracts\utilities\http\AbstractRequestHeader, oroboros\core\abstracts\utilities\http\AbstractResponseHeader

Indirect known implementers

oroboros\core\utilities\http\Header, oroboros\core\utilities\http\RequestHeader, oroboros\core\utilities\http\ResponseHeader

Namespace: oroboros\core\interfaces\contract\utilities\http
Package: oroboros\core\utilities
Category: contract-interfaces
License: The MIT License (MIT)
Author: Brian Dayhoff mopsyd@me.com
Version: 0.2.4-alpha
Since: 0.2.4-alpha
Link: bitbucket.org/oroborosframework/oroboros-core/wiki/development/api/contract_interface.md
Located at core/interfaces/contract/utilities/http/HeaderContract.php

Methods summary

`public`	# `__construct( string $name, string\|array $value, string $type = 'response', string $separator = ',' )` Constructs an object representation of a header Constructs an object representation of a header Parameters `$name` the case insensitive header name `$value` $values Represents the value of the header. May be a string or an array. If the header can have multiple values and a string is passed, the string will be split based on the defined separator. `$type` $separator (optional) designates the correct separator for headers that carry multiple values. Defaults to a comma if not supplied. `$separator` $type (optional) designates whether the specified header is a request or response header. Assumes response if not defined otherwise. Throws `oroboros\core\utilities\exception\InvalidArgumentException` if an invalid parameter was passed Link https://www.w3.org/Protocols/rfc2616/rfc2616-sec4.html#sec4.2
`public string`	# `__toString( )` Hooks into native PHP string language constructs, and returns the string representation of the header value. Hooks into native PHP string language constructs, and returns the string representation of the header value. Returns string
`public string`	# `getName( )` Returns the name of the header. Returns the name of the header. Returns string
`public array`	# `getValue( )` Returns the value(s) of the header, represented as an array. Returns the value(s) of the header, represented as an array. Returns array
`public string`	# `getValueString( )` Returns only the header value, contencated as a string. Returns only the header value, contencated as a string. Returns string
`public`	# `setValue( string\|array $value )` Replaces the existing value with the supplied value. Replaces the existing value with the supplied value. Parameters `$value` Throws `oroboros\core\utilities\exception\InvalidArgumentException` if an invalid parameter was passed
`public`	# `appendValue( string $value )` Adds an additional value to append to the header value. This method will not replace existing values. Adds an additional value to append to the header value. This method will not replace existing values. Parameters `$value` Throws `oroboros\core\utilities\exception\InvalidArgumentException` if an invalid parameter was passed
`public`	# `send( )` Sends the header. This will replace the same header if it has already been sent. Sends the header. This will replace the same header if it has already been sent.

Namespaces

Interfaces

Interface HeaderContract

least one Contract Interface to be considered valid.

Direct known implementers

Indirect known implementers

Methods summary

Parameters

Throws

Link

Returns

Returns

Returns

Returns

Parameters

Throws

Parameters

Throws