DeletedRecords
Model class for the 'recycler' extension.
This class is a specific domain model implementation and is not part of the Public TYPO3 API.
Table of Contents
Properties
- $label : array<string|int, mixed>
- Array with all label fields from different tables
- $title : array<string|int, mixed>
- Array with all title fields from different tables
- $deletedRows : array<string|int, mixed>
- Array with all deleted rows
- $limit : string
- String with the global limit
- $recyclerHelper : RecyclerUtility
- Object from helper class
- $table : array<string|int, mixed>
- Array with all available FE tables
Methods
- deleteData() : bool
- Delete element from any table
- getDeletedRows() : array<string|int, mixed>
- Get deleted Rows
- getTable() : array<string|int, mixed>
- Get table
- getTotalCount() : int
- Find the total count of deleted records
- loadData() : DeletedRecords
- Load all deleted rows from $table If table is not set, it iterates the TCA tables
- setDeletedRows() : mixed
- Set deleted rows
- undeleteData() : bool|int
- Undelete records If $recursive is TRUE all records below the page uid would be undelete too
- checkRecordAccess() : mixed
- Checks whether the current backend user has access to the given records.
- getBackendUser() : BackendUserAuthentication
- Returns the BackendUser
- getCache() : FrontendInterface
- Gets an instance of the memory cache.
- getDeletedParentPages() : array<string|int, mixed>
- Returns deleted parent pages
- getFilteredQueryBuilder() : QueryBuilder
- Helper method for setData() to create a QueryBuilder that filters the records by default.
- getTreeList() : array<string|int, mixed>
- Get tree list
- resolveTree() : array<string|int, mixed>
- setData() : mixed
- Set all deleted rows
Properties
$label
Array with all label fields from different tables
public
array<string|int, mixed>
$label
$title
Array with all title fields from different tables
public
array<string|int, mixed>
$title
$deletedRows
Array with all deleted rows
protected
array<string|int, mixed>
$deletedRows
= []
$limit
String with the global limit
protected
string
$limit
= ''
$recyclerHelper
Object from helper class
protected
RecyclerUtility
$recyclerHelper
$table
Array with all available FE tables
protected
array<string|int, mixed>
$table
= []
Methods
deleteData()
Delete element from any table
public
deleteData(array<string|int, mixed>|null $recordsArray) : bool
Parameters
- $recordsArray : array<string|int, mixed>|null
-
Representation of the records
Return values
boolgetDeletedRows()
Get deleted Rows
public
getDeletedRows() : array<string|int, mixed>
Return values
array<string|int, mixed> —Array with all deleted rows from TCA
getTable()
Get table
public
getTable() : array<string|int, mixed>
Return values
array<string|int, mixed> —Array with table from TCA
getTotalCount()
Find the total count of deleted records
public
getTotalCount(int $id, string $table, int $depth, string $filter) : int
Parameters
- $id : int
-
UID from record
- $table : string
-
Tablename from record
- $depth : int
-
How many levels recursive
- $filter : string
-
Filter text
Return values
intloadData()
Load all deleted rows from $table If table is not set, it iterates the TCA tables
public
loadData(int $id, string $table, int $depth[, string $limit = '' ][, string $filter = '' ]) : DeletedRecords
Parameters
- $id : int
-
UID from selected page
- $table : string
-
Tablename
- $depth : int
-
How many levels recursive
- $limit : string = ''
-
MySQL LIMIT
- $filter : string = ''
-
Filter text
Return values
DeletedRecordssetDeletedRows()
Set deleted rows
public
setDeletedRows(string $table, array<string|int, mixed> $row) : mixed
Parameters
- $table : string
-
Tablename
- $row : array<string|int, mixed>
-
Deleted record row
undeleteData()
Undelete records If $recursive is TRUE all records below the page uid would be undelete too
public
undeleteData(array<string|int, mixed> $recordsArray[, bool $recursive = false ]) : bool|int
Parameters
- $recordsArray : array<string|int, mixed>
-
Representation of the records
- $recursive : bool = false
-
Whether to recursively undelete
Return values
bool|intcheckRecordAccess()
Checks whether the current backend user has access to the given records.
protected
checkRecordAccess(string $table, array<string|int, mixed> $rows) : mixed
Parameters
- $table : string
-
Name of the table
- $rows : array<string|int, mixed>
-
Record row
getBackendUser()
Returns the BackendUser
protected
getBackendUser() : BackendUserAuthentication
Return values
BackendUserAuthenticationgetCache()
Gets an instance of the memory cache.
protected
getCache() : FrontendInterface
Return values
FrontendInterfacegetDeletedParentPages()
Returns deleted parent pages
protected
getDeletedParentPages(int $uid[, array<string|int, mixed> &$pages = [] ]) : array<string|int, mixed>
Parameters
- $uid : int
- $pages : array<string|int, mixed> = []
Return values
array<string|int, mixed>getFilteredQueryBuilder()
Helper method for setData() to create a QueryBuilder that filters the records by default.
protected
getFilteredQueryBuilder(string $table, int $pid, int $depth, string $filter) : QueryBuilder
Parameters
- $table : string
- $pid : int
- $depth : int
- $filter : string
Return values
QueryBuildergetTreeList()
Get tree list
protected
getTreeList(int $id, int $depth[, int $begin = 0 ]) : array<string|int, mixed>
Parameters
- $id : int
- $depth : int
- $begin : int = 0
Return values
array<string|int, mixed>resolveTree()
protected
resolveTree(int $id, int $depth[, int $begin = 0 ][, string $permsClause = '' ]) : array<string|int, mixed>
Parameters
- $id : int
- $depth : int
- $begin : int = 0
- $permsClause : string = ''
Return values
array<string|int, mixed>setData()
Set all deleted rows
protected
setData(int $id, string $table, int $depth, string $filter) : mixed
Parameters
- $id : int
-
UID from record
- $table : string
-
Tablename from record
- $depth : int
-
How many levels recursive
- $filter : string
-
Filter text