CustomPlaceholderApi
extends AbstractApi
in package
Custom placeholders are defined once for the organization and then assigned to projects.
Table of Contents
Methods
- addProjectPlaceholder() : ProjectPlaceholder|null
- Add Project Placeholder
- create() : CustomPlaceholder|null
- Add Custom Placeholder
- delete() : mixed
- Delete Custom Placeholder
- deleteProjectPlaceholder() : mixed
- Delete Project Placeholder
- get() : CustomPlaceholder|null
- Get Custom Placeholder
- getProjectPlaceholder() : ProjectPlaceholder|null
- Get Project Placeholder
- list() : ModelCollection
- List Custom Placeholders
- listProjectPlaceholders() : ModelCollection
- List Project Placeholders
- update() : CustomPlaceholder|null
- Edit Custom Placeholder
- updateProjectPlaceholder() : ProjectPlaceholder|null
- Edit Project Placeholder
Methods
addProjectPlaceholder()
Add Project Placeholder
public
addProjectPlaceholder(int $projectId, array<string|int, mixed> $data) : ProjectPlaceholder|null
Parameters
- $projectId : int
- $data : array<string|int, mixed>
-
integer $data[customPlaceholderId] required
string $data[type] Enum: "high" "low"
integer $data[index]
boolean $data[isBlocking]
string[] $data[formats] Empty means every file format
Tags
Return values
ProjectPlaceholder|nullcreate()
Add Custom Placeholder
public
create(array<string|int, mixed> $data) : CustomPlaceholder|null
Parameters
- $data : array<string|int, mixed>
-
string $data[definition] required
string $data[description]
string $data[argumentDelimiter] Default: "
Tags
Return values
CustomPlaceholder|nulldelete()
Delete Custom Placeholder
public
delete(int $customPlaceholderId) : mixed
Parameters
- $customPlaceholderId : int
Tags
deleteProjectPlaceholder()
Delete Project Placeholder
public
deleteProjectPlaceholder(int $projectId, int $projectPlaceholderId) : mixed
Parameters
- $projectId : int
- $projectPlaceholderId : int
Tags
get()
Get Custom Placeholder
public
get(int $customPlaceholderId) : CustomPlaceholder|null
Parameters
- $customPlaceholderId : int
Tags
Return values
CustomPlaceholder|nullgetProjectPlaceholder()
Get Project Placeholder
public
getProjectPlaceholder(int $projectId, int $projectPlaceholderId) : ProjectPlaceholder|null
Parameters
- $projectId : int
- $projectPlaceholderId : int
Tags
Return values
ProjectPlaceholder|nulllist()
List Custom Placeholders
public
list([array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $params : array<string|int, mixed> = []
-
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionlistProjectPlaceholders()
List Project Placeholders
public
listProjectPlaceholders(int $projectId[, array<string|int, mixed> $params = [] ]) : ModelCollection
Parameters
- $projectId : int
- $params : array<string|int, mixed> = []
-
integer $params[limit]
integer $params[offset]
Tags
Return values
ModelCollectionupdate()
Edit Custom Placeholder
public
update(CustomPlaceholder $customPlaceholder) : CustomPlaceholder|null
Parameters
- $customPlaceholder : CustomPlaceholder
Tags
Return values
CustomPlaceholder|nullupdateProjectPlaceholder()
Edit Project Placeholder
public
updateProjectPlaceholder(int $projectId, ProjectPlaceholder $projectPlaceholder) : ProjectPlaceholder|null
Parameters
- $projectId : int
- $projectPlaceholder : ProjectPlaceholder