Fromholdio\Listings\Extensions\ListingsRootPageExtension
Synopsis
class ListingsRootPageExtension
extends ListingsSiteTreeExtension
{
- // constants
- const ADMIN_MODE_CMS_TREE = 'cmstree';
- const ADMIN_MODE_GRIDFIELD = 'gridfield';
- const ADMIN_MODE_ADMIN = 'admin';
- // members
- protected $excludedSiteTreeClassNames;
- private static boolean $allowed_children_listed_pages_only = true;
- private static string|false $listed_pages_orderable_sort = 'Sort';
- private static string $administration_mode = 'cmstree';
- // Inherited members from ListingsSiteTreeExtension
- protected $listedPagesCommonClass;
- protected $listedPagesCommonSingularName;
- protected $listedPagesCommonPluralName;
- // methods
- public static void add_to_class()
- public void getListedPagesParentIDs()
- public void updateCMSFields()
- public void getListedPagesAddNewMultiClasses()
- public string|false getListedPagesOrderableSort()
- public void getListedPagesTabName()
- public string getAdministrationMode()
- public null; updateAllowedChildren()
- public void getExcludedSiteTreeClassNames()
- public void augmentAllChildrenIncludingDeleted()
- protected void shouldFilter()
- // Inherited methods from ListingsSiteTreeExtension
- public void getListedPages()
- public array getListedPagesClasses()
- public void getListedPagesParentIDs()
- public void getListedPagesCommonClass()
- public void getListedPagesCommonSingularName()
- public void getListedPagesCommonPluralName()
Hierarchy
Tasks
Line | Task |
---|---|
305 | might need to flip these or end up with multiple for same class? |
Constants
Name | Value |
---|---|
ADMIN_MODE_CMS_TREE | 'cmstree' |
ADMIN_MODE_GRIDFIELD | 'gridfield' |
ADMIN_MODE_ADMIN | 'admin' |
Members
private
- $administration_mode
—
string
You must identify how you wish to manage the Listed Pages under this Listed Pages Root. Valid values are: - $allowed_children_listed_pages_only
- $listed_pages_orderable_sort
—
Fromholdio\Listings\Extensions\string|false
Set the sort field we should use for powering the GridFieldOrderableRows component.
protected
- $excludedSiteTreeClassNames
- $listedPagesCommonClass
- $listedPagesCommonPluralName
- $listedPagesCommonSingularName
Methods
protected
public
- add_to_class()
- augmentAllChildrenIncludingDeleted()
- getAdministrationMode() — Validate and return administration mode, identifying how this Listed Pages Root manages its Listed Pages
- getExcludedSiteTreeClassNames()
- getListedPagesAddNewMultiClasses()
- getListedPagesOrderableSort() — Get the sort field we should use for powering the GridFieldOrderableRows component.
- getListedPagesParentIDs()
- getListedPagesTabName()
- updateAllowedChildren() — If only Listed Pages are allowed to be children of this Listed Pages Root, update $allowed_children to reflect this.
- updateCMSFields()
Inherited from Fromholdio\Listings\Extensions\ListingsSiteTreeExtension
public
- getListedPages()
- getListedPagesClasses() — Get list of SiteTree classes configured as Listed Pages for this Listed Pages Root.
- getListedPagesCommonClass()
- getListedPagesCommonPluralName()
- getListedPagesCommonSingularName()
- getListedPagesParentIDs()