PHP Class eZ\Publish\Core\IO\IOService

Inheritance: implements eZ\Publish\Core\IO\IOServiceInterface
Datei anzeigen Open project: ezsystems/ezpublish-kernel Class Usage Examples

Protected Properties

Property Type Description
$binarydataHandler eZ\Publish\Core\IO\IOBinarydataHandler
$metadataHandler eZ\Publish\Core\IO\IOMetadataHandler
$mimeTypeDetector eZ\Publish\SPI\IO\MimeTypeDetector

Public Methods

Method Description
__construct ( eZ\Publish\Core\IO\IOMetadataHandler $metadataHandler, eZ\Publish\Core\IO\IOBinarydataHandler $binarydataHandler, eZ\Publish\SPI\IO\MimeTypeDetector $mimeTypeDetector, array $settings = [] )
createBinaryFile ( BinaryFileCreateStruct $binaryFileCreateStruct )
deleteBinaryFile ( BinaryFile $binaryFile )
deleteDirectory ( string $path ) Deletes a directory.
exists ( $binaryFileId )
getExternalPath ( $internalId )
getFileContents ( BinaryFile $binaryFile )
getFileInputStream ( BinaryFile $binaryFile )
getInternalPath ( $binaryFileId )
getMimeType ( $binaryFileId )
getUri ( $binaryFileId )
loadBinaryFile ( $binaryFileId )
loadBinaryFileByUri ( $binaryFileUri )
newBinaryCreateStructFromLocalFile ( $localFile )
newBinaryCreateStructFromUploadedFile ( array $uploadedFile )
setPrefix ( $prefix )

Protected Methods

Method Description
buildDomainBinaryFileObject ( eZ\Publish\SPI\IO\BinaryFile $spiBinaryFile ) : BinaryFile Generates API BinaryFile object from provided SPI BinaryFile object.
buildSPIBinaryFileCreateStructObject ( BinaryFileCreateStruct $binaryFileCreateStruct ) : eZ\Publish\SPI\IO\BinaryFileCreateStruct Generates SPI BinaryFileCreateStruct object from provided API BinaryFileCreateStruct object.
checkBinaryFileId ( string $binaryFileId )
getPrefixedUri ( string $binaryFileId ) : string Returns $uri prefixed with what is configured in the service.
isAbsolutePath ( string $path ) : boolean Check if path is absolute, in terms of http or disk (incl if it contains driver letter on Win).
removeUriPrefix ( mixed $spiBinaryFileId ) : string

Method Details

__construct() public method

public __construct ( eZ\Publish\Core\IO\IOMetadataHandler $metadataHandler, eZ\Publish\Core\IO\IOBinarydataHandler $binarydataHandler, eZ\Publish\SPI\IO\MimeTypeDetector $mimeTypeDetector, array $settings = [] )
$metadataHandler eZ\Publish\Core\IO\IOMetadataHandler
$binarydataHandler eZ\Publish\Core\IO\IOBinarydataHandler
$mimeTypeDetector eZ\Publish\SPI\IO\MimeTypeDetector
$settings array

buildDomainBinaryFileObject() protected method

Generates API BinaryFile object from provided SPI BinaryFile object.
protected buildDomainBinaryFileObject ( eZ\Publish\SPI\IO\BinaryFile $spiBinaryFile ) : BinaryFile
$spiBinaryFile eZ\Publish\SPI\IO\BinaryFile
return eZ\Publish\Core\IO\Values\BinaryFile

buildSPIBinaryFileCreateStructObject() protected method

Generates SPI BinaryFileCreateStruct object from provided API BinaryFileCreateStruct object.
protected buildSPIBinaryFileCreateStructObject ( BinaryFileCreateStruct $binaryFileCreateStruct ) : eZ\Publish\SPI\IO\BinaryFileCreateStruct
$binaryFileCreateStruct eZ\Publish\Core\IO\Values\BinaryFileCreateStruct
return eZ\Publish\SPI\IO\BinaryFileCreateStruct

checkBinaryFileId() protected method

protected checkBinaryFileId ( string $binaryFileId )
$binaryFileId string

createBinaryFile() public method

public createBinaryFile ( BinaryFileCreateStruct $binaryFileCreateStruct )
$binaryFileCreateStruct eZ\Publish\Core\IO\Values\BinaryFileCreateStruct

deleteBinaryFile() public method

public deleteBinaryFile ( BinaryFile $binaryFile )
$binaryFile eZ\Publish\Core\IO\Values\BinaryFile

deleteDirectory() public method

Deletes a directory.
public deleteDirectory ( string $path )
$path string

exists() public method

public exists ( $binaryFileId )

getExternalPath() public method

public getExternalPath ( $internalId )

getFileContents() public method

public getFileContents ( BinaryFile $binaryFile )
$binaryFile eZ\Publish\Core\IO\Values\BinaryFile

getFileInputStream() public method

public getFileInputStream ( BinaryFile $binaryFile )
$binaryFile eZ\Publish\Core\IO\Values\BinaryFile

getInternalPath() public method

public getInternalPath ( $binaryFileId )

getMimeType() public method

public getMimeType ( $binaryFileId )

getPrefixedUri() protected method

Returns $uri prefixed with what is configured in the service.
protected getPrefixedUri ( string $binaryFileId ) : string
$binaryFileId string
return string

getUri() public method

public getUri ( $binaryFileId )

isAbsolutePath() protected method

Check if path is absolute, in terms of http or disk (incl if it contains driver letter on Win).
protected isAbsolutePath ( string $path ) : boolean
$path string
return boolean

loadBinaryFile() public method

public loadBinaryFile ( $binaryFileId )

loadBinaryFileByUri() public method

public loadBinaryFileByUri ( $binaryFileUri )

newBinaryCreateStructFromLocalFile() public method

public newBinaryCreateStructFromLocalFile ( $localFile )

newBinaryCreateStructFromUploadedFile() public method

public newBinaryCreateStructFromUploadedFile ( array $uploadedFile )
$uploadedFile array

removeUriPrefix() protected method

protected removeUriPrefix ( mixed $spiBinaryFileId ) : string
$spiBinaryFileId mixed
return string

setPrefix() public method

public setPrefix ( $prefix )

Property Details

$binarydataHandler protected_oe property

protected IOBinarydataHandler,eZ\Publish\Core\IO $binarydataHandler
return eZ\Publish\Core\IO\IOBinarydataHandler

$metadataHandler protected_oe property

protected IOMetadataHandler,eZ\Publish\Core\IO $metadataHandler
return eZ\Publish\Core\IO\IOMetadataHandler

$mimeTypeDetector protected_oe property

protected MimeTypeDetector,eZ\Publish\SPI\IO $mimeTypeDetector
return eZ\Publish\SPI\IO\MimeTypeDetector