eZPublishCommunityProject  2012.12
eZ\Publish\API\Repository\IOService Interface Reference
+ Inheritance diagram for eZ\Publish\API\Repository\IOService:

Public Member Functions

 createBinaryFile (BinaryFileCreateStruct $binaryFileCreateStruct)
 Creates a binary file in the the repository. More...
 
 deleteBinaryFile (BinaryFile $binaryFile)
 Deletes the BinaryFile with $path. More...
 
 getFileContents (BinaryFile $binaryFile)
 Returns the content of the binary file. More...
 
 getFileInputStream (BinaryFile $binaryFile)
 Returns a read (mode: rb) file resource to the binary file identified by $path. More...
 
 loadBinaryFile ($binaryFileid)
 Loads the binary file with $id. More...
 
 newBinaryCreateStructFromLocalFile ($localFile)
 Creates a BinaryFileCreateStruct object from $localFile. More...
 
 newBinaryCreateStructFromUploadedFile (array $uploadedFile)
 Creates a BinaryFileCreateStruct object from the uploaded file $uploadedFile. More...
 

Member Function Documentation

eZ\Publish\API\Repository\IOService::createBinaryFile ( BinaryFileCreateStruct  $binaryFileCreateStruct)

Creates a binary file in the the repository.

Parameters
\eZ\Publish\API\Repository\Values\IO\BinaryFileCreateStruct$binaryFileCreateStruct
Returns
The created BinaryFile object

Implemented in eZ\Publish\Core\Repository\IOService, and eZ\Publish\Core\REST\Client\IOService.

eZ\Publish\API\Repository\IOService::deleteBinaryFile ( BinaryFile  $binaryFile)

Deletes the BinaryFile with $path.

Parameters
\eZ\Publish\API\Repository\Values\IO\BinaryFile$binaryFile

Implemented in eZ\Publish\Core\Repository\IOService, and eZ\Publish\Core\REST\Client\IOService.

eZ\Publish\API\Repository\IOService::getFileContents ( BinaryFile  $binaryFile)

Returns the content of the binary file.

Parameters
\eZ\Publish\API\Repository\Values\IO\BinaryFile$binaryFile
Returns
string

Implemented in eZ\Publish\Core\Repository\IOService, and eZ\Publish\Core\REST\Client\IOService.

eZ\Publish\API\Repository\IOService::getFileInputStream ( BinaryFile  $binaryFile)

Returns a read (mode: rb) file resource to the binary file identified by $path.

Parameters
\eZ\Publish\API\Repository\Values\IO\BinaryFile$binaryFile
Returns
resource

Implemented in eZ\Publish\Core\Repository\IOService, and eZ\Publish\Core\REST\Client\IOService.

eZ\Publish\API\Repository\IOService::loadBinaryFile (   $binaryFileid)

Loads the binary file with $id.

Exceptions
\eZ\Publish\API\Repository\Exceptions\NotFoundException
Parameters
string$binaryFileid
Returns

Implemented in eZ\Publish\Core\Repository\IOService, and eZ\Publish\Core\REST\Client\IOService.

eZ\Publish\API\Repository\IOService::newBinaryCreateStructFromLocalFile (   $localFile)

Creates a BinaryFileCreateStruct object from $localFile.

Exceptions
\eZ\Publish\API\Repository\Exceptions\InvalidArgumentExceptionWhen given a non existing / unreadable file
Parameters
string$localFilePath to local file
Returns

Implemented in eZ\Publish\Core\Repository\IOService, and eZ\Publish\Core\REST\Client\IOService.

eZ\Publish\API\Repository\IOService::newBinaryCreateStructFromUploadedFile ( array  $uploadedFile)

Creates a BinaryFileCreateStruct object from the uploaded file $uploadedFile.

Exceptions
\eZ\Publish\API\Repository\Exceptions\InvalidArgumentExceptionWhen given an invalid uploaded file
Parameters
array$uploadedFileThe $_POST hash of an uploaded file
Returns

Implemented in eZ\Publish\Core\Repository\IOService, and eZ\Publish\Core\REST\Client\IOService.


The documentation for this interface was generated from the following file: