HeaderCollection¶
-
class
AeonDigital\Http\Data\HeaderCollection¶ - Coleção que permite agrupar Headers
Http.Parent: AeonDigital\Http\Data\Abstracts\aHttpDataCollectionImplements: AeonDigital\Interfaces\Http\Data\iHeaderCollectionAeonDigital\Interfaces\Collection\iCaseInsensitiveCollection
Methods¶
-
public
AeonDigital\Http\Data\HeaderCollection::toString($originalKeys=false)¶ - Retorna uma representação dos dados da coleção em formato de string.
Parameters: - ‹ ?bool › $originalKeys
Quandotrueirá usar as chaves conforme foram definidas na funçãoset. Se no armazenamento interno elas sofrerem qualquer alteração e for definidofalseentão elas retornarão seu formato alterado.
Returns: ‹ string ›
- ‹ ?bool › $originalKeys
-
public
AeonDigital\Http\Data\HeaderCollection::toArray($originalKeys=false)¶ - Retorna toda a coleção atualmente armazenada em um array associativo [ string => mixed ].Em caso de uma coleção vazia será retornado
[].Prioriza o retorno das chaves conforme usadas internamente pois considera que se há umaalteração nelas deve-se a alguma importância relacionado a seu formato de uso.Parameters: - ‹ ?bool › $originalKeys
Quandotrueirá usar as chaves conforme foram definidas na funçãoset. Se no armazenamento interno elas sofrerem qualquer alteração e for definidofalseentão elas retornarão seu formato alterado.
Returns: ‹ array ›
- ‹ ?bool › $originalKeys
-
public
AeonDigital\Http\Data\HeaderCollection::__construct($initialValues=[])¶ - Inicia um novo objeto
HeaderCollection.Cada entrada corresponde a um array de valores conforme o modelo:```header => string[];```Parameters: - ‹ ?array › $initialValues
Valores com os quais a instância deve iniciar.
Throws: ‹ InvalidArgumentException ›
Caso algum dos valores iniciais a serem definidos não seja aceito. - ‹ ?array › $initialValues
-
public static
AeonDigital\Http\Data\HeaderCollection::fromString($str)¶ - Utiliza as informações da string indicada para iniciar uma nova coleção de dados.
Parameters: - ‹ string › $str
String que será convertida em uma nova coleção.
Returns: ‹ static ›
Throws: ‹ InvalidArgumentException ›
Caso a string passada seja inválida para construção de uma nova coleção. - ‹ string › $str
-
public
AeonDigital\Http\Data\HeaderCollection::getHeaderLine($key)¶ - Retorna uma string representando toda a coleção de valores determinados para o headerde nome indicado. Cada valor é separado por virgula.Uma string vazia será retornada caso o header não exista.
Parameters: - ‹ string › $key
Nome do header alvo.
Returns: ‹ string ›
- ‹ string › $key