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 UploadedFile

Base PSR-7 UploadedFile implementation

PHPixie\HTTP\Messages\UploadedFile implements Psr\Http\Message\UploadedFileInterface

Direct known subclasses

PHPixie\HTTP\Messages\UploadedFile\Implementation, PHPixie\HTTP\Messages\UploadedFile\SAPI
Abstract
Namespace: PHPixie\HTTP\Messages
Located at vendor/phpixie/http/src/PHPixie/HTTP/Messages/UploadedFile.php
Methods summary
public
# __construct( PHPixie\HTTP\Messages $messages )

Constructor

Constructor

Parameters

$messages
public Psr\Http\Message\StreamInterface
# getStream( )

Returns

Psr\Http\Message\StreamInterface
Stream representation of the uploaded file.

Throws

RuntimeException

in cases when no stream is available or can be created.

Inheritdoc

Implementation of

Psr\Http\Message\UploadedFileInterface::getStream()
public string|null
# getClientFilename( )

Returns

string|null

The filename sent by the client or null if none was provided.

Inheritdoc

Implementation of

Psr\Http\Message\UploadedFileInterface::getClientFilename()
public string|null
# getClientMediaType( )

Returns

string|null

The media type sent by the client or null if none was provided.

Inheritdoc

Implementation of

Psr\Http\Message\UploadedFileInterface::getClientMediaType()
public integer
# getError( )

Returns

integer
One of PHP's UPLOAD_ERR_XXX constants.

Inheritdoc

Implementation of

Psr\Http\Message\UploadedFileInterface::getError()
public integer|null
# getSize( )

Returns

integer|null
The file size in bytes or null if unknown.

Inheritdoc

Implementation of

Psr\Http\Message\UploadedFileInterface::getSize()
protected
# assertValidUpload( )
abstract public
# moveTo( string $path )

Parameters

$path
$targetPath Path to which to move the uploaded file.

Throws

InvalidArgumentException
if the $path specified is invalid.
RuntimeException

on any error during the move operation, or on the second or subsequent call to the method.

Inheritdoc

Implementation of

Psr\Http\Message\UploadedFileInterface::moveTo()
Properties summary
protected PHPixie\HTTP\Messages $messages
#
protected string $clientFilename
#
protected string $clientMediaType
#
protected string $file
#
protected integer $error
#
protected integer|null $size
#
protected Psr\Http\Message\StreamInterface $stream
#
PHPixie 3 API API documentation generated by ApiGen