\FAA\WidgetCompanys

Summary

Methods

Properties

Constants

__construct()
Endpoint()
Request()
Response()
GitRepo()
RegisterIncludes()
Init()
SearchSuggest()
SearchSuggestCustomers()
Search()
SearchCustomers()
SearchUser()
CustomerImport()
CustomerLink()
CustomerUnLink()
VisitCard()
PresetImport()
CustomerPreset()
Preset()
Add()
CompanySearchSingle()
Load()
Drop()
Update()
CompanySearchSingleSave()
CustomerLoad()
CustomerDelete()
CustomerAdd()
CustomerEdit()

$request

No constants found

ConfigGetPreset()
ConfigSave()
ConfigGetRaw()
ConfigGet()
CreateEntity()
handleSubContent()
handleSubViewList()
UpdateEntity()
CopyEntity()
deleteEntity()
fetchAssignedEntityList()
loadSingleEntity()
loadEntityFormPreset()
fetchEntityListFiltered()
fetchEntityList()
fetchObject()
CheckObjectAccess()

$endpoint
$response

N/A

testChainOfTrust()
companySearch()
getCompanyFilter()

$git_repo

N/A

File: lib/widgets/companys/widget.php
Package: FAA\Widget
Class hierarchy: \FAA\Widget\Master

\FAA\Widget\Companys

Properties

$request

$request : null|\FAA\Obj\Request

Type

null|\FAA\Obj\Request

$endpoint

$endpoint : \FAA\Obj\Endpoint|null

Type

\FAA\Obj\Endpoint|null

$response

$response : \FAA\Obj\Response|null

Type

\FAA\Obj\Response|null

$git_repo

$git_repo : array<mixed,\FAA\Git>

Type

array<mixed,\FAA\Git>

Methods

__construct()

__construct()

Master constructor.

Endpoint()

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

Parameters

\FAA\Obj\Endpoint

$endpoint

A system request list

Returns

\FAA\Obj\Endpoint —

A system endpoint object

Request()

Request(\FAA\Obj\Request  $request = null) : \FAA\Obj\Request

The request Sets or gets the widget request object

Parameters

\FAA\Obj\Request

$request

A system request object

Returns

\FAA\Obj\Request —

A system request object

Response()

Response() : \FAA\Obj\Response

Response object Gets the widget response

Returns

\FAA\Obj\Response —

A system response object

GitRepo()

GitRepo(string  $path = 'data') : \FAA\Git

Git object

Gets the widget git instance, either for config or, for data repo

Parameters

string

$path

The target repo, default is data

Returns

\FAA\Git —

A system git object with data folder as start point

RegisterIncludes()

RegisterIncludes()

Init()

Init()

SearchSuggest()

SearchSuggest()

SearchSuggestCustomers()

SearchSuggestCustomers()

Search()

Search()

SearchCustomers()

SearchCustomers()

SearchUser()

SearchUser()

CustomerImport()

CustomerImport()

CustomerLink()

CustomerLink()

CustomerUnLink()

CustomerUnLink()

VisitCard()

VisitCard()

PresetImport()

PresetImport()

CustomerPreset()

CustomerPreset()

Preset()

Preset()

Add()

Add()

CompanySearchSingle()

CompanySearchSingle()

Load()

Load()

Drop()

Drop()

Update()

Update()

CompanySearchSingleSave()

CompanySearchSingleSave()

CustomerLoad()

CustomerLoad()

CustomerDelete()

CustomerDelete()

CustomerAdd()

CustomerAdd()

CustomerEdit()

CustomerEdit()

ConfigGetPreset()

ConfigGetPreset(string  $name)

Get the configuration preset data

Parameters

string

$name

The name of the config file

ConfigSave()

ConfigSave(string  $name)

Store a configuration with values from body and a given name

Parameters

string

$name

The name of the config file

ConfigGetRaw()

ConfigGetRaw(string  $name) : \FAA\Obj\Result

Get configuration data as object from setup handler

Parameters

string

$name

The name of the config file

Returns

\FAA\Obj\Result

ConfigGet()

ConfigGet(string  $name)

Get a configuration by name

Parameters

string

$name

The name of the config file

CreateEntity()

CreateEntity(string  $type)

create new object this method creates a new instance of a specific system content type

Parameters

string

$type

A registered system content type

handleSubContent()

handleSubContent(integer  $offset = 3)

handle sub content operations this method can handle the creation update form preset loading and delete of sub contents

Parameters

integer

$offset

The offset of the first chained component in url

handleSubViewList()

handleSubViewList(array  $payload)

Handle the list/object loading for sub view of contents

Parameters

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()

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

Parameters

string	$type	The requested content type
integer	$epIndex	Parse this parameter as id
boolean	$return

CopyEntity()

CopyEntity(string  $type, integer  $epIndex)

copy a single content links the frontend to the copy handler for single contents identified by rest end point argument

Parameters

string	$type	The requested content type
integer	$epIndex	Parse this parameter as id

deleteEntity()

deleteEntity(string  $type, integer  $epIndex)

delete a single content implements the delete handler for single contents identified by rest end point argument

Parameters

string	$type	The requested content type
integer	$epIndex	Parse this parameter as id

fetchAssignedEntityList()

fetchAssignedEntityList(  $list, null  $language = null)

Parameters

	$list
null	$language

loadSingleEntity()

loadSingleEntity(string  $type, integer  $epIndex, string  $language = null)

load a single content implements the loader for single contents identified by rest end point argument

Parameters

string	$type	The requested content type
integer	$epIndex	Parse this parameter as id
string	$language	Language code to fetch element in

loadEntityFormPreset()

loadEntityFormPreset(string  $type)

load form preset implements the form preset loader for a certain content type

Parameters

string

$type

The requested content type

fetchEntityListFiltered()

fetchEntityListFiltered(string  $type)

Fetch filtered list

Implements the server side data tables processing functions Supports freetext search, paging and ordering at the moment

Parameters

string

$type

The requested content type

fetchEntityList()

fetchEntityList(string  $type, boolean  $raw = false)

Fetch list of entries Use the direct loader method to retrieve a list obf objects

Parameters

string	$type	Fetch list of elements
boolean	$raw	Return as raw object and not plain

fetchObject()

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

Parameters

string\|integer	$id	A object id
string	$type	A object type
string	$right	A access level to test against

Returns

\FAA\Obj\Generic\BaseContent|boolean|null —

A base content or null when not found or false when not access

CheckObjectAccess()

CheckObjectAccess(  $content,   $right)

Parameters

	$content
	$right

testChainOfTrust()

testChainOfTrust(array  $args, integer  $offset = 3) : boolean

Test chain Check if the upstream call is valid and the user has access to this node

Parameters

array	$args	The request url
integer	$offset	The first component to check

Returns

boolean —

Chain of trust valid?

companySearch()

companySearch(  $payload)

Parameters

$payload

getCompanyFilter()

getCompanyFilter()