PHP Class eZ\Publish\Core\REST\Client\IOService

Inheritance: implements eZ\Publish\API\Repository\IOService, implements eZ\Publish\Core\REST\Client\Sessionable
Show file Open project: ezsystems/ezpublish-kernel

Public Methods

Method Description
__construct ( eZ\Publish\Core\REST\Client\HttpClient $client, Dispatcher $inputDispatcher, Visitor $outputVisitor, eZ\Publish\Core\REST\Common\RequestParser $requestParser )
createBinaryFile ( BinaryFileCreateStruct $binaryFileCreateStruct ) : BinaryFile Creates a binary file in the the repository.
deleteBinaryFile ( BinaryFile $binaryFile ) Deletes the BinaryFile with $path.
getFileContents ( BinaryFile $binaryFile ) : string Returns the content of the binary file.
getFileInputStream ( BinaryFile $binaryFile ) : resource Returns a read (mode: rb) file resource to the binary file identified by $path.
loadBinaryFile ( $binaryFileId ) : BinaryFile Loads the binary file with $id.
newBinaryCreateStructFromLocalFile ( string $localFile ) : BinaryFileCreateStruct Creates a BinaryFileCreateStruct object from $localFile.
newBinaryCreateStructFromUploadedFile ( array $uploadedFile ) : BinaryFileCreateStruct Creates a BinaryFileCreateStruct object from the uploaded file $uploadedFile.
setSession ( $id ) Set session ID.

Method Details

__construct() public method

public __construct ( eZ\Publish\Core\REST\Client\HttpClient $client, Dispatcher $inputDispatcher, Visitor $outputVisitor, eZ\Publish\Core\REST\Common\RequestParser $requestParser )
$client eZ\Publish\Core\REST\Client\HttpClient
$inputDispatcher eZ\Publish\Core\REST\Common\Input\Dispatcher
$outputVisitor eZ\Publish\Core\REST\Common\Output\Visitor
$requestParser eZ\Publish\Core\REST\Common\RequestParser

createBinaryFile() public method

Creates a binary file in the the repository.
public createBinaryFile ( BinaryFileCreateStruct $binaryFileCreateStruct ) : BinaryFile
$binaryFileCreateStruct eZ\Publish\Core\IO\Values\BinaryFileCreateStruct
return eZ\Publish\Core\IO\Values\BinaryFile The created BinaryFile object

deleteBinaryFile() public method

Deletes the BinaryFile with $path.
public deleteBinaryFile ( BinaryFile $binaryFile )
$binaryFile eZ\Publish\Core\IO\Values\BinaryFile

getFileContents() public method

Returns the content of the binary file.
public getFileContents ( BinaryFile $binaryFile ) : string
$binaryFile eZ\Publish\Core\IO\Values\BinaryFile
return string

getFileInputStream() public method

Returns a read (mode: rb) file resource to the binary file identified by $path.
public getFileInputStream ( BinaryFile $binaryFile ) : resource
$binaryFile eZ\Publish\Core\IO\Values\BinaryFile
return resource

loadBinaryFile() public method

Loads the binary file with $id.
public loadBinaryFile ( $binaryFileId ) : BinaryFile
return eZ\Publish\Core\IO\Values\BinaryFile

newBinaryCreateStructFromLocalFile() public method

Creates a BinaryFileCreateStruct object from $localFile.
public newBinaryCreateStructFromLocalFile ( string $localFile ) : BinaryFileCreateStruct
$localFile string Path to local file
return eZ\Publish\Core\IO\Values\BinaryFileCreateStruct

newBinaryCreateStructFromUploadedFile() public method

Creates a BinaryFileCreateStruct object from the uploaded file $uploadedFile.
public newBinaryCreateStructFromUploadedFile ( array $uploadedFile ) : BinaryFileCreateStruct
$uploadedFile array The $_POST hash of an uploaded file
return eZ\Publish\Core\IO\Values\BinaryFileCreateStruct

setSession() public method

Only for testing
public setSession ( $id )