Class HeaderParameter

Representation of a header parameter.

Namespace: ICanBoogie\HTTP
See: http://tools.ietf.org/html/rfc2231
See: http://tools.ietf.org/html/rfc5987
See: http://greenbytes.de/tech/tc2231/#attwithfn2231utf8
Located at vendor/icanboogie/http/lib/headers/parameter.php

Methods summary

`public static ICanBoogie\HTTP\HeaderParameter`	# `from( mixed $source )` Creates a `ICanBoogie\HTTP\HeaderParameter` instance from the provided source. Creates a `ICanBoogie\HTTP\HeaderParameter` instance from the provided source. Parameters `$source` `mixed` $source Returns `ICanBoogie\HTTP\HeaderParameter`
`public static boolean`	# `is_token( string $str )` Checks if the provided string is a token. Checks if the provided string is a token. token = 1*<any CHAR except CTLs or separators> separators = "(" \| ")" \| "<" \| ">" \| "@" \| "," \| ";" \| ":" \| "\" \| <"> \| "/" \| "[" \| "]" \| "?" \| "=" \| "{" \| "}" \| SP \| HT CHAR = <any US-ASCII character (octets 0 - 127)> CTL = <any US-ASCII control character (octets 0 - 31) and DEL (127)> SP = <US-ASCII SP, space (32)> HT = <US-ASCII HT, horizontal-tab (9)> Parameters `$str` `string` $str Returns `boolean` `true` if the provided string is a token, `false` otherwise.
`public static string`	# `to_ascii( string $str )` Converts a string to the ASCI charset. Converts a string to the ASCI charset. Accents are converted using `ICanBoogie\remove_accents()`. Characters that are not in the ASCII range are discarted. Parameters `$str` `string` $str The string to convert. Returns `string`
`public`	# `__construct( string $attribute, string $value = null, string\|null $language = null )` Initializes the `ICanBoogie\HTTP\HeaderParameter::$attribute`, `ICanBoogie\HTTP\HeaderParameter::$value` and `ICanBoogie\HTTP\HeaderParameter::$language` properties. Initializes the `ICanBoogie\HTTP\HeaderParameter::$attribute`, `ICanBoogie\HTTP\HeaderParameter::$value` and `ICanBoogie\HTTP\HeaderParameter::$language` properties. Parameters `$attribute` `string` $attribute `$value` `string` $value `$language` `string\|null` $language
`public mixed`	# `__get( string $property )` Handles the `ICanBoogie\HTTP\HeaderParameter::$attribute` and $charset magic properties. Handles the `ICanBoogie\HTTP\HeaderParameter::$attribute` and $charset magic properties. Parameters `$property` `string` $property Returns `mixed` Throws `ICanBoogie\PropertyNotDefined` in attempt to get an undefined property.
`public string`	# `render( )` Renders the attribute and value into a string. Renders the attribute and value into a string. A string of text is parsed as a single word if it is quoted using double-quote marks. quoted-string = ( <"> *(qdtext \| quoted-pair ) <"> ) qdtext = <any TEXT except <">> The backslash character ("\") MAY be used as a single-character quoting mechanism only within quoted-string and comment constructs. quoted-pair = "\" CHAR Returns `string`
`public string`	# `__toString( )` Returns the value of the parameter. Returns the value of the parameter. Note: `ICanBoogie\HTTP\HeaderParameter::render()` to render the attribute and value of the parameter. Returns `string`

Magic methods summary

Properties summary

`protected string`	`$attribute`	# Token of the parameter. Token of the parameter.
`public string`	`$value`	# Value of the parameter. Value of the parameter.
`public string`	`$language`	# Language of the value. Language of the value.

Magic properties

`public read-only string`	`$attribute`		# The attribute of the parameter. The attribute of the parameter.
`public read-only string`	`$charset`		# The charset of the parameter's value. The charset of the parameter's value.