\MatthiasWeb\RealMediaLibrary\folderCRUD

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.

Summary

Methods
Properties
Constants
getPluginConstantPrefix()
createRecursively()
create()
update()
remove()
registerCreatable()
getCreatables()
getInstance()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$me
$creatables
N/A

Properties

$me

$me :

Type

$creatables

$creatables :

Available creatables.

Type

Methods

getPluginConstantPrefix()

getPluginConstantPrefix(): string

Get the prefix of this plugin so composer packages can dynamically build other constant values on it.

Returns

string

createRecursively()

createRecursively(  $name,  $parent,  $type,  $restrictions = array(),  $supress_validation = false)

Parameters

$name
$parent
$type
$restrictions
$supress_validation

create()

create(  $name,  $parent,  $type,  $restrictions = array(),  $supress_validation = false,  $return_existing_id = false)

Parameters

$name
$parent
$type
$restrictions
$supress_validation
$return_existing_id

update()

update(  $name,  $id,  $supress_validation = false)

Parameters

$name
$id
$supress_validation

remove()

remove(  $id,  $supress_validation = false)

Parameters

$id
$supress_validation

registerCreatable()

registerCreatable(  $qualified,  $type,  $onRegister = false)

Parameters

$qualified
$type
$onRegister

getCreatables()

getCreatables(integer  $type = null): array<mixed,integer>|\MatthiasWeb\RealMediaLibrary\folder\Creatable

Get available creatables.

Parameters

integer $type

Returns

array<mixed,integer>|\MatthiasWeb\RealMediaLibrary\folder\Creatable