$request
$request : null|\FAA\Obj\Request
$request : null|\FAA\Obj\Request
$endpoint : \FAA\Obj\Endpoint|null
$response : \FAA\Obj\Response|null
Endpoint(\FAA\Obj\Endpoint $endpoint = null) : \FAA\Obj\Endpoint
Get/Set endpoint
Sets or gets the widget arguments, they contain the endpoint this widget was called at
\FAA\Obj\Endpoint | $endpoint | A system request list |
A system endpoint object
Request(\FAA\Obj\Request $request = null) : \FAA\Obj\Request
The request Sets or gets the widget request object
\FAA\Obj\Request | $request | A system request object |
A system request object
Response() : \FAA\Obj\Response
Response object Gets the widget response
A system response object
ConfigGetRaw(string $name) : \FAA\Obj\Result
Get configuration data as object from setup handler
string | $name | The name of the config file |
handleSubViewList(array $payload)
Handle the list/object loading for sub view of contents
array | $payload | The request payload parent_type string Name of the parent type to manage inside parent string/int The id of the parent content attr string The attribute name to manage type string Type of the content to assign elements array List of elements when type is __multi content int Id when a direct content edit is performed (e.g. in child contents) |
UpdateEntity(string $type, integer $epIndex, boolean $return = false)
Update a single content
Implements the update handler for single contents identified by rest end point argument Does return the values when config option says so
string | $type | The requested content type |
integer | $epIndex | Parse this parameter as id |
boolean | $return |
loadSingleEntity(string $type, integer $epIndex, string $language = null)
load a single content implements the loader for single contents identified by rest end point argument
string | $type | The requested content type |
integer | $epIndex | Parse this parameter as id |
string | $language | Language code to fetch element in |
None found |
loadEntityFormPreset(string $type)
load form preset implements the form preset loader for a certain content type
string | $type | The requested content type |
None found |
fetchEntityListFiltered(string $type)
Fetch filtered list
Implements the server side data tables processing functions Supports freetext search, paging and ordering at the moment
string | $type | The requested content type |
None found |
fetchEntityList(string $type, boolean $raw = false)
Fetch list of entries Use the direct loader method to retrieve a list obf objects
string | $type | Fetch list of elements |
boolean | $raw | Return as raw object and not plain |
None found |
fetchObject(string|integer $id, string $type, string $right = 'view') : \FAA\Obj\Generic\BaseContent|boolean|null
Get a object from storage Load a single content from storage as instance
string|integer | $id | A object id |
string | $type | A object type |
string | $right | A access level to test against |
A base content or null when not found or false when not access
None found |
testChainOfTrust(array $args, integer $offset = 3) : boolean
Test chain Check if the upstream call is valid and the user has access to this node
array | $args | The request url |
integer | $offset | The first component to check |
Chain of trust valid?
None found |
loadVisibleTree() : array|array<mixed,\FAA\Obj\Generic\FolderTree>|mixed|null
None found |
loadProject(string $mode) : \FAA\Obj\Generic\TaskProject
Load project Load the project by given query string
string | $mode | The right to test against |
A project object or null when not found
None found |
_getTask(integer $id, string $type) : \FAA\Obj\Generic\Task|null
Get task Get a single task object
integer | $id | A task id |
string | $type | Task object type name |
The found task
None found |
loadMyTask(string $right = 'view') : \FAA\Obj\Generic\Task|null
Load the task by relation Additionally a filter is applied here that returns only tasks im am assigned to Opens a task based on a url like: /api/my-tasks/test/task/236
string | $right |
None found |
loadTask(string $right = 'view') : \FAA\Obj\Generic\Task|null
load the task by relation Opens a task based on a url like: /api/project-tasks/test/task/236
string | $right |
None found |
getProject(string $path, string $mode) : \FAA\Obj\Generic\TaskProject
Load project Load the project by given query string
string | $path | The relative project path |
string | $mode | The right to test against |
A project object or null when not found
None found |
filterTree(array $items, array $companies) : array
Filter tree Recursive filtering of folder tree list by user companies
array | $items | A list of folder objects |
array | $companies | The list of users company ids |
A list of filtered folder objects
None found |
None found |
notifyEmployee(\FAA\Obj\Generic\TaskProject $project, \FAA\Obj\Generic\Task $content, array $notify_employee) : \FAA\Obj\Result
Send notification emails Parse the list of notifications and send them to the customers
\FAA\Obj\Generic\TaskProject | $project | A system project object |
\FAA\Obj\Generic\Task | $content | A system task |
array | $notify_employee | The frontend prepared object with notifications |
None found |
fetchMyTaskTimes(\FAA\Obj\Generic\Task $task) : array
\FAA\Obj\Generic\Task | $task | A task object |
The task time entries
None found |