Overview
  • Namespace
  • Class

Namespaces

  • MatthiasWeb
    • RealMediaLibrary
      • api
      • attachment
      • base
      • comp
        • complexquery
      • folder
      • general
      • metadata
      • order
      • rest
      • usersettings
  • None

Classes

  • BaseFolder
  • Collection
  • Creatable
  • CRUD
  • Folder
  • Gallery
  • Root

Class Collection

This class creates a collection object. (Type 1) See parent classes / interfaces for better documentation.

MatthiasWeb\RealMediaLibrary\base\Base
Extended by MatthiasWeb\RealMediaLibrary\folder\BaseFolder implements MatthiasWeb\RealMediaLibrary\api\IFolder
Extended by MatthiasWeb\RealMediaLibrary\folder\Creatable
Extended by MatthiasWeb\RealMediaLibrary\order\Sortable
Extended by MatthiasWeb\RealMediaLibrary\folder\Collection
Namespace: MatthiasWeb\RealMediaLibrary\folder
Located at folder/Collection.class.php

Methods summary

public true
# insert( int[] $ids, boolean $supress_validation = false, boolean $isShortcut = false )

Insert is not allowed for a collection.

Insert is not allowed for a collection.

Parameters

$ids
Array of post ids
$supress_validation
Supress the permission validation
$isShortcut
Determines, if the post's should be "copied" to the folder (no physical copy)

Returns

true

Throws

Exception

Overrides

MatthiasWeb\RealMediaLibrary\folder\Creatable::insert
public static
# create( $rowData )
public static
# instance( $rowData )
public boolean|int[]
# getAllowedChildrenTypes( )

Get all allowed children folder types.

Get all allowed children folder types.

Returns

boolean|int[]
Array with allowed types or TRUE for all types allowed
public
# getTypeName( string $default = null )

Get the type name for this folder. For example: Folder, Collection, Gallery, Unorganized.

Get the type name for this folder. For example: Folder, Collection, Gallery, Unorganized.

Parameters

$default
The default (if null "Folder" is used as default)

Since

3.3.1

See

Filter RML/Folder/Type/Name

Returns

string

Overrides

MatthiasWeb\RealMediaLibrary\folder\Creatable::getTypeName
public
# getTypeDescription( string $default = null )

Get the type description for this folder.

Get the type description for this folder.

Parameters

$default
The default (if null folder description is used as default)

Since

3.3.1

See

Filter RML/Folder/Type/Description

Returns

string

Overrides

MatthiasWeb\RealMediaLibrary\folder\Creatable::getTypeDescription
public
# getType( )

Return the type for the given folder. For example: 0 = Folder, 1 = Collection, 2 = Gallery

Return the type for the given folder. For example: 0 = Folder, 1 = Collection, 2 = Gallery

Returns

int

Methods inherited from MatthiasWeb\RealMediaLibrary\order\Sortable

__construct(), contentDeleteOrder(), contentEnableOrder(), contentIndex(), contentOrder(), contentReindex(), contentRestoreOldCustomNr(), delete_all_order(), folder_insert_anyParentHasMetadata(), folder_insert_anyParentHasMetadata_orderAutomatically(), getAttachmentNextTo(), getContentAggregationNr(), getContentCustomOrder(), getContentNrOf(), getContentOldCustomNrCount(), getContentOrderNumbers(), isContentCustomOrderAllowed(), item_move_finished(), mla_media_modal_query_final_terms(), posts_clauses()

Methods inherited from MatthiasWeb\RealMediaLibrary\folder\Creatable

addChildren(), getMaxOrder(), getRowData(), isValidName(), persist(), read(), reindexChildrens(), relocate(), setName(), setParent(), singleCheckInsert(), singleCheckInsertPermissions(), updateThisAndChildrensAbsolutePath(), xread()

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

debug(), getCore(), getTableName()

Properties summary

Properties inherited from MatthiasWeb\RealMediaLibrary\folder\BaseFolder

$absolutePath, $children, $cnt, $contentCustomOrder, $id, $name, $order, $orderNumbers, $parent, $restrictions, $restrictionsCount, $row, $slug, $systemReservedFolders

API documentation generated by ApiGen