$id
$id :
$template : null|\FAA\Obj\Generic\Template
The template
A local instance of the assigned template
$parent : null|\FAA\Obj\Generic\Folder
The parent folder
GitRepo() : \FAA\Git|null
Get the related git instance
Will open a git instance on demand, this method is cached locally
FormattedId(string $prefix, string $pad_string = '0', integer $pad_length = 5, integer $pad_type = STR_PAD_LEFT) : string
expose the formatted object id provide an interface to extract the current id with formatting options
| string | $prefix | A prefix |
| string | $pad_string | The pad character |
| integer | $pad_length | The padding length |
| integer | $pad_type | The padding type |
The formatted id
GetState() : \FAA\Obj\Result
Expose the state Provide an interface to extract the current status
the object status
GetPlainOriginalAttribute(string $key, string $language = '') : mixed
Get original value get a plain resolved attribute value from the local storage
| string | $key | The searched attribute key |
| string | $language | The searched language key or false for all |
The found value
Contains(array $filter, string $language = null) : boolean
Check if attribute contains the search string
Matches the filters against the given attribute selected
| array | $filter | List of filters with operation, target attribute and value attr string The attribute to check op string The search operator e.g. LIKE value string The search string * matches all |
| string | $language | The loader value to get the attributes in |
When matching true
GetPlainOfRevision(string $hash, boolean $tolerate_error = false) : \FAA\Obj\Result
Fetch a certain version of a file based on the given hash
| string | $hash | The git revision hash |
| boolean | $tolerate_error | Ignore index errors on demand |
A system result object
GetListOfRevisions() : \FAA\Obj\Result
List versions
Load and provide a list of stored revisions for this objects. Will use git to determinate this list.
A system result object
Delete(boolean $skip = false, boolean $full = false) : \FAA\Obj\Result
delete entity from file system and git repo this method can delete this content object from our local storage system
| boolean | $skip | Skip hooks on demand |
| boolean | $full | Delete also the assigned contents |
A default system result set
Convert(string $target) : \FAA\Obj\Result
Convert to other object type
| string | $target | The target name |
The conversion result
Copy(mixed $target = null) : \FAA\Obj\Result
clone object entry in file system and git repository store the current payload inside the system storage and commit the changes to the local repository
| mixed | $target | For compatibility reasons with several subtypes this argument is required |
A default system result set
Save(boolean $force_new_id = false) : \FAA\Obj\Result
Save this folder entry in file system and git repo
Store the current payload inside the system storage and stage the changes to the local repository. Will handle prepared rename operation as well when the storage paths was changed by changing the key.
| boolean | $force_new_id | Create with new id when set to true |
A default system result set
ToPlainReducedObject(array $fields, string $language = null) : Object
Convert to reduced plain data set Translate and expose the current data attribute as plain resolved object with filtered attributes
| array | $fields | List of attributes to show |
| string | $language | A system language code or empty for raw setup |
A simple attribute based php object
ToPlainObject(string $language = null, boolean $with_parent = true) : \stdClass
convert to plain data set translate and expose the current data attribute as plain resolved object
| string | $language | A system language code or empty for raw setup |
| boolean | $with_parent | When set to true the attributes will be resolved witch parent attributes included |
A simple attribute based php object
GetParent() : \FAA\Obj\Generic\Folder|null
Get parent object
Get the parent folder object. This method is cached
The parent folder or, when root reached null
Parents() : array<mixed,\FAA\Obj\Generic\Folder>
Get list of parents
UpdateAccessRules(array $data) : \FAA\Obj\Result
update access rules for this folder update and store the access rules file, also do the stage operation
| array | $data | A list of access rules like given from GetAccessRules() |
A system result object
MirrorPermissions(string $source, string $target) : \FAA\Obj\Result
Mirror the permissions of a certain base group to a target group
| string | $source | The source group |
| string | $target | The target group |
A result object
GetAccessRules() : \FAA\Obj\Result
Get the access list
This method is cached by object cache.
A system result
FetchRelation(integer $id, string $language = null, string $type = 'relation') : \FAA\Obj\Generic\Relation
Get relation Fetch a relation object by id
| integer | $id | The relation id |
| string | $language | The language to resolve by |
| string | $type | The language to resolve by |
A system relation object
FetchExtension(integer $id, string $language = null) : \FAA\Obj\Generic\Extension
Get extension relation Fetch a extension relation object by id
| integer | $id | The relation id |
| string | $language | The language to resolve by |
A system extension relation object
Contents(string $language = null, boolean $recursive = false, boolean $include_extensions = false) : array<mixed,\FAA\Obj\Generic\Relation>
Get raw list of child relations for this folder Reads all content children relations of this folder and returns them as plain list
| string | $language | The language to load the child nodes in |
| boolean | $recursive | When set to true all sub nodes will be listed |
| boolean | $include_extensions | When set to true include extension relations |
A list of children with type Relation
Create(string $dir, array $payload) : \FAA\Obj\Result
Create a new folder Abstract method to create a new pysical folder
| string | $dir | A system object storage path relative |
| array | $payload | A folder dataset defined in Obj\Folder |
A system result object
GetTemplate() : \FAA\Obj\Generic\Template
load template abstract method to load the assigned template and return as object
A system template object covered in a result object
GetTplPath(string $file, string $ext = 'html') : string
load template path abstract method to load the path to a file from assigned template object will return null if file not found or template not registered
| string | $file | Name of the template file that |
| string | $ext | File extension of searched template |
Absolute path to the template or null if none was found
GetTemplateHook(\FAA\Obj\Request $request) : null|object
Get template hook function Load the template hook of this folder will return null when folder han none
| \FAA\Obj\Request | $request |
LinkTargetFolder() : \FAA\Obj\Generic\Folder|null
Return the active link target folder
When the folder is a link return the set target folder object
The instance or, null
loadFromSrc()
Load data from source
Fetch the content master file for this entry by given path The data will be stored in the local data property, when the data is encrypted it will be locally decrypted This function has not return value but a side effect on status. It will handle the cases when an entity is encryped in a transparent way
setPlainSubAttribute(array $target, mixed $value, string $path)
set a sub attribute update or add a plain attribute to this object this method will resolve the . separated path until the end of the limb is reached and $this->data was updated
| array | $target | A reference tho the this->data branch the update is target of |
| mixed | $value | The new value |
| string | $path | The remaining path components to target |