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

  • Implementation
  • ServerRequest
  • Overview
  • Namespace
  • Class
  • Tree
  • Return

Class ServerRequest

Base PSR-7 ServerRequest

PHPixie\HTTP\Messages\Message implements Psr\Http\Message\MessageInterface
Extended by PHPixie\HTTP\Messages\Message\Request implements Psr\Http\Message\RequestInterface
Extended by PHPixie\HTTP\Messages\Message\Request\ServerRequest implements Psr\Http\Message\ServerRequestInterface

Direct known subclasses

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

Returns

array

Inheritdoc

Implementation of

Psr\Http\Message\ServerRequestInterface::getServerParams()
public array
# getUploadedFiles( )

Returns

array

An array tree of UploadedFileInterface instances; an empty array MUST be returned if no data is present.

Inheritdoc

Implementation of

Psr\Http\Message\ServerRequestInterface::getUploadedFiles()
public array
# getCookieParams( )

Returns

array

Inheritdoc

Implementation of

Psr\Http\Message\ServerRequestInterface::getCookieParams()
public PHPixie\HTTP\Messages\Message\Request\ServerRequest
# withCookieParams( array $cookies )

Parameters

$cookies
Array of key/value pairs representing cookies.

Returns

PHPixie\HTTP\Messages\Message\Request\ServerRequest

Inheritdoc

Implementation of

Psr\Http\Message\ServerRequestInterface::withCookieParams()
public array
# getQueryParams( )

Returns

array

Inheritdoc

Implementation of

Psr\Http\Message\ServerRequestInterface::getQueryParams()
public PHPixie\HTTP\Messages\Message\Request\ServerRequest
# withQueryParams( array $query )

Parameters

$query

Array of query string arguments, typically from $_GET.

Returns

PHPixie\HTTP\Messages\Message\Request\ServerRequest

Inheritdoc

Implementation of

Psr\Http\Message\ServerRequestInterface::withQueryParams()
public null|array|object
# getParsedBody( )

Returns

null|array|object

The deserialized body parameters, if any. These will typically be an array or object.

Inheritdoc

Implementation of

Psr\Http\Message\ServerRequestInterface::getParsedBody()
public PHPixie\HTTP\Messages\Message\Request\ServerRequest
# withParsedBody( null|array|object $data )

Parameters

$data

The deserialized body data. This will typically be in an array or object.

Returns

PHPixie\HTTP\Messages\Message\Request\ServerRequest

Throws

InvalidArgumentException

if an unsupported argument type is provided.

Inheritdoc

Implementation of

Psr\Http\Message\ServerRequestInterface::withParsedBody()
public PHPixie\HTTP\Messages\Message\Request\ServerRequest
# withUploadedFiles( array $uploadedFiles )

Parameters

$uploadedFiles
array tree of UploadedFileInterface instances.

Returns

PHPixie\HTTP\Messages\Message\Request\ServerRequest

Throws

InvalidArgumentException
if an invalid structure is provided.

Inheritdoc

Implementation of

Psr\Http\Message\ServerRequestInterface::withUploadedFiles()
public array
# getAttributes( )

Returns

array
Attributes derived from the request.

Inheritdoc

Implementation of

Psr\Http\Message\ServerRequestInterface::getAttributes()
public mixed
# getAttribute( string $attribute, mixed $default = null )

Parameters

$attribute
$name The attribute name.
$default
Default value to return if the attribute does not exist.

Returns

mixed

Inheritdoc

Implementation of

Psr\Http\Message\ServerRequestInterface::getAttribute()
public PHPixie\HTTP\Messages\Message\Request\ServerRequest
# withAttribute( string $attribute, mixed $value )

Parameters

$attribute
$name The attribute name.
$value
The value of the attribute.

Returns

PHPixie\HTTP\Messages\Message\Request\ServerRequest

Inheritdoc

Implementation of

Psr\Http\Message\ServerRequestInterface::withAttribute()
public PHPixie\HTTP\Messages\Message\Request\ServerRequest
# withoutAttribute( string $attribute )

Parameters

$attribute
$name The attribute name.

Returns

PHPixie\HTTP\Messages\Message\Request\ServerRequest

Inheritdoc

Implementation of

Psr\Http\Message\ServerRequestInterface::withoutAttribute()
protected
# requireServerParams( )
protected
# requireUploadedFiles( )
Methods inherited from PHPixie\HTTP\Messages\Message\Request
getMethod(), getRequestTarget(), getUri(), requireMethod(), requireUri(), validateMethod(), withMethod(), withRequestTarget(), withUri()
Methods inherited from PHPixie\HTTP\Messages\Message
getBody(), getHeader(), getHeaderLine(), getHeaders(), getProtocolVersion(), hasHeader(), modifyHeader(), populateHeaderNames(), requireBody(), requireHeaders(), requireProtocolVersion(), validateHeaders(), withAddedHeader(), withBody(), withHeader(), withProtocolVersion(), withoutHeader()
Properties summary
protected array $serverParams
#
protected array $queryParams
#
protected mixed $parsedBody
#
protected array $cookieParams
#
protected array $uploadedFiles
#
protected array $attributes
# array()
Properties inherited from PHPixie\HTTP\Messages\Message\Request
$method, $requestTarget, $uri, $validMethods
Properties inherited from PHPixie\HTTP\Messages\Message
$body, $headerNames, $headers, $processedHeaders, $protocolVersion
PHPixie 3 API API documentation generated by ApiGen