Types
extends Master
in package
Define system widget to handle content types
This widget provides an UI and interfaces to manage content type settings, the type program code and security settings. In addition a UI to manage the linked endpoints is available.
Tags
Table of Contents
- $request : Request|null
- $endpoint : Endpoint|null
- $response : Response|null
- $setup : Widget|null
- $git_repo : array<string|int, mixed>
- __construct() : mixed
- Needs to be there even if it is empty
- AddAttributeOption() : void
- AddTextToken() : void
- AvailableAttributeOptions() : void
- BulkUpdateContent() : void
- ConfigLoad() : void
- ConfigStore() : void
- Create() : void
- DefaultLoad() : void
- DefaultStore() : void
- Drop() : void
- DropTextToken() : void
- Duplicate() : void
- Endpoint() : Endpoint|null
- Get/Set endpoint
- FetchTextToken() : void
- FormFieldPreset() : void
- GetRelatedChildTypes() : void
- GetRelatedTypes() : void
- GitRepo() : Git
- Git object
- Init() : void
- Load() : void
- LoadSingle() : void
- RegisterIncludes() : mixed
- Request() : Request
- The request Sets or gets the widget request object
- ResolvedFormPreset() : void
- ResolveUniqueAttributeValues() : void
- Response() : Response
- Response object Get / Set the widget response
- SearchTextToken() : void
- Setup() : Widget|null
- Get/Set the widget context
- Update() : void
- UpdateTextToken() : void
- ConfigGet() : void
- Get a configuration by name
- ConfigGetPreset() : void
- Get the configuration preset data
- ConfigGetRaw() : Result
- Get configuration data as object from setup handler
- ConfigSave() : void
- Store a configuration with values from body and a given name
- CopyEntity() : void
- copy a single content links the frontend to the copy handler for single contents identified by rest end point argument
- CreateEntity() : mixed
- create new object
- deleteEntity() : void
- Delete a single content
- fetchAssignedEntityList() : mixed
- fetchEntityList() : void
- Fetch list of entries Use the direct loader method to retrieve a list obf objects
- fetchEntityListFiltered() : void
- Fetch filtered list
- fetchObject() : BaseContent|bool|null
- Retrieve an object from storage
- handleSubViewList() : mixed
- Handle the list/object loading for sub view of contents
- loadSingleEntity() : void
- load a single content implements the loader for single contents identified by rest end point argument
- prepareObjectLogs() : void
- Prepare the object comment and arguments for changes in diff
- UpdateEntity() : void
- Update a single content
- getType() : Type|null
- Load type based on rest endpoint values
Properties
$request
public
Request|null
$request
= null
$endpoint
protected
Endpoint|null
$endpoint
= null
$response
protected
Response|null
$response
= null
$setup
protected
Widget|null
$setup
= null
$git_repo
private
array<string|int, mixed>
$git_repo
= array()
Methods
__construct()
Needs to be there even if it is empty
public
__construct() : mixed
Return values
mixed —AddAttributeOption()
public
AddAttributeOption() : void
Return values
void —AddTextToken()
public
AddTextToken() : void
Return values
void —AvailableAttributeOptions()
public
AvailableAttributeOptions() : void
Return values
void —BulkUpdateContent()
public
BulkUpdateContent() : void
Return values
void —ConfigLoad()
public
ConfigLoad() : void
Return values
void —ConfigStore()
public
ConfigStore() : void
Return values
void —Create()
public
Create() : void
Return values
void —DefaultLoad()
public
DefaultLoad() : void
Return values
void —DefaultStore()
public
DefaultStore() : void
Return values
void —Drop()
public
Drop() : void
Return values
void —DropTextToken()
public
DropTextToken() : void
Return values
void —Duplicate()
public
Duplicate() : void
Return values
void —Endpoint()
Get/Set endpoint
public
Endpoint([Endpoint|null $endpoint = null ]) : Endpoint|null
Sets or gets the widget arguments, they contain the endpoint this widget was called at
Parameters
- $endpoint : Endpoint|null = null
-
A system request list
Return values
Endpoint|null —A system endpoint object
FetchTextToken()
public
FetchTextToken() : void
Return values
void —FormFieldPreset()
public
FormFieldPreset() : void
Return values
void —GetRelatedChildTypes()
public
GetRelatedChildTypes() : void
Return values
void —GetRelatedTypes()
public
GetRelatedTypes() : void
Return values
void —GitRepo()
Git object
public
GitRepo([string $path = 'data' ]) : Git
Gets the widget git instance, either for config or, for data repo
Parameters
- $path : string = 'data'
-
The target repo, default is data
Return values
Git —A system git object with data folder as start point
Init()
public
Init() : void
Return values
void —Load()
public
Load() : void
Return values
void —LoadSingle()
public
LoadSingle() : void
Return values
void —RegisterIncludes()
public
RegisterIncludes() : mixed
Return values
mixed —Request()
The request Sets or gets the widget request object
public
Request([Request|null $request = null ]) : Request
Parameters
- $request : Request|null = null
-
A system request object
Return values
Request —A system request object
ResolvedFormPreset()
public
ResolvedFormPreset() : void
Return values
void —ResolveUniqueAttributeValues()
public
ResolveUniqueAttributeValues() : void
Return values
void —Response()
Response object Get / Set the widget response
public
Response([Response|null $response = null ]) : Response
Parameters
- $response : Response|null = null
Return values
Response —A system response object
SearchTextToken()
public
SearchTextToken() : void
Return values
void —Setup()
Get/Set the widget context
public
Setup([Widget|null $setup = null ]) : Widget|null
Parameters
- $setup : Widget|null = null
Return values
Widget|null —Update()
public
Update() : void
Return values
void —UpdateTextToken()
public
UpdateTextToken() : void
Return values
void —ConfigGet()
Get a configuration by name
protected
ConfigGet(string $name) : void
Parameters
- $name : string
-
The name of the config file
Return values
void —ConfigGetPreset()
Get the configuration preset data
protected
ConfigGetPreset(string $name) : void
Parameters
- $name : string
-
The name of the config file
Return values
void —ConfigGetRaw()
Get configuration data as object from setup handler
protected
ConfigGetRaw(string $name) : Result
Parameters
- $name : string
-
The name of the config file
Return values
Result —ConfigSave()
Store a configuration with values from body and a given name
protected
ConfigSave(string $name) : void
Parameters
- $name : string
-
The name of the config file
Return values
void —CopyEntity()
copy a single content links the frontend to the copy handler for single contents identified by rest end point argument
protected
CopyEntity(array<string|int, mixed>|string $type, int|string $epIndex) : void
Parameters
- $type : array<string|int, mixed>|string
-
The requested content type
- $epIndex : int|string
-
Parse this parameter as id
Return values
void —CreateEntity()
create new object
protected
CreateEntity(string $type) : mixed
this method creates a new instance of a specific system content type
Parameters
- $type : string
-
A registered system content type
Return values
mixed —deleteEntity()
Delete a single content
protected
deleteEntity(string|array<string|int, string> $type, int|string $epIndex) : void
Implements the delete handler for single contents identified by rest end point argument
Parameters
- $type : string|array<string|int, string>
-
The requested content type
- $epIndex : int|string
-
Parse this parameter as id
Return values
void —fetchAssignedEntityList()
protected
fetchAssignedEntityList( $list[, null $language = null ]) : mixed
Parameters
Tags
Return values
mixed —fetchEntityList()
Fetch list of entries Use the direct loader method to retrieve a list obf objects
protected
fetchEntityList(string $type[, bool $raw = false ]) : void
Parameters
- $type : string
-
Fetch list of elements
- $raw : bool = false
-
Return as raw object and not plain
Return values
void —fetchEntityListFiltered()
Fetch filtered list
protected
fetchEntityListFiltered(string|array<string|int, string> $type[, array<string|int, mixed>|null $extra_payload = null ]) : void
Implements the server side data tables processing functions Supports free text search, paging and ordering at the moment
Parameters
- $type : string|array<string|int, string>
-
The requested content type(s)
- $extra_payload : array<string|int, mixed>|null = null
-
Additional filter operators
Return values
void —fetchObject()
Retrieve an object from storage
protected
fetchObject(int|string $id, string|array<string|int, string> $type[, string $right = 'view' ]) : BaseContent|bool|null
Load a single content from storage as instance If object was not found it will set the 404 error code
Parameters
- $id : int|string
-
A object id
- $type : string|array<string|int, string>
-
A object type
- $right : string = 'view'
-
An access level to test against
Return values
BaseContent|bool|null —A base content or null when not found or false when not access
handleSubViewList()
Handle the list/object loading for sub view of contents
protected
handleSubViewList(array<string|int, mixed> $payload) : mixed
Parameters
- $payload : array<string|int, mixed>
-
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)
Tags
Return values
mixed —loadSingleEntity()
load a single content implements the loader for single contents identified by rest end point argument
protected
loadSingleEntity(string $type, int|string $epIndex[, string|null $language = null ]) : void
Parameters
- $type : string
-
The requested content type
- $epIndex : int|string
-
Parse this parameter as id
- $language : string|null = null
-
Language code to fetch element in
Return values
void —prepareObjectLogs()
Prepare the object comment and arguments for changes in diff
protected
prepareObjectLogs(BaseContent $item) : void
Parameters
- $item : BaseContent
Return values
void —UpdateEntity()
Update a single content
protected
UpdateEntity(string|array<string|int, string> $type, int|string $epIndex[, bool $return = false ]) : void
Implements the update handler for single contents identified by rest end point argument Does return the values when config option says so
Parameters
- $type : string|array<string|int, string>
-
The requested content type or, a list of allowed types
- $epIndex : int|string
-
Parse this parameter as id
- $return : bool = false
Return values
void —getType()
Load type based on rest endpoint values
private
getType() : Type|null