SilverWare\ModelFilters\Filters\ModifiedFilter
A filter implementation that shows records which have been modified on draft.
- Author: Colin Tucker <colin@praxis.net.au>
- Copyright: 2017 Praxis Interactive
- License: https://opensource.org/licenses/BSD-3-Clause BSD-3-Clause
Synopsis
class ModifiedFilter
extends Filter
{
- // methods
- public string getTitle()
- public DataList apply()
- protected string getLeftJoinClause()
- protected string getWhereClause()
- // Inherited methods from Filter
- public $this setList()
- public DataList getList()
- public $this setParams()
- public array getParams()
- public void __construct()
- public abstract string getTitle()
- public abstract DataList apply()
- protected DataList getRecordsByStage()
- protected DataList getDraftRecords()
- protected array getDraftIds()
- protected DataList getLiveRecords()
- protected array getLiveIds()
- protected array getStagedIds()
- protected DataList getRecordsIncludingArchived()
- protected string getBaseTable()
- protected string getLiveTable()
- protected DataObject getDataObject()
Hierarchy
Members
protected
- $list
—
SilverStripe\ORM\DataList
The source data list to be filtered by this object. - $params
—
array
Array of filter parameters obtained from the HTTP request.
Methods
protected
- getLeftJoinClause() — Answers the LEFT JOIN clause for the filter query.
- getWhereClause() — Answers the WHERE clause for the filter query.
public
- apply() — Applies the filter to the data list and answers the result.
- getTitle() — Answers the title of the filter.
Inherited from SilverWare\ModelFilters\Model\Filter
protected
- getBaseTable() — Answers the base table for the data object queried by the source data list.
- getDataObject() — Answers a singleton instance of the data object queried by the source data list.
- getDraftIds() — Answers an array of record IDs that exist in the draft stage.
- getDraftRecords() — Answers records that exist in the draft stage.
- getLiveIds() — Answers an array of record IDs that exist in the live stage.
- getLiveRecords() — Answers records that exist in the live stage.
- getLiveTable() — Answers the live table for the data object queried by the source data list.
- getRecordsByStage() — Answers only those records that exist in the specified stage.
- getRecordsIncludingArchived() — Answers records that exist in the source data list, including archived records.
- getStagedIds() — Answers an array of record IDs that exist in both draft and live stages.
public
- apply() — Applies the filter to the data list and answers the result.
- getList() — Answers the value of the list attribute.
- getParams() — Answers the value of the params attribute.
- getTitle() — Answers the title of the filter.
- setList() — Defines the value of the list attribute.
- setParams() — Defines the value of the params attribute.