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

Class LeftAndMain

Description

LeftAndMain is the parent class of all the two-pane views in the CMS.

If you are wanting to add more areas to the CMS, you can do it by subclassing LeftAndMain.

  • abstract:

Located in /cms/code/LeftAndMain.php (line 7)

Object
   |
   --ViewableData
      |
      --RequestHandlingData
         |
         --Controller
            |
            --LeftAndMain
Direct descendents
Class Description
CommentAdmin Comment administration system within the CMS
SecurityAdmin LeftAndMain is the parent class of all the two-pane views in the CMS.
NewsletterAdmin LeftAndMain is the parent class of all the two-pane views in the CMS.
GenericDataAdmin Provides a common interface for searching, viewing and editing DataObjects.
ReportAdmin Reports section of the CMS.
AssetAdmin AssetAdmin is the 'file store' section of the CMS.
BulkLoaderAdmin Class to provide batch-update facilities to CMS users.
CMSMain The main "content" area of the CMS.
ModelAdmin Generates a three-pane UI for editing model classes, with an automatically generated search panel, tabular results and edit forms.
Variable Summary
static mixed $application_logo
static mixed $application_logo_text
static mixed $application_name
static mixed $extra_menu_items
static mixed $ForceReload
static mixed $removed_menu_items
static mixed $replaced_menu_items
static mixed $tree_class
Method Summary
static void ForceReload ()
static void setApplicationName ( $name)
static void setLogo ( $logo,  $logoStyle)
void addTreeNodeJS ( $page, [ $select = false])
void ajaxupdatesort ()
void ApplicationName ()
void canAccessCMS ()
void canAdminCMS ()
void CMSVersion ()
void currentPage ()
void currentPageID ()
void deleteitems ()
void deleteTreeNodeJS ( $page)
void EditForm ()
void EditorToolbar ()
void getActionUpdateJS ( $record)
void getitem ()
void getLastFormIn ( $html)
void getRecord ( $id, [ $className = null])
void getSiteTreeFor ( $className, [ $rootID = null])
void getsubtree ()
void getTemplatesWithSuffix ( $suffix)
boolean hasReports ()
void init ()
void isCurrentPage (DataObject $page)
void Left ()
void Link ()
void LogoStyle ()
void MainMenu ()
void printable ()
void returnItemToUser ( $p)
void Right ()
void RightBottom ()
void save ( $urlParams,  $form)
void setCurrentPageID ( $id)
void show ( $params)
Variables
static mixed $application_logo = "cms/images/mainmenu/logo.gif" (line 762)
static mixed $application_logo_style = "" (line 762)
static mixed $application_logo_text = "SilverStripe CMS" (line 750)
static mixed $application_name = "SilverStripe CMS" (line 750)

The application name is customisable by calling

LeftAndMain::setApplicationName("Something New")

static mixed $extra_menu_items = array() (line 9)
static mixed $ForceReload (line 10)
static mixed $removed_menu_items = array() (line 9)
static mixed $replaced_menu_items = array() (line 9)
static mixed $tree_class = null (line 8)

Redefined in descendants as:

Inherited Variables

Inherited from Controller

Controller::$action
Controller::$allowed_actions
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 ForceReload (line 551)

Sets a static variable on this class which means the panel will be reloaded.

static void ForceReload ()
static method setApplicationName (line 751)
static void setApplicationName ( $name)
  • $name
static method setLogo (line 764)
static void setLogo ( $logo,  $logoStyle)
  • $logo
  • $logoStyle
addTreeNodeJS (line 524)

Return JavaScript code to generate a tree node for the given page, if visible

  • access: public
void addTreeNodeJS ( $page, [ $select = false])
  • $page
  • $select
ajaxupdateparent (line 558)

Ajax handler for updating the parent of a tree node

  • access: public
void ajaxupdateparent ()
ajaxupdatesort (line 599)

Ajax handler for updating the order of a number of tree nodes

$_GET[ID]: An array of node ids in the correct order $_GET[MovedNodeID]: The node that actually got moved

  • access: public
void ajaxupdatesort ()
ApplicationLogoText (line 758)
void ApplicationLogoText ()
ApplicationName (line 755)
void ApplicationName ()
canAccessCMS (line 112)

Returns true if the current user can access the CMS

void canAccessCMS ()
canAdminCMS (line 128)

Returns true if the current user has administrative rights in the CMS

void canAdminCMS ()
CMSVersion (line 713)

Return the version number of this application

  • access: public
void CMSVersion ()
currentPage (line 692)
  • access: public
void currentPage ()
currentPageID (line 676)
  • access: public
void currentPageID ()

Redefined in descendants as:
deleteitems (line 642)

Delete a number of items

  • access: public
void deleteitems ()

Redefined in descendants as:
deleteTreeNodeJS (line 538)

Return JavaScript code to remove a tree node for the given page, if it exists.

  • access: public
void deleteTreeNodeJS ( $page)
  • $page
EditForm (line 657)
  • access: public
void EditForm ()

Redefined in descendants as:
EditorToolbar (line 706)

Return the CMS's HTML-editor toolbar

  • access: public
void EditorToolbar ()
getActionUpdateJS (line 508)

Return a piece of javascript that will update the actions of the main form

  • access: public
void getActionUpdateJS ( $record)
  • $record
getitem (line 160)
  • access: public
void getitem ()
getLastFormIn (line 169)
  • access: public
void getLastFormIn ( $html)
  • $html
getRecord (line 305)
  • access: public
void getRecord ( $id, [ $className = null])
  • $id
  • $className

Redefined in descendants as:
getSiteTreeFor (line 310)
void getSiteTreeFor ( $className, [ $rootID = null])
  • $className
  • $rootID
getsubtree (line 335)
  • access: public
void getsubtree ()

Redefined in descendants as:
getTemplatesWithSuffix (line 283)

Return a list of appropriate templates for this class, with the given suffix

  • access: protected
void getTemplatesWithSuffix ( $suffix)
  • $suffix
hasReports (line 779)

Determine if we have reports and need to display the Reports main menu item

boolean hasReports ()
init (line 12)
void init ()

Redefinition of:
Controller::init()
Initialisation function that is run before any action on the controller is called.

Redefined in descendants as:
isCurrentPage (line 699)
  • access: public
void isCurrentPage (DataObject $page)
Left (line 292)
  • access: public
void Left ()
Link (line 141)

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

  • abstract:
  • access: public
void Link ()

Redefined in descendants as:
LogoStyle (line 769)
void LogoStyle ()
MainMenu (line 181)

Returns the main menu of the CMS. This is also used by init() to work out which sections the user has access to.

  • access: public
void MainMenu ()
printable (line 662)
  • access: public
void printable ()
returnItemToUser (line 344)

Allows you to returns a new data object to the tree (subclass of sitetree) and updates the tree via javascript.

  • access: public
void returnItemToUser ( $p)
  • $p

Redefined in descendants as:
Right (line 295)
  • access: public
void Right ()
RightBottom (line 298)
  • access: public
void RightBottom ()
save (line 371)

Save page handler

  • access: public
void save ( $urlParams,  $form)
  • $urlParams
  • $form

Redefined in descendants as:
setCurrentPageID (line 688)
  • access: public
void setCurrentPageID ( $id)
  • $id
show (line 143)
  • access: public
void show ( $params)
  • $params

Inherited Methods

Inherited From Controller

Controller::AbsoluteLink()
Controller::can()
Controller::curr()
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::Now()
Controller::PastMember()
Controller::PastVisitor()
Controller::popCurrent()
Controller::pushCurrent()
Controller::redirect()
Controller::redirectBack()
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 Sun, 19 Oct 2008 06:42:37 +1300 by phpDocumentor 1.3.2