Handles admin processing for pages
Generated: Tuesday, 15th September, 2026 at 10:26 am
This is the code documentation for the SproutCMS project
Search documentation |
class PageAdminControllerHandles admin processing for pages
Variables
Functions
public __constructvoid $PageAdminController->__construct ( ); Constructor public _addSaveunknown $PageAdminController->_addSave ( int &$page_id ); Saves the provided POST data into a new page in the database public _deletePostSavevoid $PageAdminController->_deletePostSave ( int $item_id ); Does custom actions after the _deleteSave method is called, e.g. clearing cache data public _deletePreSavevoid $PageAdminController->_deletePreSave ( int $item_id ); Does custom actions before _deleteSave method is called, e.g. extra security checks public _editSaveunknown $PageAdminController->_editSave ( int $page_id ); Saves the provided POST data into this page in the database public _extraLinkCheckerunknown $PageAdminController->_extraLinkChecker ( ); Starts the link checker public _extraLinkCheckerInfounknown $PageAdminController->_extraLinkCheckerInfo ( mixed $id ); Tells the user the link checker is running public _extraLinksunknown $PageAdminController->_extraLinks ( mixed $id ); Shows the links (incoming and outgoing) for a page public _extraMenuGroupsunknown $PageAdminController->_extraMenuGroups ( ); Page organisation tool Bulk renaming, reordering and reparenting public _extraNeedApprovalunknown $PageAdminController->_extraNeedApproval ( ); List of pages which need approval public _extraOrganiseunknown $PageAdminController->_extraOrganise ( ); Page organisation tool Bulk renaming, reordering and reparenting public _getAddFormstring $PageAdminController->_getAddForm ( ); Returns the add form for adding a page public _getAddSubActionsarray $PageAdminController->_getAddSubActions ( ); Return the sub-actions for adding; for spec AdminController::renderSubActions public _getCustomAddSaveHTMLunknown $PageAdminController->_getCustomAddSaveHTML ( ); This function does not have a description public _getCustomEditSaveHTMLunknown $PageAdminController->_getCustomEditSaveHTML ( mixed $item_id ); This function does not have a description public _getDeleteFormstring $PageAdminController->_getDeleteForm ( int $id ); Returns the edit form for editing the specified page public _getEditFormstring $PageAdminController->_getEditForm ( int $id ); Returns the edit form for editing the specified page public _getEditLiveUrlnull|string $PageAdminController->_getEditLiveUrl ( int $item_id ); Return the URL to use for the 'view live site' button, when editing a given record public _getImportunknown $PageAdminController->_getImport ( mixed $filename ); Returns a form which contains options for doing an import public _getNavigationunknown $PageAdminController->_getNavigation ( ); Returns the contents of the navigation pane for the tree protected _getRefineClausestring $PageAdminController->_getRefineClause ( string $key , string $val , array &$query_params ); 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'. public _getToolsunknown $PageAdminController->_getTools ( ); Returns the tools to show in the left navigation public _importDataunknown $PageAdminController->_importData ( string $filename ); Does the actual import public _importUploadFormunknown $PageAdminController->_importUploadForm ( ); Return HTML for the import upload form public _introunknown $PageAdminController->_intro ( ); Returns the intro HTML for this controller. Looks for a view named "admin/<controller-name>_intro", and loads it if found. Otherwise, loads the view, "admin/generic_intro". public _invalidateCachesvoid $PageAdminController->_invalidateCaches ( string $action [, int $item_id ] ); 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. private addHistoryItemunknown $PageAdminController->addHistoryItem ( mixed $page_id , mixed $changes_made [, mixed $editor ] ); Adds a history item for a page public ajaxGetMenuGroupsvoid $PageAdminController->ajaxGetMenuGroups ( mixed $parent_page_id ); Return a list of menu groups for a selected parent page public ajaxGetRevvoid $PageAdminController->ajaxGetRev ( int $id ); Gets the text of a single revision public ajaxListWidgetTemplatesvoid $PageAdminController->ajaxListWidgetTemplates ( ); Return JSON list of custom widget templates as defined by skin config AJAX called private checkControllerEntrancebool PageAdminController::checkControllerEntrance ( string $controller , int $page_id ); Validate given controller implements FrontEndEntrance public clearNavigationCachevoid $PageAdminController->clearNavigationCache ( ); Forces a clear of the pagecache private convertForChangeCheckunknown $PageAdminController->convertForChangeCheck ( mixed $text ); Makes the provided html text be in a standard format to ensure the integrity of the change check private createPageTreenodeunknown $PageAdminController->createPageTreenode ( mixed $node , mixed $parent_id , mixed $images , mixed $headings , mixed $operator ); Create a page public cronCheckStalevoid $PageAdminController->cronCheckStale ( ); Check for stale page content and send emails regarding stale pages; to be run via cron public cronLinkCheckervoid $PageAdminController->cronLinkChecker ( ); Cron version of the link checker public cronPageActivateunknown $PageAdminController->cronPageActivate ( ); Activates AutoLaunch revisions public cronPageDeactivateunknown $PageAdminController->cronPageDeactivate ( ); Deactivates pages after set date public filetreeClosevoid $PageAdminController->filetreeClose ( ); 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 filetreeOpenvoid $PageAdminController->filetreeOpen ( ); 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. protected fixRecordOrdervoid $PageAdminController->fixRecordOrder ( int $item_id ); 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 public importNotesvoid $PageAdminController->importNotes ( mixed $view_name ); Facebox info box public importPreviewAjaxvoid $PageAdminController->importPreviewAjax ( ); Preview the pages which will be created public importUploadActionvoid $PageAdminController->importUploadAction ( ); Upload and do initial processing on the file public linkCheckerActionvoid $PageAdminController->linkCheckerAction ( ); Starts the link checker public menuGroupsActionvoid $PageAdminController->menuGroupsAction ( ); Save the menu groups public previewvoid $PageAdminController->preview ( [ mixed $item_id ] ); This function does not have a description public reindexAllvoid $PageAdminController->reindexAll ( ); Does a complete re-index of all pages private reindexItemunknown $PageAdminController->reindexItem ( mixed $item_id , mixed $name , mixed $text ); Does a re-index for a page private renderPreviewTreenodevoid PageAdminController::renderPreviewTreenode ( mixed $node ); Render a single node for the preview tree we return in `import_preview_ajax` public reorderTopvoid $PageAdminController->reorderTop ( ); Shows the reorder screen (which is shown in a popup box) for re-ordering the top-level stuff This custom version adds subsite support |
| Powered by Pelzini, version 0.9.0 |
Documentation is made available under the
GNU Free Documentation License 1.2. Generated: Tuesday, 15th September, 2026 at 10:26 am |
|