FieldApi
extends AbstractApi
in package
Use API to manage custom fields for projects, tasks, users, files, strings, and translations.
Table of Contents
Methods
- create() : Field|null
- Add Field
- delete() : mixed
- Delete Field
- get() : Field|null
- Get Field
- list() : ModelCollection
- List Fields
- update() : Field
- Edit Field
Methods
create()
Add Field
public
create(array<string|int, mixed> $data) : Field|null
Parameters
- $data : array<string|int, mixed>
-
string $data[name] required
string $data[slug] required
string $data[type] required
array $data[entities] required
string $data[description]
array $data[config]
Tags
Return values
Field|nulldelete()
Delete Field
public
delete(int $fieldId) : mixed
Parameters
- $fieldId : int
Tags
get()
Get Field
public
get(int $fieldId) : Field|null
Parameters
- $fieldId : int
Tags
Return values
Field|nulllist()
List Fields
public
list([array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $params : array<string|int, mixed> = []
-
string $params[search]
string $params[entity]
string $params[type]
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionupdate()
Edit Field
public
update(Field $field) : Field
Parameters
- $field : Field