class Space implements JsonSerializable

The Space class represents a single space identified by it's ID and holding some metadata.

Methods

__construct(string $name, array $locales, SystemProperties $sys)

Space constructor.

string
getName()

Returns the name of this space.

Locale[]
getLocales()

Returns the list of all locales supported by this Space.

getDefaultLocale()

Returns the default locale for this space.

string|null
getId()

Returns the id of this space.

object
jsonSerialize()

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

Details

at line 41
__construct(string $name, array $locales, SystemProperties $sys)

Space constructor.

Parameters

string $name Name of this space.
array $locales Locales supported by this space.
SystemProperties $sys Metadata for this space.

at line 60
string getName()

Returns the name of this space.

Return Value

string

at line 70
Locale[] getLocales()

Returns the list of all locales supported by this Space.

Return Value

Locale[]

at line 80
Locale getDefaultLocale()

Returns the default locale for this space.

Return Value

Locale

at line 90
string|null getId()

Returns the id of this space.

Return Value

string|null

at line 102
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