class Asset extends LocalizedResource implements JsonSerializable

Properties

protected string $localeCode The code of the currently active locale from LocalizedResource

Methods

__construct(object $title, object $description, object $file, SystemProperties $sys)

Asset constructor.

$this
setLocale(Locale|string $locale)

Set the locale for this instance. All future calls to a getter will return the information for this locale.

string
getLocale()

The locale code for the currently set locale.

string
getLocaleFromInput(Locale|string|null $input = null)

No description

string
getTitle(Locale|string|null $locale = null)

The title of the asset.

string
getDescription(Locale|string|null $locale = null)

No description

getFile(Locale|string|null $locale = null)

No description

string
getId()

Returns the ID of this Asset.

int
getRevision()

Returns the Revision of this Asset.

getUpdatedAt()

Returns the time when this Asset was last changed.

getCreatedAt()

Returns the time when this Asset was created.

getSpace()

Returns the Space this Asset belongs to.

object
jsonSerialize()

Returns an object to be used by json_encode to serialize objects of this class.

Details

at line 39
__construct(object $title, object $description, object $file, SystemProperties $sys)

Asset constructor.

Parameters

object $title
object $description
object $file
SystemProperties $sys

in LocalizedResource at line 54
$this setLocale(Locale|string $locale)

Set the locale for this instance. All future calls to a getter will return the information for this locale.

Parameters

Locale|string $locale The locale code as string or an instance of Locale.

Return Value

$this

Exceptions

InvalidArgumentException When $locale is not one of the locales supported by the space.

in LocalizedResource at line 76
string getLocale()

The locale code for the currently set locale.

Return Value

string

in LocalizedResource at line 90
protected string getLocaleFromInput(Locale|string|null $input = null)

Parameters

Locale|string|null $input

Return Value

string

Exceptions

InvalidArgumentException When $locale is not one of the locales supported by the space.

at line 56
string getTitle(Locale|string|null $locale = null)

The title of the asset.

Parameters

Locale|string|null $locale

Return Value

string

at line 68
string getDescription(Locale|string|null $locale = null)

Parameters

Locale|string|null $locale

Return Value

string

at line 85
File getFile(Locale|string|null $locale = null)

Parameters

Locale|string|null $locale

Return Value

File

at line 99
string getId()

Returns the ID of this Asset.

Return Value

string

at line 111
int getRevision()

Returns the Revision of this Asset.

Return Value

int

at line 123
DateTimeImmutable getUpdatedAt()

Returns the time when this Asset was last changed.

Return Value

DateTimeImmutable

at line 135
DateTimeImmutable getCreatedAt()

Returns the time when this Asset was created.

Return Value

DateTimeImmutable

at line 147
Space getSpace()

Returns the Space this Asset belongs to.

Return Value

Space

at line 161
object jsonSerialize()

Returns an object to be used by json_encode to serialize objects of this class.

Return Value

object

See also

http://php.net/manual/en/jsonserializable.jsonserialize.php JsonSerializable::jsonSerialize