MediaCollectionInterface
extends
MediaCollectionInterface
in
Class implements media collection interface.
Table of Contents
Methods
- add() : void
- all() : array<string|int, MediaObjectInterface>
- Get a list of all media.
- audios() : array<string|int, MediaObjectInterface>
- Get a list of all audio media.
- createFromArray() : Medium|null
- Create Medium from array of parameters
- createFromFile() : Medium|null
- Create Medium from a file.
- files() : array<string|int, MediaObjectInterface>
- Get a list of all file media.
- get() : Medium|null
- Get medium by filename.
- getImageFileObject() : ImageFile
- getPath() : string|null
- Return media path.
- images() : array<string|int, MediaObjectInterface>
- Get a list of all image media.
- setPath() : void
- setTimestamps() : $this
- Set file modification timestamps (query params) for all the media files.
- videos() : array<string|int, MediaObjectInterface>
- Get a list of all video media.
Methods
add()
public
add(string $name, MediaObjectInterface $file) : void
Parameters
- $name : string
- $file : MediaObjectInterface
all()
Get a list of all media.
public
all() : array<string|int, MediaObjectInterface>
Return values
array<string|int, MediaObjectInterface>audios()
Get a list of all audio media.
public
audios() : array<string|int, MediaObjectInterface>
Return values
array<string|int, MediaObjectInterface>createFromArray()
Create Medium from array of parameters
public
createFromArray([array<string|int, mixed> $items = [] ][, Blueprint|null $blueprint = null ]) : Medium|null
Parameters
- $items : array<string|int, mixed> = []
- $blueprint : Blueprint|null = null
Return values
Medium|nullcreateFromFile()
Create Medium from a file.
public
createFromFile(string $file[, array<string|int, mixed> $params = [] ]) : Medium|null
Parameters
- $file : string
- $params : array<string|int, mixed> = []
Return values
Medium|nullfiles()
Get a list of all file media.
public
files() : array<string|int, MediaObjectInterface>
Return values
array<string|int, MediaObjectInterface>get()
Get medium by filename.
public
get(string $filename) : Medium|null
Parameters
- $filename : string
Return values
Medium|nullgetImageFileObject()
public
getImageFileObject(MediaObjectInterface $mediaObject) : ImageFile
Parameters
- $mediaObject : MediaObjectInterface
Return values
ImageFilegetPath()
Return media path.
public
getPath() : string|null
Return values
string|nullimages()
Get a list of all image media.
public
images() : array<string|int, MediaObjectInterface>
Return values
array<string|int, MediaObjectInterface>setPath()
public
setPath(string|null $path) : void
Parameters
- $path : string|null
setTimestamps()
Set file modification timestamps (query params) for all the media files.
public
setTimestamps([string|int|null $timestamp = null ]) : $this
Parameters
- $timestamp : string|int|null = null
Return values
$thisvideos()
Get a list of all video media.
public
videos() : array<string|int, MediaObjectInterface>