SilverStripe\CMS\Controllers\CMSPageEditController
Synopsis
class CMSPageEditController
extends CMSMain
{
- // Inherited constants from CMSMain
- const PAGE_ICONS_ID = 'PageIcons';
- // members
- private static string $url_segment = 'pages/edit';
- private static string $url_rule = '/$Action/$ID/$OtherID';
- private static integer $url_priority = 41;
- private static string $required_permission_codes = 'CMS_ACCESS_CMSMain';
- private static array $allowed_actions = ;
- // Inherited members from CMSMain
- protected CacheInterface $hintsCache;
- // methods
- public void getClientConfig()
- public DBHTMLText|HTTPResponse addtocampaign()
- public Form AddToCampaignForm()
- public Form getAddToCampaignForm()
- // Inherited methods from CMSMain
- protected void init()
- public void index()
- public void getResponseNegotiator()
- public DBHTMLText PageList()
- public DBHTMLText PageListSidebar()
- public boolean ShowSwitchView()
- public array SwitchView()
- public string Link()
- public void LinkPages()
- public void LinkPagesWithSearch()
- public string LinkTreeView()
- public string LinkListView()
- public string LinkListViewChildren()
- public string LinkListViewRoot()
- public string LinkTreeViewDeferred()
- public string LinkListViewDeferred()
- public void LinkPageEdit()
- public void LinkPageSettings()
- public void LinkPageHistory()
- public string getTabIdentifier()
- public $this setHintsCache()
- public CacheInterface getHintsCache()
- public void clearCache()
- public void LinkWithSearch()
- public void LinkPageAdd()
- public string LinkPreview()
- public void SiteTreeAsUL()
- public string getSiteTreeFor()
- protected callable getTreeNodeCustomisations()
- public string getTreeNodeClasses()
- public string getsubtree()
- public HTTPResponse updatetreenodes()
- public HTTPResponse savetreenode()
- public bool CanOrganiseSitetree()
- public boolean TreeIsFiltered()
- public void ExtraTreeTools()
- public SearchContext getSearchContext()
- public string getSearchFieldSchema()
- public Form getSearchForm()
- protected array getPageTypes()
- public void doSearch()
- public string getBreadcrumbsBackLink()
- public ArrayList Breadcrumbs()
- public string SiteTreeHints()
- public SS_List PageTypes()
- public SiteTree getRecord()
- public Form EditForm()
- public Form getEditForm()
- public void EmptyForm()
- protected string getArchiveWarningMessage()
- protected bool collateDescendants()
- public DBHTMLText treeview()
- public DBHTMLText listview()
- public string ViewState()
- public HTTPResponse childfilter()
- protected CMSSiteTreeFilter getQueryFilter()
- public SS_List getList()
- public Form ListViewForm()
- public void currentPageID()
- public HTTPResponse save()
- public mixed|DataObject getNewItem()
- public mixed performPublish()
- public HTTPResponse revert()
- public HTTPResponse delete()
- public HTTPResponse archive()
- public void publish()
- public void unpublish()
- public HTTPResponse rollback()
- public HTTPResponse doRollback()
- public void batchactions()
- public void BatchActionParameters()
- public void BatchActionList()
- public HTTPResponse|string|void publishall()
- public HTTPResponse restore()
- public void duplicate()
- public void duplicatewithchildren()
- public void providePermissions()
- protected string getCMSTreeTitle()
- protected string generateHintsCacheKey()
- public static void flush()
- public void flushMemberCache()
Hierarchy
Tasks
Line | Task |
---|---|
1376 | Can't merge $FormAttributes in template at the moment |
1778 | Coupling to SiteTree |
Constants
Name | Value |
---|---|
PAGE_ICONS_ID | 'PageIcons' |
Members
private
- $allowed_actions
- $required_permission_codes
- $url_priority
- $url_rule
- $url_segment
protected
- $hintsCache — Psr\SimpleCache\CacheInterface
Methods
public
- AddToCampaignForm() — Url handler for add to campaign form
- addtocampaign() — Action handler for adding pages to a campaign
- getAddToCampaignForm()
- getClientConfig()
Inherited from SilverStripe\CMS\Controllers\CMSMain
protected
- collateDescendants() — Find IDs of all descendant pages for the provided ID lists.
- generateHintsCacheKey() — Cache key for SiteTreeHints() method
- getArchiveWarningMessage() — Build an archive warning message based on the page's children
- getCMSTreeTitle() — Get title for root CMS node
- getPageTypes() — Returns a sorted array suitable for a dropdown with pagetypes and their translated name
- getQueryFilter() — Safely reconstruct a selected filter from a given set of query parameters
- getTreeNodeCustomisations() — Get callback to determine template customisations for nodes
- init()
public
- BatchActionList() — Returns a list of batch actions
- BatchActionParameters()
- Breadcrumbs()
- CanOrganiseSitetree() — Whether the current member has the permission to reorganise SiteTree objects.
- EditForm() — {@inheritdoc}
- EmptyForm()
- ExtraTreeTools()
- Link() — Override {@link LeftAndMain} Link to allow blank URL segment for CMSMain.
- LinkListView() — Get link to list view
- LinkListViewChildren() — Link to list view for children of a parent page
- LinkListViewDeferred() — Link to lazy-load deferred list view
- LinkListViewRoot()
- LinkPageAdd()
- LinkPageEdit()
- LinkPageHistory()
- LinkPageSettings()
- LinkPages()
- LinkPagesWithSearch()
- LinkPreview()
- LinkTreeView() — Get link to tree view
- LinkTreeViewDeferred() — Link to lazy-load deferred tree view
- LinkWithSearch()
- ListViewForm()
- PageList() — Get pages listing area
- PageListSidebar() — Page list view for edit-form
- PageTypes() — Populates an array of classes in the CMS which allows the user to change the page type.
- ShowSwitchView() — If this is set to true, the "switchView" context in the template is shown, with links to the staging and publish site.
- SiteTreeAsUL() — Return the entire site tree as a nested set of ULs
- SiteTreeHints() — Create serialized JSON string with site tree hints data to be injected into 'data-hints' attribute of root node of jsTree.
- SwitchView() — Overloads the LeftAndMain::ShowView. Allows to pass a page as a parameter, so we are able to switch view also for archived versions.
- TreeIsFiltered()
- ViewState() — Get view state based on the current action
- archive() — Delete this page from both live and stage
- batchactions() — Batch Actions Handler
- childfilter() — Callback to request the list of page types allowed under a given page instance.
- clearCache() — Clears all dependent cache backends
- currentPageID()
- delete() — Delete the current page from draft stage.
- doRollback() — Rolls a site back to a given version ID
- doSearch()
- duplicate()
- duplicatewithchildren()
- flush() — Clear the cache on ?flush
- flushMemberCache() — Flush the hints cache for a specific member
- getBreadcrumbsBackLink() — Get "back" url for breadcrumbs
- getEditForm()
- getHintsCache()
- getList() — Returns the pages meet a certain criteria as {@see CMSSiteTreeFilter} or the subpages of a parent page defaulting to no filter and show all pages in first level.
- getNewItem()
- getRecord() — Get a database record to be managed by the CMS.
- getResponseNegotiator()
- getSearchContext() — This provides information required to generate the search form and can be modified on extensions through updateSearchContext
- getSearchFieldSchema() — Returns the search form schema for the current model
- getSearchForm() — Returns a Form for page searching for use in templates.
- getSiteTreeFor() — Get a site tree HTML listing which displays the nodes under the given criteria.
- getTabIdentifier() — Return the active tab identifier for the CMS. Used by templates to decide which tab to give the active state.
- getTreeNodeClasses() — Get extra CSS classes for a page's tree node
- getsubtree() — Get a subtree underneath the request param 'ID'.
- index()
- listview() — Returns deferred listview for the current level
- performPublish() — Actually perform the publication step
- providePermissions()
- publish()
- publishall()
- restore() — Restore a completely deleted page from the SiteTree_versions table.
- revert() — Reverts a page by publishing it to live.
- rollback()
- save() — Save and Publish page handler
- savetreenode() — Update the position and parent of a tree node.
- setHintsCache()
- treeview() — This method exclusively handles deferred ajax requests to render the pages tree deferred handler (no pjax-fragment)
- unpublish()
- updatetreenodes() — Allows requesting a view update on specific tree nodes.