PHP Class Xpressengine\Storage\File

See link: http://www.xpressengine.com
Author: XE Team (developers) ([email protected])
Inheritance: implements JsonSerializabl\JsonSerializable, use trait Xpressengine\Support\EntityTrait
Afficher le fichier Open project: xpressengine/xpressengine Class Usage Examples

Méthodes publiques

Свойство Type Description
$incrementing boolean Indicates if the IDs are auto-incrementing.

Protected Properties

Свойство Type Description
$fileableTable string The table associated with the model for morph.
$reader Xpressengine\Storage\ContentReaderInterface The ContentReader instance
$table string The table associated with the model.
$urls Xpressengine\Storage\UrlMaker Storage UrlMaker instance

Méthodes publiques

Méthode Description
getByFileable ( string $fileableId ) : Illuminate\Database\Eloquent\Collection | static[] Get the files for fileable
getContent ( ) : string Get the content of file
getDerives ( ) : Illuminate\Database\Eloquent\Collection | static[] Get the derive files of current file
getFileableTable ( ) : string Get a fileable table name
getOriginKey ( ) : string Original file's identifier
getPathname ( ) : string Get a path name of file
getRawDerives ( ) : Illuminate\Database\Eloquent\Collection | static[] Get the derive files of current file with the File type
scopeDerives ( Builder $query, File $file ) : Builder Scope for derives
setContentReader ( Xpressengine\Storage\ContentReaderInterface $reader ) : void Set the ContentReader instance
setUrlMaker ( Xpressengine\Storage\UrlMaker $urlMaker ) : void Set the UrlMaker instance
url ( Closur\Closure $callback = null ) : string Get a file url

Method Details

getByFileable() public static méthode

Get the files for fileable
public static getByFileable ( string $fileableId ) : Illuminate\Database\Eloquent\Collection | static[]
$fileableId string fileable identifier
Résultat Illuminate\Database\Eloquent\Collection | static[]

getContent() public méthode

Get the content of file
public getContent ( ) : string
Résultat string

getDerives() public méthode

Get the derive files of current file
public getDerives ( ) : Illuminate\Database\Eloquent\Collection | static[]
Résultat Illuminate\Database\Eloquent\Collection | static[]

getFileableTable() public méthode

Get a fileable table name
public getFileableTable ( ) : string
Résultat string

getOriginKey() public méthode

Original file's identifier
public getOriginKey ( ) : string
Résultat string

getPathname() public méthode

Get a path name of file
public getPathname ( ) : string
Résultat string

getRawDerives() public méthode

Get the derive files of current file with the File type
public getRawDerives ( ) : Illuminate\Database\Eloquent\Collection | static[]
Résultat Illuminate\Database\Eloquent\Collection | static[]

scopeDerives() public méthode

Scope for derives
public scopeDerives ( Builder $query, File $file ) : Builder
$query Illuminate\Database\Eloquent\Builder query builder instance
$file File file instance
Résultat Illuminate\Database\Eloquent\Builder

setContentReader() public static méthode

Set the ContentReader instance
public static setContentReader ( Xpressengine\Storage\ContentReaderInterface $reader ) : void
$reader Xpressengine\Storage\ContentReaderInterface content reader instance
Résultat void

setUrlMaker() public static méthode

Set the UrlMaker instance
public static setUrlMaker ( Xpressengine\Storage\UrlMaker $urlMaker ) : void
$urlMaker Xpressengine\Storage\UrlMaker UrlMaker instance
Résultat void

url() public méthode

Get a file url
public url ( Closur\Closure $callback = null ) : string
$callback Closur\Closure callback
Résultat string

Property Details

$fileableTable protected_oe property

The table associated with the model for morph.
protected string $fileableTable
Résultat string

$incrementing public_oe property

Indicates if the IDs are auto-incrementing.
public bool $incrementing
Résultat boolean

$reader protected_oe static_oe property

The ContentReader instance
protected static ContentReaderInterface,Xpressengine\Storage $reader
Résultat Xpressengine\Storage\ContentReaderInterface

$table protected_oe property

The table associated with the model.
protected string $table
Résultat string

$urls protected_oe static_oe property

Storage UrlMaker instance
protected static UrlMaker,Xpressengine\Storage $urls
Résultat Xpressengine\Storage\UrlMaker