CRUD
in package
implements
IOverrideCRUD
Uses
UtilsProvider, CRUD
Static class to perform CRUD operations on folders. Please do not use this directly instead use the API functions.
The R (Read) is not implemented here because updates should be executed through the API functions. It also holds the registered creatables.
Table of Contents
Interfaces
Properties
- $creatables : mixed
- Available creatables.
- $me : mixed
Methods
- create() : mixed
- createRecursively() : mixed
- getCreatables() : array<string|int, int>|Creatable
- Get available creatables.
- getInstance() : CRUD
- Get instance.
- getPluginConstantPrefix() : string
- Get the prefix of this plugin so composer packages can dynamically build other constant values on it.
- registerCreatable() : mixed
- remove() : mixed
- update() : mixed
Properties
$creatables
Available creatables.
private
mixed
$creatables
= []
$me
private
static mixed
$me
= null
Methods
create()
public
create(mixed $name, mixed $parent, mixed $type[, mixed $restrictions = [] ][, mixed $supress_validation = false ][, mixed $return_existing_id = false ]) : mixed
Parameters
- $name : mixed
- $parent : mixed
- $type : mixed
- $restrictions : mixed = []
- $supress_validation : mixed = false
- $return_existing_id : mixed = false
createRecursively()
public
createRecursively(mixed $name, mixed $parent, mixed $type[, mixed $restrictions = [] ][, mixed $supress_validation = false ]) : mixed
Parameters
- $name : mixed
- $parent : mixed
- $type : mixed
- $restrictions : mixed = []
- $supress_validation : mixed = false
getCreatables()
Get available creatables.
public
getCreatables([int $type = null ]) : array<string|int, int>|Creatable
Parameters
- $type : int = null
Return values
array<string|int, int>|CreatablegetInstance()
Get instance.
public
static getInstance() : CRUD
Return values
CRUDgetPluginConstantPrefix()
Get the prefix of this plugin so composer packages can dynamically build other constant values on it.
public
getPluginConstantPrefix() : string
Tags
Return values
stringregisterCreatable()
public
registerCreatable(mixed $qualified, mixed $type[, mixed $onRegister = false ]) : mixed
Parameters
- $qualified : mixed
- $type : mixed
- $onRegister : mixed = false
remove()
public
remove(mixed $id[, mixed $supress_validation = false ]) : mixed
Parameters
- $id : mixed
- $supress_validation : mixed = false
update()
public
update(mixed $name, mixed $id[, mixed $supress_validation = false ]) : mixed
Parameters
- $name : mixed
- $id : mixed
- $supress_validation : mixed = false