PHP Class Imbo\Http\Request\Request

Author: Christer Edvartsen ([email protected])
Inheritance: extends Symfony\Component\HttpFoundation\Request
Show file Open project: imbo/imbo Class Usage Examples

Public Methods

Method Description
getExtension ( ) : string | null Get the current requested extension (if any)
getImage ( ) : null | Image Get an image model attached to the request (on POST)
getImageIdentifier ( ) : string | null Get the image identifier from the URL
getPublicKey ( ) : string Get the public key found in the request
getRawUri ( ) : string Get the URI without the Symfony normalization applied to the query string, un-encoded
getRoute ( ) : Imbo\Router\Route Get the current route
getTransformations ( ) : array Get image transformations from the request
getUriAsIs ( ) : string Get the URI with no changes to the incoming formatting ("as is")
getUser ( ) : string Get the user found in the request
getUsers ( ) : array Get users specified in the request
setImage ( Image $image ) : Request Set an image model
setRoute ( Imbo\Router\Route $route ) : self Set the route
setTransformations ( array $transformations ) : self Set the transformation chain

Method Details

getExtension() public method

Get the current requested extension (if any)
public getExtension ( ) : string | null
return string | null

getImage() public method

Get an image model attached to the request (on POST)
public getImage ( ) : null | Image
return null | Imbo\Model\Image

getImageIdentifier() public method

Get the image identifier from the URL
public getImageIdentifier ( ) : string | null
return string | null

getPublicKey() public method

Get the public key found in the request
public getPublicKey ( ) : string
return string

getRawUri() public method

Get the URI without the Symfony normalization applied to the query string, un-encoded
public getRawUri ( ) : string
return string

getRoute() public method

Get the current route
public getRoute ( ) : Imbo\Router\Route
return Imbo\Router\Route

getTransformations() public method

Get image transformations from the request
public getTransformations ( ) : array
return array

getUriAsIs() public method

Get the URI with no changes to the incoming formatting ("as is")
public getUriAsIs ( ) : string
return string

getUser() public method

Get the user found in the request
public getUser ( ) : string
return string

getUsers() public method

Get users specified in the request
public getUsers ( ) : array
return array Users specified in the request

setImage() public method

Set an image model
public setImage ( Image $image ) : Request
$image Imbo\Model\Image An image model instance
return Request

setRoute() public method

Set the route
public setRoute ( Imbo\Router\Route $route ) : self
$route Imbo\Router\Route The current route
return self

setTransformations() public method

Set the transformation chain
public setTransformations ( array $transformations ) : self
$transformations array The image transformations
return self