Comments: on this page. Click to read or post your own.

Class CMSMain

Description

Implements interfaces:

The main "content" area of the CMS.

This class creates a 2-frame layout - left-tree and right-form - to sit beneath the main admin menu.

  • todo: Create some base classes to contain the generic functionality that will be replicated.

Located in /cms/code/CMSMain.php (line 11)

Object
   |
   --ViewableData
      |
      --RequestHandlingData
         |
         --Controller
            |
            --LeftAndMain
               |
               --CMSMain
Variable Summary
static mixed $allowed_actions
static mixed $subitem_class
static mixed $tree_class
Method Summary
static void T_SiteTreeFilterOptions ()
void addmember ()
void addpage ()
void comments ()
void compareversions ()
void delete ( $urlParams,  $form)
void deletefromlive ( $urlParams,  $form)
void deleteitems ()
void dialog ()
void duplicate ()
void EditingLang ()
void filtersitetree ()
void getEditForm ( $id)
void getNewItem ( $id, [ $setID = true])
void getpagecount ()
void getpagemembers ()
void getRecord ( $id)
void getversion ()
void init ()
void jsDeclaration ( $array)
void LangSelector ()
void Link ([ $action = null])
void PageTypes ()
void performPublish ( $record)
void performRollback ( $id,  $version)
void publishall ()
void publishitems ()
void ReportSelector ()
void restorepage ()
void revert ( $urlParams,  $form)
void rollback ()
void sendFormToBrowser ( $templateData)
boolean ShowSwitchView ()
void sidereport ()
void SiteTreeAsUL ()
void submit ()
void switchlanguage ( $lang, [ $donotcreate = null])
void tasklist ()
void tellBrowserAboutPublicationChange ( $page,  $statusMessage)
void unpublish ()
void versions ()
void waitingon ()
Variables
static mixed $allowed_actions = array(
'addmember',
'addpage',
'buildbrokenlinks',
'canceldraftchangesdialog',
'compareversions',
'createtranslation',
'delete',
'deletefromlive',
'deleteitems',
'dialog',
'duplicate',
'duplicatewithchildren',
'filtersitetree',
'getpagecount',
'getpagemembers',
'getversion',
'publishall',
'publishitems',
'restorepage',
'revert',
'rollback',
'sidereport',
'submit',
'switchlanguage',
'tasklist',
'unpublish',
'versions',
'waitingon',
'EditForm',
'AddPageOptionsForm',
'SiteTreeAsUL',
)
(line 17)

Redefinition of:
LeftAndMain::$allowed_actions
static mixed $site_tree_filter_options = array(
'ClassName' => array('CMSMain.PAGETYPE', 'Page Type'),'Status'=>array('CMSMain.STATUS','Status'),'MetaDescription'=>array('CMSMain.METADESC','Description'),'MetaKeywords'=>array('CMSMain.METAKEYWORDS','Keywords'))
(line 54)

SiteTree Columns that can be filtered using the the Site Tree Search button

static mixed $subitem_class = "Member" (line 15)
static mixed $tree_class = "SiteTree" (line 13)

Redefinition of:
LeftAndMain::$tree_class

Inherited Variables

Inherited from LeftAndMain

LeftAndMain::$application_link
LeftAndMain::$application_logo
LeftAndMain::$application_logo_style
LeftAndMain::$application_logo_text
LeftAndMain::$application_name
LeftAndMain::$extra_requirements
LeftAndMain::$ForceReload
LeftAndMain::$loading_image
LeftAndMain::$menu_items

Inherited from Controller

Controller::$action
Controller::$baseInitCalled
Controller::$basicAuthEnabled
Controller::$controller_stack
Controller::$request
Controller::$requestParams
Controller::$response
Controller::$session
Controller::$urlParams
Controller::$url_handlers

Inherited from ViewableData

ViewableData::$casting
ViewableData::$castingHelperPair_cache
ViewableData::$customisedObj
ViewableData::$failover
ViewableData::$iteratorPos
ViewableData::$iteratorTotalItems
ViewableData::$namedAs
ViewableData::$parent
ViewableData::$_natural_cache
ViewableData::$_object_cache
ViewableData::$_xml_cache

Inherited from Object

Object::$builtInMethods
Object::$class
Object::$classConstructed
Object::$extensions
Object::$extension_instances
Object::$extraMethods
Object::$extraStatics
Object::$statics
Object::$static_cached
Methods
static method T_SiteTreeFilterOptions (line 61)
static void T_SiteTreeFilterOptions ()
addmember (line 662)
void addmember ()
addpage (line 429)
  • access: public
void addpage ()
AddPageOptionsForm (line 1127)
void AddPageOptionsForm ()
buildbrokenlinks (line 1095)
void buildbrokenlinks ()
canceldraftchangesdialog (line 935)
void canceldraftchangesdialog ()
comments (line 696)
void comments ()
compareversions (line 863)
void compareversions ()
createtranslation (line 1330)

Create a new translation from an existing item, switch to this language and reload the tree.

void createtranslation ()
delete (line 560)

Delete the current page

  • access: public
void delete ( $urlParams,  $form)
  • $urlParams
  • $form
deletefromlive (line 496)
  • access: public
void deletefromlive ( $urlParams,  $form)
  • $urlParams
  • $form
deleteitems (line 1004)

Delete a number of items.

This code supports notification

  • access: public
void deleteitems ()

Redefinition of:
LeftAndMain::deleteitems()
Delete a number of items
dialog (line 916)
void dialog ()
duplicate (line 1231)
void duplicate ()
duplicatewithchildren (line 1249)
void duplicatewithchildren ()
EditingLang (line 1396)

Get the name of the language that we are translating in

void EditingLang ()
filtersitetree (line 141)

Returns a filtered Site Tree

  • access: public
void filtersitetree ()
generateDataTreeHints (line 172)
  • access: public
void generateDataTreeHints ()
generateTreeStylingJS (line 199)
  • access: public
void generateTreeStylingJS ()
getEditForm (line 353)
  • access: public
void getEditForm ( $id)
  • $id
getMembersByGroup (line 649)
void getMembersByGroup ()
getNewItem (line 445)
  • access: public
void getNewItem ( $id, [ $setID = true])
  • $id
  • $setID
getpagecount (line 1147)

Helper function to get page count

void getpagecount ()
getpagemembers (line 617)
void getpagemembers ()
getRecord (line 328)

Get a databsae record to be managed by the CMS

  • access: public
void getRecord ( $id)
  • $id

Redefinition of:
LeftAndMain::getRecord()
getversion (line 814)
void getversion ()
init (line 70)
  • access: public
void init ()

Redefinition of:
LeftAndMain::init()
jsDeclaration (line 239)

Return a javascript instanciation of this array

  • access: protected
void jsDeclaration ( $array)
  • $array
LangSelector (line 1378)

Return a dropdown with existing languages

void LangSelector ()
Link (line 492)
  • access: public
void Link ([ $action = null])
  • $action

Redefinition of:
LeftAndMain::Link()
You should implement a Link() function in your subclass of LeftAndMain, to point to the URL of that particular controller.
MultipleLanguages (line 1387)

Determine if there are more than one languages in our site tree

void MultipleLanguages ()
PageTypes (line 267)

Populates an array of classes in the CMS which allows the user to change the page type.

  • access: public
void PageTypes ()
performPublish (line 537)

Actually perform the publication step

  • access: public
void performPublish ( $record)
  • $record
performRollback (line 804)
void performRollback ( $id,  $version)
  • $id
  • $version
providePermissions (line 1367)

Provide the permission codes used by LeftAndMain.

Can't put it on LeftAndMain since that's an abstract base class.

void providePermissions ()
publishall (line 1174)
void publishall ()
publishitems (line 957)

Publishes a number of items.

Called by AJAX

  • access: public
void publishitems ()
ReportSelector (line 709)

Return a dropdown for selecting reports

void ReportSelector ()
restorepage (line 1216)
void restorepage ()
revert (line 541)
  • access: public
void revert ( $urlParams,  $form)
  • $urlParams
  • $form
rollback (line 745)

Roll a page back to a previous version

void rollback ()
sendFormToBrowser (line 903)
void sendFormToBrowser ( $templateData)
  • $templateData
ShowSwitchView (line 99)

If this is set to true, the "switchView" context in the template is shown, with links to the staging and publish site.

boolean ShowSwitchView ()
sidereport (line 721)

Get the content for a side report

void sidereport ()
SiteTreeAsUL (line 112)

Return the entire site tree as a nested set of ULs

  • access: public
void SiteTreeAsUL ()
SiteTreeFilterDateField (line 133)
  • access: public
void SiteTreeFilterDateField ()
SiteTreeFilterOptions (line 122)

Returns the SiteTree columns that can be filtered using the the Site Tree Search button as a DataObjectSet

  • access: public
void SiteTreeFilterOptions ()
submit (line 580)

Send this page on to another user for review

void submit ()
switchlanguage (line 1265)

Switch the cms language and reload the site tree

void switchlanguage ( $lang, [ $donotcreate = null])
  • $lang
  • $donotcreate
tasklist (line 666)
void tasklist ()
tellBrowserAboutPublicationChange (line 778)

Return a few pieces of information about a change to a page

  • Send the new status message
  • Update the action buttons
  • Update the treenote
  • Send a status message

void tellBrowserAboutPublicationChange ( $page,  $statusMessage)
  • $page
  • $statusMessage
unpublish (line 755)
void unpublish ()
versions (line 729)

Get the versions of the current page

void versions ()
waitingon (line 681)
void waitingon ()

Inherited Methods

Inherited From LeftAndMain

LeftAndMain::addTreeNodeJS()
LeftAndMain::add_menu_item()
LeftAndMain::ajaxupdateparent()
LeftAndMain::ajaxupdatesort()
LeftAndMain::ApplicationLink()
LeftAndMain::callPageMethod()
LeftAndMain::canAccessCMS()
LeftAndMain::canAdminCMS()
LeftAndMain::clear_menu()
LeftAndMain::CMSVersion()
LeftAndMain::currentPage()
LeftAndMain::currentPageID()
LeftAndMain::deleteitems()
LeftAndMain::deleteTreeNodeJS()
LeftAndMain::EditForm()
LeftAndMain::EditorToolbar()
LeftAndMain::ForceReload()
LeftAndMain::getActionUpdateJS()
LeftAndMain::getApplicationLogoText()
LeftAndMain::getApplicationName()
LeftAndMain::getitem()
LeftAndMain::getLastFormIn()
LeftAndMain::getRecord()
LeftAndMain::getSiteTreeFor()
LeftAndMain::getsubtree()
LeftAndMain::getTemplatesWithSuffix()
LeftAndMain::get_menu_item()
LeftAndMain::get_menu_items()
LeftAndMain::init()
LeftAndMain::isCurrentPage()
LeftAndMain::Left()
LeftAndMain::Link()
LeftAndMain::LoadingImage()
LeftAndMain::LogoStyle()
LeftAndMain::MainMenu()
LeftAndMain::MceRoot()
LeftAndMain::Member_ProfileForm()
LeftAndMain::myprofile()
LeftAndMain::populate_default_menu()
LeftAndMain::printable()
LeftAndMain::remove_menu_item()
LeftAndMain::replace_menu_item()
LeftAndMain::require_css()
LeftAndMain::require_javascript()
LeftAndMain::require_themed_css()
LeftAndMain::returnItemToUser()
LeftAndMain::Right()
LeftAndMain::RightBottom()
LeftAndMain::save()
LeftAndMain::SectionTitle()
LeftAndMain::setApplicationName()
LeftAndMain::setCurrentPageID()
LeftAndMain::setLogo()
LeftAndMain::set_loading_image()
LeftAndMain::show()

Inherited From Controller

Controller::AbsoluteLink()
Controller::can()
Controller::curr()
Controller::currentController()
Controller::CurrentMember()
Controller::defaultAction()
Controller::disableBasicAuth()
Controller::getAction()
Controller::getFormOwner()
Controller::getRequest()
Controller::getResponse()
Controller::getSession()
Controller::getURLParams()
Controller::getViewer()
Controller::handleAction()
Controller::handleRequest()
Controller::has_curr()
Controller::init()
Controller::isAjax()
Controller::join_links()
Controller::LinkTo()
Controller::Now()
Controller::PastMember()
Controller::PastVisitor()
Controller::popCurrent()
Controller::pushCurrent()
Controller::redirect()
Controller::redirectedTo()
Controller::render()
Controller::setSession()
Controller::setURLParams()

Inherited From RequestHandlingData

RequestHandlingData::checkAccessAction()
RequestHandlingData::getRequest()
RequestHandlingData::handleRequest()
RequestHandlingData::httpError()

Inherited From ViewableData

ViewableData::ATT_val()
ViewableData::BaseHref()
ViewableData::buildCastingHelperCache()
ViewableData::cachedCall()
ViewableData::castingHelper()
ViewableData::castingHelperPair()
ViewableData::castingObjectCreator()
ViewableData::castingObjectCreatorPair()
ViewableData::CSSClasses()
ViewableData::CurrentMember()
ViewableData::CurrentPage()
ViewableData::customise()
ViewableData::Debug()
ViewableData::defineMethods()
ViewableData::escapeTypeForField()
ViewableData::Even()
ViewableData::EvenOdd()
ViewableData::First()
ViewableData::FirstLast()
ViewableData::getField()
ViewableData::getIterator()
ViewableData::getXMLValues()
ViewableData::hasField()
ViewableData::HasPerm()
ViewableData::hasValue()
ViewableData::i18nLocale()
ViewableData::IsAjax()
ViewableData::iteratorProperties()
ViewableData::JS_val()
ViewableData::Last()
ViewableData::Me()
ViewableData::Middle()
ViewableData::MiddleString()
ViewableData::obj()
ViewableData::Odd()
ViewableData::Pos()
ViewableData::RAW_val()
ViewableData::renderWith()
ViewableData::SecurityID()
ViewableData::setCustomisedObj()
ViewableData::setField()
ViewableData::SQL_val()
ViewableData::ThemeDir()
ViewableData::Top()
ViewableData::TotalItems()
ViewableData::val()
ViewableData::XML_val()
ViewableData::__get()
ViewableData::__isset()
ViewableData::__set()

Inherited From Object

Object::__construct()
Object::addMethodsFrom()
Object::addStaticVars()
Object::addWrapperMethod()
Object::add_extension()
Object::allMethodNames()
Object::buildMethodList()
Object::cacheToFile()
Object::cacheToFileWithArgs()
Object::create()
Object::createMethod()
Object::defineMethods()
Object::exists()
Object::extend()
Object::extInstance()
Object::getCustomClass()
Object::hasExtension()
Object::hasMethod()
Object::invokeWithExtensions()
Object::is_a()
Object::loadCache()
Object::parentClass()
Object::sanitiseCachename()
Object::saveCache()
Object::set_stat()
Object::set_uninherited()
Object::stat()
Object::strong_create()
Object::uninherited()
Object::useCustomClass()
Object::__call()
Object::__toString()
blog comments powered by Disqus

Documentation generated on Tue, 07 Oct 2008 15:54:59 +1300 by phpDocumentor 1.3.2