Class Swift_Mime_Headers_ParameterizedHeader

An abstract base MIME Header.

Swift_Mime_Headers_AbstractHeader implements Swift_Mime_Header

Swift_Mime_Headers_ParameterizedHeader implements Swift_Mime_ParameterizedHeader

Package: Swift\Mime
Author: Chris Corbyn
Located at vendors/swiftmailer/lib/classes/Swift/Mime/Headers/ParameterizedHeader.php

Methods summary

`public`	# `__construct( string $name, Swift_Mime_HeaderEncoder $encoder, Swift_Encoder $paramEncoder = null, Swift_Mime_Grammar $grammar )` Creates a new ParameterizedHeader with $name. Creates a new ParameterizedHeader with $name. Parameters `$name` `string` $name `$encoder` `Swift_Mime_HeaderEncoder` $encoder `$paramEncoder` `Swift_Encoder` $paramEncoder, optional `$grammar` `Swift_Mime_Grammar` $grammar Overrides `Swift_Mime_Headers_UnstructuredHeader::__construct`
`public integer`	# `getFieldType( )` Get the type of Header that this instance represents. Get the type of Header that this instance represents. Returns `integer` See `Swift_Mime_Header::TYPE_TEXT`, `Swift_Mime_Header::TYPE_PARAMETERIZED`, `Swift_Mime_Header::TYPE_MAILBOX` `Swift_Mime_Header::TYPE_DATE`, `Swift_Mime_Header::TYPE_ID`, `Swift_Mime_Header::TYPE_PATH` Overrides `Swift_Mime_Headers_UnstructuredHeader::getFieldType` Implementation of `Swift_Mime_Header::getFieldType()`
`public`	# `setCharset( string $charset )` Set the character set used in this Header. Set the character set used in this Header. Parameters `$charset` `string` $charset Overrides `Swift_Mime_Headers_AbstractHeader::setCharset` Implementation of `Swift_Mime_Header::setCharset()`
`public`	# `setParameter( string $parameter, string $value )` Set the value of $parameter. Set the value of $parameter. Parameters `$parameter` `string` $parameter `$value` `string` $value Implementation of `Swift_Mime_ParameterizedHeader::setParameter()`
`public string`	# `getParameter( mixed $parameter )` Get the value of $parameter. Get the value of $parameter. Returns `string` Implementation of `Swift_Mime_ParameterizedHeader::getParameter()`
`public`	# `setParameters( array $parameters )` Set an associative array of parameter names mapped to values. Set an associative array of parameter names mapped to values. Parameters `$parameters` `string[]`
`public string[]`	# `getParameters( )` Returns an associative array of parameter names mapped to values. Returns an associative array of parameter names mapped to values. Returns `string[]`
`public string`	# `getFieldBody( )` Get the value of this header prepared for rendering. Get the value of this header prepared for rendering. Returns `string` Overrides `Swift_Mime_Headers_UnstructuredHeader::getFieldBody` Implementation of `Swift_Mime_Header::getFieldBody()`
`protected array`	# `toTokens( string $string = null )` Generate a list of all tokens in the final header. This doesn't need to be overridden in theory, but it is for implementation reasons to prevent potential breakage of attributes. Generate a list of all tokens in the final header. This doesn't need to be overridden in theory, but it is for implementation reasons to prevent potential breakage of attributes. Parameters `$string` `string` $string The string to tokenize Returns `array` An array of tokens as strings Overrides `Swift_Mime_Headers_AbstractHeader::toTokens`
`private string`	# `_createParameter( string $name, string $value )` Render a RFC 2047 compliant header parameter from the $name and $value. Render a RFC 2047 compliant header parameter from the $name and $value. Parameters `$name` `string` $name `$value` `string` $value Returns `string`
`private string`	# `_getEndOfParameterValue( string $value, boolean $encoded = false, boolean $firstLine = false )` Returns the parameter value from the "=" and beyond. Returns the parameter value from the "=" and beyond. Parameters `$value` `string` $value to append `$encoded` `boolean` $encoded `$firstLine` `boolean` $firstLine Returns `string`

Methods inherited from Swift_Mime_Headers_UnstructuredHeader

getFieldBodyModel(), getValue(), setFieldBodyModel(), setValue()

Methods inherited from Swift_Mime_Headers_AbstractHeader

__toString(), clearCachedValueIf(), createPhrase(), encodeWords(), generateTokenLines(), getCachedValue(), getCharset(), getEncodableWordTokens(), getEncoder(), getFieldName(), getGrammar(), getLanguage(), getMaxLineLength(), getTokenAsEncodedWord(), setCachedValue(), setEncoder(), setFieldName(), setGrammar(), setLanguage(), setMaxLineLength(), toString(), tokenNeedsEncoding()

Magic methods summary

Constants summary

`string`	`TOKEN_REGEX`	`'(?:[\x21\x23-\x27\x2A\x2B\x2D\x2E\x30-\x39\x41-\x5A\x5E-\x7E]+)'`	# RFC 2231's definition of a token. RFC 2231's definition of a token.

Constants inherited from Swift_Mime_Header

TYPE_DATE, TYPE_ID, TYPE_MAILBOX, TYPE_PARAMETERIZED, TYPE_PATH, TYPE_TEXT

Properties summary

`private Swift_Encoder`	`$_paramEncoder`	# The Encoder used to encode the parameters. The Encoder used to encode the parameters.
`private string[]`	`$_params`	# The parameters as an associative array. The parameters as an associative array.

Packages

Classes

Interfaces

Class Swift_Mime_Headers_ParameterizedHeader

Methods summary

Parameters

Overrides

Returns

See

Overrides

Implementation of

Parameters

Overrides

Implementation of

Parameters

Implementation of

Returns

Implementation of

Parameters

Returns

Returns

Overrides

Implementation of

Parameters

Returns

Overrides

Parameters

Returns

Parameters

Returns

Methods inherited from Swift_Mime_Headers_UnstructuredHeader

Methods inherited from Swift_Mime_Headers_AbstractHeader

Magic methods summary

Constants summary

Constants inherited from Swift_Mime_Header

Properties summary