\LeftAndMain
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.
This is essentially an abstract class which should be subclassed.
See for a good example.
Synopsis
class LeftAndMain
extends Controller
{
- // members
- public static string $url_base = "admin";
- public static $url_segment;
- public static string $url_rule = '/$Action/$ID/$OtherID';
- public static $menu_title;
- public static integer $menu_priority = 0;
- public static integer $url_priority = 50;
- public static $tree_class = NULL;
- public static $ForceReload;
- public static string $help_link = 'http://userhelp.silverstripe.org';
- public static array $allowed_actions = ;
- protected static array $extra_requirements = ;
- public static String $application_name = 'SilverStripe CMS';
- public static String $application_logo_text = 'SilverStripe';
- public static string $application_link = "http://www.silverstripe.org/";
- public static unknown_type $application_logo = 'cms/images/mainmenu/logo.gif';
- public static String $application_logo_style = '';
- protected static string $loading_image = 'cms/images/loading.gif';
- // methods
- public boolean canView()
- public void init()
- public void handleRequest()
- public boolean ShowSwitchView()
- public string Link()
- public static void menu_title_for_class()
- public void show()
- public void getitem()
- public void getLastFormIn()
- public DataObjectSet MainMenu()
- public void CMSTopMenu()
- protected void getTemplatesWithSuffix()
- public void Left()
- public void Right()
- public void getRecord()
- public void getSiteTreeFor()
- public void getsubtree()
- public void returnItemToUser()
- public void save()
- public string getActionUpdateJS()
- public string addTreeNodeJS()
- public string deleteTreeNodeJS()
- public static void ForceReload()
- public void ajaxupdateparent()
- public void ajaxupdatesort()
- public void CanOrganiseSitetree()
- public void deleteitems()
- public Form EmptyForm()
- public void EditForm()
- public void myprofile()
- public void Member_ProfileForm()
- public void printable()
- public void currentPageID()
- public void setCurrentPageID()
- public void currentPage()
- public void isCurrentPage()
- public void EditorToolbar()
- public string CMSVersion()
- public array SwitchView()
- public static void setApplicationName()
- public String getApplicationName()
- public String getApplicationLogoText()
- public void ApplicationLink()
- public void SectionTitle()
- public static void setLogo()
- public static void set_loading_image()
- public void LoadingImage()
- public void LogoStyle()
- public void MceRoot()
- public void callPageMethod()
- public static void require_javascript()
- public static void require_css()
- public static void require_themed_css()
Hierarchy
Extends
- Controller
Members
protected
- $extra_requirements
—
array
Register additional requirements through the {@link Requirements class}. - $loading_image
public
- $ForceReload
- $allowed_actions
-
$application_link
Set the application name, and the logo text. - $application_logo
—
unknown_type
The application logo path. Customisable by calling LeftAndMain::setLogo() - the first parameter. - $application_logo_style
—
String
The application logo style. Customisable by calling LeftAndMain::setLogo() - the second parameter. - $application_logo_text
—
String
The application logo text. Customisable by calling LeftAndMain::setApplicationName() - the second parameter. - $application_name
—
String
The application name. Customisable by calling LeftAndMain::setApplicationName() - the first parameter. -
$help_link
The url used for the link in the Help tab in the backend Value can be overwritten if required in _config.php - $tree_class
- $url_base
—
string
The 'base' url for CMS administration areas. - $url_priority
- $url_rule
- $url_segment
Methods
protected
- getTemplatesWithSuffix() — Return a list of appropriate templates for this class, with the given suffix
public
- ApplicationLink()
- CMSTopMenu()
- CMSVersion() — Return the version number of this application.
- CanOrganiseSitetree()
- EditForm()
- EditorToolbar() — Return the CMS's HTML-editor toolbar
- EmptyForm() — Returns a placeholder form, used by {@link getEditForm()} if no record is selected.
- ForceReload() — Sets a static variable on this class which means the panel will be reloaded.
- Left()
- Link() — You should implement a Link() function in your subclass of LeftAndMain, to point to the URL of that particular controller.
- LoadingImage()
- LogoStyle()
- MainMenu() — Returns the main menu of the CMS. This is also used by init() to work out which sections the user has access to.
- MceRoot() — Return the base directory of the tiny_mce codebase
- Member_ProfileForm()
- Right()
- SectionTitle() — Return the title of the current section, as shown on the main menu
- ShowSwitchView() — If this is set to true, the "switchView" context in the template is shown, with links to the staging and publish site.
- SwitchView()
- addTreeNodeJS() — Returns a javascript snippet to generate a tree node for the given page, if visible
- ajaxupdateparent() — Ajax handler for updating the parent of a tree node
- ajaxupdatesort() — 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
- callPageMethod() — Use this as an action handler for custom CMS buttons.
- canView()
- currentPage()
- currentPageID()
- deleteTreeNodeJS() — Returns a javascript snippet to remove a tree node for the given page, if it exists.
- deleteitems() — Delete a number of items
- getActionUpdateJS() — Returns a javascript snippet that will update the actions of the main form
- getApplicationLogoText() — Get the application logo text.
- getApplicationName() — Get the application name.
- getLastFormIn()
- getRecord()
- getSiteTreeFor() — Get a site tree displaying the nodes under the given objects
- getitem()
- getsubtree() — Get a subtree underneath the request param 'ID'.
- handleRequest()
- init()
- isCurrentPage()
- myprofile()
- printable()
- require_css() — Register the given stylesheet file as required.
- require_javascript() — Register the given javascript file as required in the CMS.
- require_themed_css() — Register the given "themeable stylesheet" as required.
- returnItemToUser() — Allows you to returns a new data object to the tree (subclass of sitetree) and updates the tree via javascript.
- save() — Save and Publish page handler
- setApplicationName()
- setCurrentPageID()
- setLogo() — Set the CMS application logo.
- set_loading_image() — Set the image shown when the CMS is loading.
- show()