Overview

Namespaces

  • PHPixie
    • Auth
      • Context
        • Container
      • Domains
      • Providers
        • Builder
        • Provider
      • Repositories
        • Registry
        • Repository
    • AuthHTTP
      • Providers
    • AuthLogin
      • Providers
      • Repository
    • AuthORM
      • Repositories
        • Repository
        • Type
          • Login
    • AuthProcessors
      • Processor
    • BundleFramework
      • Configuration
        • FilesystemLocator
        • ORM
    • Bundles
      • Bundle
        • Provides
      • FilesystemLocators
      • Processors
    • Config
      • Formats
        • Format
      • Storages
        • Storage
          • Editable
        • Type
    • Database
      • Conditions
        • Builder
          • Container
          • Operators
        • Condition
          • Collection
          • Field
        • Logic
      • Connection
      • Driver
        • Mongo
          • Conditions
            • Builder
          • Parser
            • Conditions
          • Query
            • Type
        • PDO
          • Adapter
            • Mysql
              • Parser
            • Pgsql
              • Parser
            • Sqlite
              • Parser
          • Conditions
            • Builder
          • Query
            • Type
      • Exception
      • Parser
      • Query
        • Implementation
        • Type
          • Update
      • Type
        • Document
          • Conditions
            • Builder
            • Condition
              • Collection
                • Embedded
                  • Group
                  • Placeholder
          • Query
            • Implementation
        • SQL
          • Conditions
            • Builder
          • Parser
          • Query
            • Implementation
            • Type
      • Values
    • Debug
      • Logger
      • Tracer
        • Trace
    • DefaultBundle
      • Processor
        • HTTP
    • Filesystem
      • Locators
        • Locator
    • Framework
      • Extensions
        • Template
          • Extension
      • Processors
        • HTTP
          • Response
    • HTTP
      • Context
        • Container
        • Cookies
        • Session
      • Data
        • Headers
      • Messages
        • Message
          • Request
            • ServerRequest
        • Stream
        • UploadedFile
        • URI
      • Responses
    • HTTPProcessors
      • Parsers
        • Parser
      • Processor
        • Actions
        • Dispatcher
          • Builder
          • Registry
    • ORM
      • Conditions
        • Builder
        • Condition
          • Collection
            • RelatedTo
          • Field
          • In
      • Configs
      • Data
        • Diff
        • Type
        • Types
          • Document
            • Node
              • ArrayNode
      • Drivers
        • Driver
          • Mongo
          • PDO
          • SQL
      • Exception
      • Loaders
        • Loader
          • Embedded
          • Proxy
          • Repository
      • Mappers
        • Cascade
          • Mapper
        • Conditions
        • Preload
      • Maps
        • Map
          • Cascade
          • Property
      • Models
        • Model
          • Implementation
        • Type
          • Database
            • Implementation
          • Embedded
            • Implementation
      • Planners
        • Planner
          • In
            • Strategy
          • Pivot
            • Strategy
          • Query
            • Strategy
      • Plans
        • Plan
          • Query
      • Relationships
        • Relationship
          • Handler
            • Cascading
            • Mapping
          • Implementation
            • Preloader
              • Result
                • Multiple
            • Property
            • Side
          • Property
            • Entity
          • Side
            • Cascade
            • Property
          • Type
        • Type
          • Embeds
            • Preload
            • Property
            • Side
            • Type
              • Many
                • Preload
                • Property
                  • Entity
                • Side
              • One
                • Preload
                • Property
                  • Entity
                • Side
          • ManyToMany
            • Property
            • Side
          • OneTo
            • Preloader
            • Property
              • Entity
              • Query
            • Side
            • Type
              • Many
                • Preloader
                  • Property
                • Property
                  • Entity
                  • Query
                • Side
                • Value
                  • Preload
              • One
                • Preloader
                • Property
                • Side
      • Steps
        • Result
        • Step
          • Pivot
          • Query
            • Insert
              • Batch
                • Data
            • Result
          • Update
      • Values
        • Preload
          • Property
        • Update
      • Wrappers
        • Model
        • Type
          • Database
          • Embedded
    • Paginate
      • Loader
    • PaginateORM
      • Loader
    • Processors
      • Processor
        • Dispatcher
    • Route
      • Exception
      • Matcher
      • Resolvers
        • Resolver
          • Pattern
      • Translator
    • Security
      • Tokens
        • Storage
          • Database
    • Slice
      • Data
        • Slice
      • Type
        • ArrayData
        • Slice
    • Template
      • Extensions
        • Extension
      • Formats
      • Renderer
    • Test
  • Project
    • App
      • HTTPProcessors
    • Framework
  • Psr
    • Http
      • Message

Classes

  • Message
  • UploadedFile
  • URI
  • Overview
  • Namespace
  • Class
  • Tree
  • Return

Class Message

Base PSR-7 Message implementation

PHPixie\HTTP\Messages\Message implements Psr\Http\Message\MessageInterface

Direct known subclasses

PHPixie\HTTP\Messages\Message\Implementation, PHPixie\HTTP\Messages\Message\Request

Indirect known subclasses

PHPixie\HTTP\Messages\Message\Request\Implementation, PHPixie\HTTP\Messages\Message\Request\ServerRequest, PHPixie\HTTP\Messages\Message\Request\ServerRequest\Implementation, PHPixie\HTTP\Messages\Message\Request\ServerRequest\SAPI, PHPixie\HTTP\Messages\Message\Response
Abstract
Namespace: PHPixie\HTTP\Messages
Located at vendor/phpixie/http/src/PHPixie/HTTP/Messages/Message.php
Methods summary
public string
# getProtocolVersion( )

Returns

string
HTTP protocol version.

Inheritdoc

Implementation of

Psr\Http\Message\MessageInterface::getProtocolVersion()
public PHPixie\HTTP\Messages\Message
# withProtocolVersion( string $version )

Parameters

$version
HTTP protocol version

Returns

PHPixie\HTTP\Messages\Message

Inheritdoc

Implementation of

Psr\Http\Message\MessageInterface::withProtocolVersion()
public array
# getHeaders( )

Returns

array

Returns an associative array of the message's headers. Each key MUST be a header name, and each value MUST be an array of strings for that header.

Inheritdoc

Implementation of

Psr\Http\Message\MessageInterface::getHeaders()
public boolean
# hasHeader( string $header )

Parameters

$header
$name Case-insensitive header field name.

Returns

boolean

Returns true if any header names match the given header name using a case-insensitive string comparison. Returns false if no matching header name is found in the message.

Inheritdoc

Implementation of

Psr\Http\Message\MessageInterface::hasHeader()
public string
# getHeaderLine( string $header )

Parameters

$header
$name Case-insensitive header field name.

Returns

string

A string of values as provided for the given header concatenated together using a comma. If the header does not appear in the message, this method MUST return an empty string.

Inheritdoc

Implementation of

Psr\Http\Message\MessageInterface::getHeaderLine()
public string[]
# getHeader( string $header )

Parameters

$header
$name Case-insensitive header field name.

Returns

string[]

An array of string values as provided for the given header. If the header does not appear in the message, this method MUST return an empty array.

Inheritdoc

Implementation of

Psr\Http\Message\MessageInterface::getHeader()
public PHPixie\HTTP\Messages\Message
# withHeader( string $header, string|string[] $value )

Parameters

$header
$name Case-insensitive header field name.
$value
Header value(s).

Returns

PHPixie\HTTP\Messages\Message

Throws

InvalidArgumentException
for invalid header names or values.

Inheritdoc

Implementation of

Psr\Http\Message\MessageInterface::withHeader()
public PHPixie\HTTP\Messages\Message
# withAddedHeader( string $header, string|string[] $value )

Parameters

$header
$name Case-insensitive header field name to add.
$value
Header value(s).

Returns

PHPixie\HTTP\Messages\Message

Throws

InvalidArgumentException
for invalid header names or values.

Inheritdoc

Implementation of

Psr\Http\Message\MessageInterface::withAddedHeader()
protected PHPixie\HTTP\Messages\Message
# modifyHeader( string $header, string|array $value, boolean $append = false, boolean $clone = true )

Parameters

$header
$value
$append
$clone

Returns

PHPixie\HTTP\Messages\Message
public PHPixie\HTTP\Messages\Message
# withoutHeader( string $header )

Parameters

$header
$name Case-insensitive header field name to remove.

Returns

PHPixie\HTTP\Messages\Message

Inheritdoc

Implementation of

Psr\Http\Message\MessageInterface::withoutHeader()
public Psr\Http\Message\StreamInterface
# getBody( )

Returns

Psr\Http\Message\StreamInterface
Returns the body as a stream.

Inheritdoc

Implementation of

Psr\Http\Message\MessageInterface::getBody()
public PHPixie\HTTP\Messages\Message
# withBody( Psr\Http\Message\StreamInterface $body )

Parameters

$body
Body.

Returns

PHPixie\HTTP\Messages\Message

Throws

InvalidArgumentException
When the body is not valid.

Inheritdoc

Implementation of

Psr\Http\Message\MessageInterface::withBody()
protected
# populateHeaderNames( )
protected
# validateHeaders( array $headers )

Parameters

$headers
protected
# requireHeaders( )
protected
# requireProtocolVersion( )
protected
# requireBody( )
Properties summary
protected string $protocolVersion
#
protected array $headers
#
protected Psr\Http\Message\StreamInterface $body
#
protected boolean $processedHeaders
# false
protected array $headerNames
# array()
PHPixie 3 API API documentation generated by ApiGen