\FAA\Obj\GenericGroup

Summary

Methods

Properties

Constants

__construct()
UpdateAttributeAlias()
Name()
IsSystem()
ToPlainObject()
Save()
Copy()
GetPath()

$
$

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

$keyregex

N/A

Properties

$

$ :string

name

Type

string

$

$ :string

alias

Type

string

$keyregex

$keyregex :string

The main key must match this regex

Type

string

Methods

__construct()

__construct(string  $id = null,string  $language = null)

User group Construct a new user group object

Parameters

string	$id	The object name/id or null for new one
string	$language	The object language or null for raw one

UpdateAttributeAlias()

UpdateAttributeAlias(Object  $attr,string  $data): \FAA\Obj\Result

Callback on update validate name This function is called when the primary identifier is changed

Parameters

Object	$attr	The changed attribute
string	$data	The new attribute value

Returns

\FAA\Obj\Result —

A system result object

Name()

Name(string  $language = FAA_DEFAULT_LANGUAGE): mixed

Get the group name

Parameters

string

$language

Returns

mixed

IsSystem()

IsSystem(): boolean

Is a system group?

Returns

boolean

ToPlainObject()

ToPlainObject(null  $language = null,boolean  $with_parent = true): \stdClass

Convert to plain object

Parameters

null	$language
boolean	$with_parent

Returns

\stdClass

Save()

Save(boolean  $force_new_id = false): \FAA\Obj\Result

save object entry in file system and git repository store the current payload inside the system storage and commit the changes to the local repository

Parameters

boolean

$force_new_id

Indicate force new id on demand (local id empty)

Returns

\FAA\Obj\Result —

A default system result set

Copy()

Copy(string  $target = null): \FAA\Obj\Result

copy entity in file system and git repository this method can copy this content object in our local storage system to a new one

Parameters

string

$target

The target name

Returns

\FAA\Obj\Result —

A default system result set

GetPath()

GetPath(): string

Expose the storage path Provide an interface to extract the current path of this object

Returns

string —

the object storage path