Overview
  • Namespace
  • Class

Namespaces

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

Classes

  • Attachment
  • Folder
  • Reset
  • Service

Class Folder

Enables the /folders REST for all creatable items.

MatthiasWeb\RealMediaLibrary\base\Base
Extended by MatthiasWeb\RealMediaLibrary\rest\Folder
Namespace: MatthiasWeb\RealMediaLibrary\rest
Located at rest/Folder.class.php

Methods summary

public
# rest_api_init( )

Register endpoints.

Register endpoints.

public
# getContentCounts( $request )

Api

{get} /realmedialibrary/v1/folders/content/counts Get all folder counts

Apigroup

Folder

Apiname

GetFolderContentCounts

Apiversion

1.0.0
public
# getContentSortables( $request )

Api

{get} /realmedialibrary/v1/folders/content/sortable Get the available sortables

Apigroup

Folder

Apiname

GetFolderContentSortables

Apiversion

1.0.0
public
# applyContentSortables( $request )

Api

{post} /realmedialibrary/v1/folders/content/sortable Set a folders content order

Apigroup

Folder

Apiname

ApplyFolderContentSorting

Apiparam

{string} id The sortable id. Pass "original" to reset the folder, pass "deactivate" to deactive the automatic order, pass "reindex" to reindex the order indexes, pass "last" to try to to reset to the last available order


{int} applyTo The folder id
{boolean} [automatically] Automatically use this order when new files are added to the folder

Apiversion

1.0.0
public
# createItem( $request )

Api

{post} /realmedialibrary/v1/folders Create a new folder

Apigroup

Folder

Apiname

DeleteFolder

Apiparam

{string} name The new name for the folder
{int} parent The parent
{string} type The folder type

Apiversion

1.0.0
public
# deleteItem( $request )

Api

{delete} /realmedialibrary/v1/folders/:id Delete a folder by id

Apigroup

Folder

Apiname

DeleteFolder

Apiversion

1.0.0
public
# getMetaHTML( $request )

Api

{get} /realmedialibrary/v1/folders/:id/meta Get the HTML meta content

Apigroup

Folder

Apiname

GetFolderMeta

Apiversion

1.0.0
public
# updateMeta( $request )

Api

{put} /realmedialibrary/v1/folders/:id/meta Update meta of a folder

Apidescription

Send a key value map of form data so Meta implementations (IMetadata) can handle it

Apigroup

Folder

Apiname

UpdateFolderMeta

Apiversion

1.0.0
public
# updateItem( $request )

Api

{put} /realmedialibrary/v1/folders/:id Update a folder by id

Apigroup

Folder

Apiname

UpdateFolder

Apiparam

{string} name The new name for the folder

Apiversion

1.0.0

Methods inherited from MatthiasWeb\RealMediaLibrary\base\Base

debug(), getCore(), getTableName()

API documentation generated by ApiGen