BEdita API doc | 4-cactus
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Download

Namespaces

  • BEdita
    • API
      • Auth
      • Controller
        • Admin
        • Component
        • Model
      • Error
      • Event
      • Exception
      • Middleware
      • Model
        • Action
      • Network
        • Exception
      • Shell
      • TestSuite
      • Utility
    • Core
      • Configure
        • Engine
      • Database
        • Type
      • Exception
      • Filesystem
        • Adapter
        • Exception
        • Thumbnail
      • I18n
      • Job
        • Service
      • Mailer
        • Preview
        • Transport
      • Model
        • Action
        • Behavior
        • Entity
        • Table
        • Validation
      • ORM
        • Inheritance
        • Locator
        • Rule
      • Shell
        • Task
      • State
      • TestSuite
        • Fixture
      • Utility

Classes

  • AnnotationsController
  • ConfigController
  • HistoryController
  • RolesController
  • SignupController
  • StatusController
  • TranslationsController
  • TrashController
  • UploadController
  • UsersController

Class TrashController

Controller for /trash endpoint.

BEdita\API\Controller\AppController
Extended by BEdita\API\Controller\TrashController
Namespace: BEdita\API\Controller
Since: 4.0.0
Located at API/src/Controller/TrashController.php

Methods summary

public
# initialize( )
public
# index( )

Paginated objects list.

Paginated objects list.

public
# view( integer $id )

Get single object data from trashcan.

Get single object data from trashcan.

Parameters

$id
Object ID.
public Cake\Http\Response
# restore( integer $id )

Restore object, remove from trashcan

Restore object, remove from trashcan

Parameters

$id
Object ID.

Returns

Cake\Http\Response

Throws

Cake\Http\Exception\ConflictException

Throws an exception if object ID in the payload doesn't match the object ID in the URL.


Cake\Http\Exception\InternalErrorException
Throws an exception if an error occurs during restore.
public Cake\Http\Response
# delete( integer $id )

Delete object permanently, remove from trashcan

Delete object permanently, remove from trashcan

Parameters

$id
Object ID.

Returns

Cake\Http\Response

Throws

Cake\ORM\Exception\PersistenceFailedException
Throws an exception if an error occurs during deletion.

Properties summary

public string $modelClass
# 'Objects'
protected Cake\ORM\Table $Table

Table.

Table.

#

Magic properties

public BEdita\Core\Model\Table\ObjectsTable $Objects
BEdita API doc | 4-cactus API documentation generated by ApiGen