Overview
  • Namespace
  • Class

Namespaces

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

Classes

  • CountCache
  • CustomField
  • Filter
  • Permissions
  • Shortcut
  • Structure
  • Upload

Class Structure

This class handles all hooks and functions for the structur. If something will print out, this is a fasade-wrapper function for the class general\View (stored in private $view).

MatthiasWeb\RealMediaLibrary\base\Base
Extended by MatthiasWeb\RealMediaLibrary\attachment\Structure implements MatthiasWeb\RealMediaLibrary\api\IStructure
Namespace: MatthiasWeb\RealMediaLibrary\attachment
Located at attachment/Structure.class.php

Methods summary

public
# __construct( integer $root = null, array $data = null )

Start reading a structure. If you pass a $root parameter the parameter is not automatically respected. You should then use your own implementation or filters to respect the root. Use this constructor to add your filters and respect your custom Structure class implementation.

Start reading a structure. If you pass a $root parameter the parameter is not automatically respected. You should then use your own implementation or filters to respect the root. Use this constructor to add your filters and respect your custom Structure class implementation.

Parameters

$root
The root folder defined for the structure
$data
Custom data for the structure

Implementation of

MatthiasWeb\RealMediaLibrary\api\IStructure::__construct()
public
# initialLoad( )

Checks, if the SQL result is available and load it if not.

Checks, if the SQL result is available and load it if not.

Implementation of

MatthiasWeb\RealMediaLibrary\api\IStructure::initialLoad()
public
# resetData( integer $root = null, boolean $fetchData = true )

Resets the data of the structure.

Resets the data of the structure.

Parameters

$root
The root folder
$fetchData
Determine, if the data should be refetched

See

wp_rml_structure_reset()

Implementation of

MatthiasWeb\RealMediaLibrary\api\IStructure::resetData()
public
# byId( $id, $nullForRoot = true )

Implementation of

MatthiasWeb\RealMediaLibrary\api\IStructure::byId()
public
# byAbsolutePath( $path )

Implementation of

MatthiasWeb\RealMediaLibrary\api\IStructure::byAbsolutePath()
public
# getRows( )

Get the SQL query result instead of IFolder objects.

Get the SQL query result instead of IFolder objects.

Returns

object[] The SQL result

Implementation of

MatthiasWeb\RealMediaLibrary\api\IStructure::getRows()
public
# getParsed( )

Get all SQL query results as IFolder objects.

Get all SQL query results as IFolder objects.

Returns

IFolder[] The folders

Implementation of

MatthiasWeb\RealMediaLibrary\api\IStructure::getParsed()
public IFolder[]
# getTree( )

Get all SQL query results placed to a tree. That means it is a "hierarchical" result where you work with ->getChildren(). The first level contains the top folders.

Get all SQL query results placed to a tree. That means it is a "hierarchical" result where you work with ->getChildren(). The first level contains the top folders.

Returns

IFolder[]
The folders

Implementation of

MatthiasWeb\RealMediaLibrary\api\IStructure::getTree()
public object[]
# getPlainTree( )

Get all SQL query results placed to a tree. It is fully resolved with all hierarchical plain objects of the folders.

Get all SQL query results placed to a tree. It is fully resolved with all hierarchical plain objects of the folders.

Returns

object[]

Implementation of

MatthiasWeb\RealMediaLibrary\api\IStructure::getPlainTree()
public
# getCntAttachments( )

Get the attachment count for this structure.

Get the attachment count for this structure.

Returns

integer Count

Implementation of

MatthiasWeb\RealMediaLibrary\api\IStructure::getCntAttachments()
public
# getFolderCounts( )

Get all folder counts.

Get all folder counts.

Returns

Array<string|int,int>
public
# getCntRoot( )

Get the attachment count for the "/ Unorganized" folder for this structure.

Get the attachment count for the "/ Unorganized" folder for this structure.

Returns

integer Count

Implementation of

MatthiasWeb\RealMediaLibrary\api\IStructure::getCntRoot()
public
# getView( )

Get the view class instance.

Get the view class instance.

public
# getData( )

Get the custom data.

Get the custom data.

Returns

array Data

Implementation of

MatthiasWeb\RealMediaLibrary\api\IStructure::getData()
public
# setData( array $data )

Set the custom data.

Set the custom data.

Parameters

$data
The custom data

Implementation of

MatthiasWeb\RealMediaLibrary\api\IStructure::setData()
public static
# getInstance( )

Methods inherited from MatthiasWeb\RealMediaLibrary\base\Base

debug(), getCore(), getTableName()

API documentation generated by ApiGen