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 URI

Base PSR-7 URI implementation

PHPixie\HTTP\Messages\URI implements Psr\Http\Message\UriInterface

Direct known subclasses

PHPixie\HTTP\Messages\URI\Implementation, PHPixie\HTTP\Messages\URI\SAPI
Abstract
Namespace: PHPixie\HTTP\Messages
Located at vendor/phpixie/http/src/PHPixie/HTTP/Messages/URI.php
Methods summary
public string
# __toString( )

Returns

string

Inheritdoc

Implementation of

Psr\Http\Message\UriInterface::__toString()
public string
# getAuthority( )

Returns

string
The URI authority, in "[user-info@]host[:port]" format.

Inheritdoc

Implementation of

Psr\Http\Message\UriInterface::getAuthority()
public string
# getScheme( )

Returns

string
The URI scheme.

Inheritdoc

Implementation of

Psr\Http\Message\UriInterface::getScheme()
public string
# getUserInfo( )

Returns

string
The URI user information, in "username[:password]" format.

Inheritdoc

Implementation of

Psr\Http\Message\UriInterface::getUserInfo()
public string
# getHost( )

Returns

string
The URI host.

Inheritdoc

Implementation of

Psr\Http\Message\UriInterface::getHost()
public null|integer
# getPort( )

Returns

null|integer
The URI port.

Inheritdoc

Implementation of

Psr\Http\Message\UriInterface::getPort()
public string
# getPath( )

Returns

string
The URI path.

Inheritdoc

Implementation of

Psr\Http\Message\UriInterface::getPath()
public string
# getQuery( )

Returns

string
The URI query string.

Inheritdoc

Implementation of

Psr\Http\Message\UriInterface::getQuery()
public string
# getFragment( )

Returns

string
The URI fragment.

Inheritdoc

Implementation of

Psr\Http\Message\UriInterface::getFragment()
public PHPixie\HTTP\Messages\URI
# withScheme( string $scheme )

Parameters

$scheme
The scheme to use with the new instance.

Returns

PHPixie\HTTP\Messages\URI
A new instance with the specified scheme.

Throws

InvalidArgumentException
for invalid or unsupported schemes.

Inheritdoc

Implementation of

Psr\Http\Message\UriInterface::withScheme()
public PHPixie\HTTP\Messages\URI
# withUserInfo( string $user, null|string $password = null )

Parameters

$user
The user name to use for authority.
$password
The password associated with $user.

Returns

PHPixie\HTTP\Messages\URI
A new instance with the specified user information.

Inheritdoc

Implementation of

Psr\Http\Message\UriInterface::withUserInfo()
protected PHPixie\HTTP\Messages\URI
# updatePart( string $key, string $value )

Parameters

$key
$value

Returns

PHPixie\HTTP\Messages\URI
public PHPixie\HTTP\Messages\URI
# withHost( string $host )

Parameters

$host
The hostname to use with the new instance.

Returns

PHPixie\HTTP\Messages\URI
A new instance with the specified host.

Throws

InvalidArgumentException
for invalid hostnames.

Inheritdoc

Implementation of

Psr\Http\Message\UriInterface::withHost()
public PHPixie\HTTP\Messages\URI
# withPort( null|integer $port )

Parameters

$port

The port to use with the new instance; a null value removes the port information.

Returns

PHPixie\HTTP\Messages\URI
A new instance with the specified port.

Throws

InvalidArgumentException
for invalid ports.

Inheritdoc

Implementation of

Psr\Http\Message\UriInterface::withPort()
public PHPixie\HTTP\Messages\URI
# withPath( string $path )

Parameters

$path
The path to use with the new instance.

Returns

PHPixie\HTTP\Messages\URI
A new instance with the specified path.

Throws

InvalidArgumentException
for invalid paths.

Inheritdoc

Implementation of

Psr\Http\Message\UriInterface::withPath()
public PHPixie\HTTP\Messages\URI
# withQuery( string $query )

Parameters

$query
The query string to use with the new instance.

Returns

PHPixie\HTTP\Messages\URI
A new instance with the specified query string.

Throws

InvalidArgumentException
for invalid query strings.

Inheritdoc

Implementation of

Psr\Http\Message\UriInterface::withQuery()
public PHPixie\HTTP\Messages\URI
# withFragment( string $fragment )

Parameters

$fragment
The fragment to use with the new instance.

Returns

PHPixie\HTTP\Messages\URI
A new instance with the specified fragment.

Inheritdoc

Implementation of

Psr\Http\Message\UriInterface::withFragment()
protected string
# normalizeFragment( string $fragment )

Parameters

$fragment

Returns

string
protected string
# normalizePart( string $part, string|null $prefix = null )

Parameters

$part
$prefix

Returns

string
protected static boolean
# isStandardPort( string $scheme, integer $port )

Parameters

$scheme
$port

Returns

boolean
protected string
# normalizePath( string $path )

Parameters

$path

Returns

string
protected string
# normalizeQuery( string $query )

Parameters

$query

Returns

string

Throws

InvalidArgumentException
protected string
# normalizeQueryString( string $value )

Parameters

$value

Returns

string
protected string
# encodeMatchedQueryPart( array $matches )

Parameters

$matches

Returns

string
protected string
# part( string $name )

Parameters

$name

Returns

string
protected
# requirePart( string $name )

Parameters

$name
Constants summary
string CHAR_SUB_DELIMS
# '!\$&\'\(\)\*\+,;='
string CHAR_UNRESERVED
# 'a-zA-Z0-9_\-\.~'
Properties summary
protected string|null $uriString

generated uri string cache

generated uri string cache

#
protected array $parts
# array()
PHPixie 3 API API documentation generated by ApiGen