Class Creatable
Abstract class for a creatable folder item. It handles all general actions for a folder item. If you want to add an new folder type, have a look at the api function wp_rml_register_creatable();
A new folder type MUST have the implementation with class FOLDERTYPE extends order\Sortable because every folder can also be sortable!
- MatthiasWeb\RealMediaLibrary\base\Base
-
MatthiasWeb\RealMediaLibrary\folder\BaseFolder implements MatthiasWeb\RealMediaLibrary\api\IFolder
-
MatthiasWeb\RealMediaLibrary\folder\Creatable
Direct known subclasses
Indirect known subclasses
MatthiasWeb\RealMediaLibrary\folder\Collection
,
MatthiasWeb\RealMediaLibrary\folder\Folder
,
MatthiasWeb\RealMediaLibrary\folder\Gallery
,
MatthiasWeb\RealMediaLibrary\folder\Root
Methods summary
public
|
#
__construct( $id, $parent = -1, $name = "", $slug = "", $absolute = "", $order = -1, $cnt = 0, $row = array() )
C'tor with the main properties. |
public
|
|
public
|
|
public
|
#
reindexChildrens( boolean $resetData = false )
Reindex the children folders so the "ord" number is setted right. |
public
true
|
|
protected
|
#
singleCheckInsertPermissions( integer $id )
Simply check, if an id can be inserted in this folder. If something is wrong with the id, please throw an exception! |
protected
|
#
singleCheckInsert( integer $id )
Simply check, if an id can be inserted in this folder. If something is wrong with the id, please throw an exception! |
public
|
|
public
|
#
updateThisAndChildrensAbsolutePath( )
Iterate all chrildren of this folder recursivly and update the absolute pathes. Use this function with caution because it can be time intensive. |
public
|
|
public
|
|
public
|
|
public
|
#
getTypeName( string $default = null )
Get the type name for this folder. For example: Folder, Collection, Gallery, Unorganized. |
public
|
|
public
|
|
public
|
|
public
|
#
isValidName( string $name )
Checks, if a given folder name is valid. The name is also santisized so there can be no problem for physical moves for example. |
public static
|
Methods inherited from MatthiasWeb\RealMediaLibrary\folder\BaseFolder
anyChildrenHas()
,
anyChildrenHasMetadata()
,
anyParentHas()
,
anyParentHasMetadata()
,
getAbsolutePath()
,
getAllParents()
,
getChildren()
,
getCnt()
,
getId()
,
getName()
,
getOrder()
,
getOwner()
,
getParent()
,
getPath()
,
getPlain()
,
getRestrictions()
,
getRestrictionsCount()
,
getSlug()
,
hasChildren()
,
is()
,
isRestrictFor()
,
isValidChildrenType()
,
setRestrictions()
Methods inherited from MatthiasWeb\RealMediaLibrary\base\Base
Methods inherited from MatthiasWeb\RealMediaLibrary\api\IFolderContent
contentDeleteOrder()
,
contentEnableOrder()
,
contentIndex()
,
contentOrder()
,
contentReindex()
,
contentRestoreOldCustomNr()
,
getAttachmentNextTo()
,
getContentAggregationNr()
,
getContentCustomOrder()
,
getContentNrOf()
,
getContentOldCustomNrCount()
,
getContentOrderNumbers()
,
isContentCustomOrderAllowed()
Methods inherited from MatthiasWeb\RealMediaLibrary\api\IFolder
Properties summary
Properties inherited from MatthiasWeb\RealMediaLibrary\folder\BaseFolder
$absolutePath
,
$children
,
$cnt
,
$contentCustomOrder
,
$id
,
$name
,
$order
,
$orderNumbers
,
$parent
,
$restrictions
,
$restrictionsCount
,
$row
,
$slug
,
$systemReservedFolders