SproutCMS

class PageAdminController

Handles admin processing for pages

• File: /sprout/Controllers/Admin/PageAdminController.php
• Namespace: Sprout\Controllers\Admin
• Extends: TreeAdminController

Extending this class

<?php
/**
* New class description goes here
* 
* @author Your Name, 2026-09-15
**/
class NewClassName extends PageAdminController {
    
    /**
    * Return JSON list of custom widget templates as defined by skin config
    * AJAX called
    **/
    public function ajaxListWidgetTemplates () {
        // Method code goes here
    }
    
    public function preview ($item_id) {
        // Method code goes here
    }
    
    /**
    * Forces a clear of the pagecache
    **/
    public function clearNavigationCache () {
        // Method code goes here
    }
    
    /**
    * Cron version of the link checker
    **/
    public function cronLinkChecker () {
        // Method code goes here
    }
    
    /**
    * Check for stale page content and send emails regarding stale pages; to be run via cron
    **/
    public function cronCheckStale () {
        // Method code goes here
    }
    
    /**
    * List of pages which need approval
    **/
    public function _extraNeedApproval () {
        // Method code goes here
    }
    
    /**
    * Tells the user the link checker is running
    **/
    public function _extraLinkCheckerInfo ($id) {
        // Method code goes here
    }
    
    /**
    * Starts the link checker
    **/
    public function linkCheckerAction () {
        // Method code goes here
    }
    
    /**
    * Starts the link checker
    **/
    public function _extraLinkChecker () {
        // Method code goes here
    }
    
    /**
    * Returns the children pages for a specific page, in a format required by jqueryFileTree.
    * Uses the POST param 'dir', and is usually run through an AJAX call.
    **/
    public function filetreeOpen () {
        // Method code goes here
    }
    
    /**
    * Saves in the session data the currently open pages in the pages tree (navigation pane)
    * Uses the POST param 'pages', and is usually run through an AJAX call.
    **/
    public function filetreeClose () {
        // Method code goes here
    }
    
    /**
    * Shows the reorder screen (which is shown in a popup box) for re-ordering the top-level stuff
    * This custom version adds subsite support
    **/
    public function reorderTop () {
        // Method code goes here
    }
    
    /**
    * Returns the tools to show in the left navigation
    **/
    public function _getTools () {
        // Method code goes here
    }
    
    /**
    * Activates AutoLaunch revisions
    **/
    public function cronPageActivate () {
        // Method code goes here
    }
    
    /**
    * Deactivates pages after set date
    **/
    public function cronPageDeactivate () {
        // Method code goes here
    }
    
    /**
    * If the specified item needs a record number to be set,
    * Puts this item at the end of the list.
    * 
    * This custom version adds subsite support
    **/
    protected function fixRecordOrder (int $item_id) {
        // Method code goes here
    }
    
    /**
    * Returns the contents of the navigation pane for the tree
    **/
    public function _getNavigation () {
        // Method code goes here
    }
    
    public function _getCustomAddSaveHTML () {
        // Method code goes here
    }
    
    /**
    * Return the sub-actions for adding; for spec {@see AdminController::renderSubActions}
    **/
    public function _getAddSubActions () {
        // Method code goes here
    }
    
    /**
    * Returns the add form for adding a page
    **/
    public function _getAddForm () {
        // Method code goes here
    }
    
    /**
    * Saves the provided POST data into a new page in the database
    **/
    public function _addSave (int $page_id) {
        // Method code goes here
    }
    
    /**
    * Return HTML for the import upload form
    **/
    public function _importUploadForm () {
        // Method code goes here
    }
    
    /**
    * Upload and do initial processing on the file
    **/
    public function importUploadAction () {
        // Method code goes here
    }
    
    /**
    * Preview the pages which will be created
    **/
    public function importPreviewAjax () {
        // Method code goes here
    }
    
    /**
    * Render a single node for the preview tree we return in `import_preview_ajax`
    **/
    private function renderPreviewTreenode ($node) {
        // Method code goes here
    }
    
    /**
    * Returns a form which contains options for doing an import
    **/
    public function _getImport ($filename) {
        // Method code goes here
    }
    
    /**
    * Facebox info box
    **/
    public function importNotes ($view_name) {
        // Method code goes here
    }
    
    /**
    * Does the actual import
    **/
    public function _importData (string $filename) {
        // Method code goes here
    }
    
    /**
    * Create a page
    **/
    private function createPageTreenode ($node, $parent_id, $images, $headings, $operator) {
        // Method code goes here
    }
    
    public function _getCustomEditSaveHTML ($item_id) {
        // Method code goes here
    }
    
    /**
    * Return the URL to use for the 'view live site' button, when editing a given record
    **/
    public function _getEditLiveUrl (int $item_id) {
        // Method code goes here
    }
    
    /**
    * Returns the edit form for editing the specified page
    **/
    public function _getEditForm (int $id) {
        // Method code goes here
    }
    
    /**
    * Gets the text of a single revision
    **/
    public function ajaxGetRev (int $id) {
        // Method code goes here
    }
    
    /**
    * Return a list of menu groups for a selected parent page
    **/
    public function ajaxGetMenuGroups ($parent_page_id) {
        // Method code goes here
    }
    
    /**
    * Makes the provided html text be in a standard format to ensure the integrity of the change check
    **/
    private function convertForChangeCheck ($text) {
        // Method code goes here
    }
    
    /**
    * Saves the provided POST data into this page in the database
    **/
    public function _editSave (int $page_id) {
        // Method code goes here
    }
    
    /**
    * Page organisation tool
    * Bulk renaming, reordering and reparenting
    **/
    public function _extraOrganise () {
        // Method code goes here
    }
    
    /**
    * Does a complete re-index of all pages
    **/
    public function reindexAll () {
        // Method code goes here
    }
    
    /**
    * Shows the links (incoming and outgoing) for a page
    **/
    public function _extraLinks ($id) {
        // Method code goes here
    }
    
    /**
    * Returns the intro HTML for this controller.
    * Looks for a view named &quot;admin/&lt;controller-name&gt;_intro&quot;, and loads it if found.
    * Otherwise, loads the view, &quot;admin/generic_intro&quot;.
    **/
    public function _intro () {
        // Method code goes here
    }
    
    /**
    * Validate given controller implements FrontEndEntrance
    **/
    private function checkControllerEntrance (string $controller, int $page_id) {
        // Method code goes here
    }
    
    /**
    * Does a re-index for a page
    **/
    private function reindexItem ($item_id, $name, $text) {
        // Method code goes here
    }
    
    /**
    * Does custom actions before _deleteSave method is called, e.g. extra security checks
    **/
    public function _deletePreSave (int $item_id) {
        // Method code goes here
    }
    
    /**
    * Does custom actions after the _deleteSave method is called, e.g. clearing cache data
    **/
    public function _deletePostSave (int $item_id) {
        // Method code goes here
    }
    
    /**
    * Returns the edit form for editing the specified page
    **/
    public function _getDeleteForm (int $id) {
        // Method code goes here
    }
    
    /**
    * Save the menu groups
    **/
    public function menuGroupsAction () {
        // Method code goes here
    }
    
    /**
    * Adds a history item for a page
    **/
    private function addHistoryItem ($page_id, $changes_made, $editor) {
        // Method code goes here
    }
    
    /**
    * Return the WHERE clause to use for a given key which is provided by the RefineBar
    * 
    * Allows custom non-table clauses to be added.
    * Is only called for key names which begin with an underscore.
    * The base table is aliased to 'item'.
    **/
    protected function _getRefineClause (string $key, string $val, array $query_params) {
        // Method code goes here
    }
    
    /**
    * Page organisation tool
    * Bulk renaming, reordering and reparenting
    **/
    public function _extraMenuGroups () {
        // Method code goes here
    }
    
    /**
    * This is called after every add, edit and delete, as well as other (i.e. bulk) actions.
    * Use it to clear any frontend caches. The default is an empty method.
    **/
    public function _invalidateCaches (string $action, int $item_id) {
        // Method code goes here
    }
    
    /**
    * Constructor
    **/
    public function __construct () {
        // Method code goes here
    }
    
}
?>