2011-03-23 10:51:00 +01:00
< ? php
/**
* 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 { @ link CMSMain } for a good example .
*
* @ package cms
* @ subpackage core
*/
class LeftAndMain extends Controller {
/**
* The 'base' url for CMS administration areas .
* Note that if this is changed , many javascript
* behaviours need to be updated with the correct url
*
* @ var string $url_base
*/
static $url_base = " admin " ;
2011-05-20 01:29:40 +02:00
/**
* The current url segment attached to the LeftAndMain instance
*
* @ var string
*/
2011-03-23 10:51:00 +01:00
static $url_segment ;
2011-05-20 01:29:40 +02:00
/**
* @ var string
*/
2011-03-23 10:51:00 +01:00
static $url_rule = '/$Action/$ID/$OtherID' ;
2011-05-20 01:29:40 +02:00
/**
* @ var string
*/
2011-03-23 10:51:00 +01:00
static $menu_title ;
2011-05-20 01:29:40 +02:00
/**
* @ var int
*/
2011-03-23 10:51:00 +01:00
static $menu_priority = 0 ;
2011-05-20 01:29:40 +02:00
/**
* @ var int
*/
2011-03-23 10:51:00 +01:00
static $url_priority = 50 ;
/**
2011-05-20 01:29:40 +02:00
* A subclass of { @ link DataObject } .
*
* Determines what is managed in this interface , through
* { @ link getEditForm ()} and other logic .
*
* @ var string
2011-03-23 10:51:00 +01:00
*/
static $tree_class = null ;
/**
2011-05-20 01:29:40 +02:00
* The url used for the link in the Help tab in the backend
*
* @ var string
*/
2011-03-23 10:51:00 +01:00
static $help_link = 'http://userhelp.silverstripe.org' ;
2011-05-20 01:29:40 +02:00
/**
* @ var array
*/
2011-03-23 10:51:00 +01:00
static $allowed_actions = array (
'index' ,
2011-06-09 03:49:52 +02:00
'save' ,
2011-03-23 10:51:00 +01:00
'savetreenode' ,
'getitem' ,
'getsubtree' ,
'myprofile' ,
'printable' ,
'show' ,
'Member_ProfileForm' ,
'EditorToolbar' ,
'EditForm' ,
'RootForm' ,
'AddForm' ,
'batchactions' ,
'BatchActionsForm' ,
'Member_ProfileForm' ,
);
/**
2011-05-20 01:29:40 +02:00
* Register additional requirements through the { @ link Requirements } class .
2011-03-23 10:51:00 +01:00
* Used mainly to work around the missing " lazy loading " functionality
* for getting css / javascript required after an ajax - call ( e . g . loading the editform ) .
*
* @ var array $extra_requirements
*/
protected static $extra_requirements = array (
'javascript' => array (),
'css' => array (),
'themedcss' => array (),
);
/**
* @ param Member $member
2011-05-20 01:29:40 +02:00
*
2011-03-23 10:51:00 +01:00
* @ return boolean
*/
function canView ( $member = null ) {
if ( ! $member && $member !== FALSE ) {
$member = Member :: currentUser ();
}
// cms menus only for logged-in members
if ( ! $member ) return false ;
2011-04-15 11:35:30 +02:00
// alternative extended checks
2011-03-23 10:51:00 +01:00
if ( $this -> hasMethod ( 'alternateAccessCheck' )) {
$alternateAllowed = $this -> alternateAccessCheck ();
if ( $alternateAllowed === FALSE ) return false ;
}
// Default security check for LeftAndMain sub-class permissions
if ( ! Permission :: checkMember ( $member , " CMS_ACCESS_ $this->class " ) &&
! Permission :: checkMember ( $member , " CMS_ACCESS_LeftAndMain " )) {
return false ;
}
return true ;
}
/**
2011-04-15 11:35:30 +02:00
* @ uses LeftAndMainExtension -> init ()
* @ uses LeftAndMainExtension -> accessedCMS ()
2011-03-23 10:51:00 +01:00
* @ uses CMSMenu
*/
function init () {
parent :: init ();
SSViewer :: setOption ( 'rewriteHashlinks' , false );
// set language
$member = Member :: currentUser ();
if ( ! empty ( $member -> Locale )) i18n :: set_locale ( $member -> Locale );
if ( ! empty ( $member -> DateFormat )) i18n :: set_date_format ( $member -> DateFormat );
if ( ! empty ( $member -> TimeFormat )) i18n :: set_time_format ( $member -> TimeFormat );
// can't be done in cms/_config.php as locale is not set yet
CMSMenu :: add_link (
'Help' ,
_t ( 'LeftAndMain.HELP' , 'Help' , PR_HIGH , 'Menu title' ),
self :: $help_link
);
2011-04-15 11:35:30 +02:00
// Allow customisation of the access check by a extension
2011-03-23 10:51:00 +01:00
// Also all the canView() check to execute Director::redirect()
if ( ! $this -> canView () && ! $this -> response -> isFinished ()) {
// When access /admin/, we should try a redirect to another part of the admin rather than be locked out
$menu = $this -> MainMenu ();
foreach ( $menu as $candidate ) {
if (
$candidate -> Link &&
$candidate -> Link != $this -> Link ()
&& $candidate -> MenuItem -> controller
&& singleton ( $candidate -> MenuItem -> controller ) -> canView ()
) {
return Director :: redirect ( $candidate -> Link );
}
}
if ( Member :: currentUser ()) {
Session :: set ( " BackURL " , null );
}
// if no alternate menu items have matched, return a permission error
$messageSet = array (
'default' => _t ( 'LeftAndMain.PERMDEFAULT' , " Please choose an authentication method and enter your credentials to access the CMS. " ),
'alreadyLoggedIn' => _t ( 'LeftAndMain.PERMALREADY' , " I'm sorry, but you can't access that part of the CMS. If you want to log in as someone else, do so below " ),
'logInAgain' => _t ( 'LeftAndMain.PERMAGAIN' , " You have been logged out of the CMS. If you would like to log in again, enter a username and password below. " ),
);
return Security :: permissionFailure ( $this , $messageSet );
}
// Don't continue if there's already been a redirection request.
if ( Director :: redirected_to ()) return ;
// Audit logging hook
if ( empty ( $_REQUEST [ 'executeForm' ]) && ! $this -> isAjax ()) $this -> extend ( 'accessedCMS' );
2011-08-05 05:46:57 +02:00
2011-10-11 09:55:58 +02:00
// Requirements
2011-12-12 23:41:49 +01:00
// Suppress behaviour/prototype validation instructions in CMS, not compatible with ajax loading of forms.
Validator :: set_javascript_validation_handler ( 'none' );
// Set the members html editor config
HtmlEditorConfig :: set_active ( Member :: currentUser () -> getHtmlEditorConfigForCMS ());
2011-03-23 10:51:00 +01:00
2011-12-13 14:56:35 +01:00
// Set default values in the config if missing. These things can't be defined in the config
// file because insufficient information exists when that is being processed
$htmlEditorConfig = HtmlEditorConfig :: get_active ();
$htmlEditorConfig -> setOption ( 'language' , i18n :: get_tinymce_lang ());
if ( ! $htmlEditorConfig -> getOption ( 'content_css' )) {
$cssFiles = array ();
$cssFiles [] = 'sapphire/admin/css/editor.css' ;
// Use theme from the site config
if ( class_exists ( 'SiteConfig' ) && ( $config = SiteConfig :: current_site_config ()) && $config -> Theme ) {
$theme = $config -> Theme ;
} elseif ( SSViewer :: current_theme ()) {
$theme = SSViewer :: current_theme ();
} else {
$theme = false ;
}
if ( $theme ) $cssFiles [] = THEMES_DIR . " / { $theme } /css/editor.css " ;
else if ( project ()) $cssFiles [] = project () . '/css/editor.css' ;
// Remove files that don't exist
foreach ( $cssFiles as $k => $cssFile ) {
if ( ! file_exists ( BASE_PATH . '/' . $cssFile )) unset ( $cssFiles [ $k ]);
}
$htmlEditorConfig -> setOption ( 'content_css' , implode ( ',' , $cssFiles ));
}
2011-03-23 10:51:00 +01:00
Requirements :: combine_files (
2011-04-25 11:24:55 +02:00
'lib.js' ,
2011-03-23 10:51:00 +01:00
array (
2011-04-25 11:24:55 +02:00
THIRDPARTY_DIR . '/prototype/prototype.js' ,
THIRDPARTY_DIR . '/behaviour/behaviour.js' ,
THIRDPARTY_DIR . '/jquery/jquery.js' ,
SAPPHIRE_DIR . '/javascript/jquery_improvements.js' ,
THIRDPARTY_DIR . '/jquery-livequery/jquery.livequery.js' ,
SAPPHIRE_DIR . '/javascript/jquery-ondemand/jquery.ondemand.js' ,
THIRDPARTY_DIR . '/jquery-ui/jquery-ui.js' ,
THIRDPARTY_DIR . '/json-js/json2.js' ,
THIRDPARTY_DIR . '/jquery-entwine/dist/jquery.entwine-dist.js' ,
THIRDPARTY_DIR . '/jquery-cookie/jquery.cookie.js' ,
2011-07-15 10:35:41 +02:00
THIRDPARTY_DIR . '/jquery-query/jquery.query.js' ,
2011-04-25 11:24:55 +02:00
SAPPHIRE_ADMIN_DIR . '/thirdparty/jquery-notice/jquery.notice.js' ,
THIRDPARTY_DIR . '/jquery-metadata/jquery.metadata.js' ,
SAPPHIRE_ADMIN_DIR . '/thirdparty/jsizes/lib/jquery.sizes.js' ,
SAPPHIRE_ADMIN_DIR . '/thirdparty/jlayout/lib/jlayout.border.js' ,
SAPPHIRE_ADMIN_DIR . '/thirdparty/jlayout/lib/jquery.jlayout.js' ,
2011-06-09 03:49:52 +02:00
SAPPHIRE_ADMIN_DIR . '/thirdparty/history-js/scripts/uncompressed/history.js' ,
SAPPHIRE_ADMIN_DIR . '/thirdparty/history-js/scripts/uncompressed/history.adapter.jquery.js' ,
2011-12-14 16:13:35 +01:00
// SAPPHIRE_ADMIN_DIR . '/thirdparty/history-js/scripts/uncompressed/history.html4.js',
2011-04-25 11:24:55 +02:00
THIRDPARTY_DIR . '/jstree/jquery.jstree.js' ,
2011-10-11 09:55:58 +02:00
SAPPHIRE_ADMIN_DIR . '/thirdparty/chosen/chosen/chosen.jquery.js' ,
SAPPHIRE_ADMIN_DIR . '/thirdparty/jquery-hoverIntent/jquery.hoverIntent.js' ,
2011-04-25 11:24:55 +02:00
SAPPHIRE_ADMIN_DIR . '/javascript/jquery-changetracker/lib/jquery.changetracker.js' ,
SAPPHIRE_DIR . '/javascript/TreeDropdownField.js' ,
2011-10-11 09:55:58 +02:00
SAPPHIRE_DIR . " /thirdparty/jquery-form/jquery.form.js " ,
SAPPHIRE_DIR . '/javascript/DateField.js' ,
SAPPHIRE_DIR . '/javascript/HtmlEditorField.js' ,
2011-04-25 11:24:55 +02:00
SAPPHIRE_DIR . '/javascript/TabSet.js' ,
SAPPHIRE_DIR . '/javascript/Validator.js' ,
SAPPHIRE_DIR . '/javascript/i18n.js' ,
SAPPHIRE_ADMIN_DIR . '/javascript/ssui.core.js' ,
2011-03-23 10:51:00 +01:00
)
);
2011-12-13 14:56:35 +01:00
HTMLEditorField :: include_js ();
2011-03-23 10:51:00 +01:00
Requirements :: combine_files (
'leftandmain.js' ,
array (
2011-04-25 11:24:55 +02:00
SAPPHIRE_ADMIN_DIR . '/javascript/LeftAndMain.js' ,
2011-05-13 03:30:49 +02:00
SAPPHIRE_ADMIN_DIR . '/javascript/LeftAndMain.Panel.js' ,
2011-04-25 11:24:55 +02:00
SAPPHIRE_ADMIN_DIR . '/javascript/LeftAndMain.Tree.js' ,
2011-05-20 01:39:44 +02:00
SAPPHIRE_ADMIN_DIR . '/javascript/LeftAndMain.Ping.js' ,
2011-05-20 01:38:36 +02:00
SAPPHIRE_ADMIN_DIR . '/javascript/LeftAndMain.Content.js' ,
2011-04-25 11:24:55 +02:00
SAPPHIRE_ADMIN_DIR . '/javascript/LeftAndMain.EditForm.js' ,
2011-05-13 03:30:49 +02:00
SAPPHIRE_ADMIN_DIR . '/javascript/LeftAndMain.Menu.js' ,
2011-04-25 11:24:55 +02:00
SAPPHIRE_ADMIN_DIR . '/javascript/LeftAndMain.AddForm.js' ,
2011-04-28 12:36:28 +02:00
SAPPHIRE_ADMIN_DIR . '/javascript/LeftAndMain.Preview.js' ,
2011-04-25 11:24:55 +02:00
SAPPHIRE_ADMIN_DIR . '/javascript/LeftAndMain.BatchActions.js' ,
2011-03-23 10:51:00 +01:00
)
);
2011-10-11 09:55:58 +02:00
Requirements :: add_i18n_javascript ( SAPPHIRE_DIR . '/javascript/lang' );
Requirements :: add_i18n_javascript ( SAPPHIRE_ADMIN_DIR . '/javascript/lang' );
Requirements :: combine_files (
'lib.css' ,
array (
// @todo Load separately so the CSS files can be inlined
THIRDPARTY_DIR . '/jquery-ui-themes/smoothness/jquery-ui.css' ,
SAPPHIRE_ADMIN_DIR . '/thirdparty/chosen/chosen/chosen.css' ,
THIRDPARTY_DIR . '/jstree/themes/apple/style.css' ,
2011-10-29 02:29:55 +02:00
SAPPHIRE_DIR . '/css/TreeDropdownField.css'
2011-10-11 09:55:58 +02:00
)
);
Requirements :: css ( SAPPHIRE_ADMIN_DIR . '/css/screen.css' );
foreach ( self :: $extra_requirements [ 'javascript' ] as $file ) {
Requirements :: javascript ( $file [ 0 ]);
}
foreach ( self :: $extra_requirements [ 'css' ] as $file ) {
Requirements :: css ( $file [ 0 ], $file [ 1 ]);
}
foreach ( self :: $extra_requirements [ 'themedcss' ] as $file ) {
Requirements :: themedCSS ( $file [ 0 ], $file [ 1 ]);
}
2011-03-23 10:51:00 +01:00
$dummy = null ;
$this -> extend ( 'init' , $dummy );
// The user's theme shouldn't affect the CMS, if, for example, they have replaced
// TableListField.ss or Form.ss.
SSViewer :: set_theme ( null );
}
2011-06-09 03:49:52 +02:00
2011-09-26 05:55:59 +02:00
function handleRequest ( $request , DataModel $model ) {
2011-06-09 05:47:59 +02:00
$title = $this -> Title ();
2011-09-26 05:55:59 +02:00
$response = parent :: handleRequest ( $request , $model );
2011-12-20 17:06:11 +01:00
if ( ! $response -> getHeader ( 'X-Controller' )) $response -> addHeader ( 'X-Controller' , $this -> class );
if ( ! $response -> getHeader ( 'X-Title' )) $response -> addHeader ( 'X-Title' , $title );
2011-06-09 05:47:59 +02:00
2011-06-09 03:49:52 +02:00
return $response ;
}
function index ( $request ) {
return ( $this -> isAjax ()) ? $this -> show ( $request ) : $this -> getViewer ( 'index' ) -> process ( $this );
}
2011-03-23 10:51:00 +01:00
/**
* If this is set to true , the " switchView " context in the
* template is shown , with links to the staging and publish site .
*
* @ return boolean
*/
function ShowSwitchView () {
return false ;
}
2011-05-20 01:29:40 +02:00
2011-03-23 10:51:00 +01:00
//------------------------------------------------------------------------------------------//
// Main controllers
/**
* You should implement a Link () function in your subclass of LeftAndMain ,
* to point to the URL of that particular controller .
*
* @ return string
*/
public function Link ( $action = null ) {
// Handle missing url_segments
if ( ! $this -> stat ( 'url_segment' , true ))
self :: $url_segment = $this -> class ;
return Controller :: join_links (
$this -> stat ( 'url_base' , true ),
$this -> stat ( 'url_segment' , true ),
'/' , // trailing slash needed if $action is null!
" $action "
);
}
/**
* Returns the menu title for the given LeftAndMain subclass .
* Implemented static so that we can get this value without instantiating an object .
* Menu title is * not * internationalised .
*/
static function menu_title_for_class ( $class ) {
$title = eval ( " return $class :: \$ menu_title; " );
if ( ! $title ) $title = preg_replace ( '/Admin$/' , '' , $class );
return $title ;
}
2011-06-08 01:35:56 +02:00
2011-03-23 10:51:00 +01:00
public function show ( $request ) {
// TODO Necessary for TableListField URLs to work properly
if ( $request -> param ( 'ID' )) $this -> setCurrentPageID ( $request -> param ( 'ID' ));
if ( $this -> isAjax ()) {
2011-06-08 01:35:56 +02:00
if ( $request -> getVar ( 'cms-view-form' )) {
$form = $this -> getEditForm ();
$content = $form -> forTemplate ();
} else {
// Rendering is handled by template, which will call EditForm() eventually
$content = $this -> renderWith ( $this -> getTemplatesWithSuffix ( '_Content' ));
}
2011-03-23 10:51:00 +01:00
} else {
$content = $this -> renderWith ( $this -> getViewer ( 'show' ));
}
2011-07-21 20:14:33 +02:00
2011-03-23 10:51:00 +01:00
return $content ;
}
//------------------------------------------------------------------------------------------//
// Main UI components
/**
* Returns the main menu of the CMS . This is also used by init ()
* to work out which sections the user has access to .
*
2011-10-26 08:09:04 +02:00
* @ return SS_List
2011-03-23 10:51:00 +01:00
*/
public function MainMenu () {
// Don't accidentally return a menu if you're not logged in - it's used to determine access.
2011-05-05 12:40:24 +02:00
if ( ! Member :: currentUser ()) return new ArrayList ();
2011-03-23 10:51:00 +01:00
// Encode into DO set
2011-05-05 12:40:24 +02:00
$menu = new ArrayList ();
2011-03-23 10:51:00 +01:00
$menuItems = CMSMenu :: get_viewable_menu_items ();
2011-07-28 06:57:41 +02:00
if ( $menuItems ) {
foreach ( $menuItems as $code => $menuItem ) {
// alternate permission checks (in addition to LeftAndMain->canView())
if (
isset ( $menuItem -> controller )
&& $this -> hasMethod ( 'alternateMenuDisplayCheck' )
&& ! $this -> alternateMenuDisplayCheck ( $menuItem -> controller )
) {
continue ;
}
2011-03-23 10:51:00 +01:00
2011-08-16 05:36:39 +02:00
$linkingmode = " link " ;
2011-07-28 06:57:41 +02:00
if ( $menuItem -> controller && get_class ( $this ) == $menuItem -> controller ) {
2011-03-23 10:51:00 +01:00
$linkingmode = " current " ;
2011-07-28 06:57:41 +02:00
} else if ( strpos ( $this -> Link (), $menuItem -> url ) !== false ) {
if ( $this -> Link () == $menuItem -> url ) {
$linkingmode = " current " ;
2011-03-23 10:51:00 +01:00
2011-07-28 06:57:41 +02:00
// default menu is the one with a blank {@link url_segment}
} else if ( singleton ( $menuItem -> controller ) -> stat ( 'url_segment' ) == '' ) {
if ( $this -> Link () == $this -> stat ( 'url_base' ) . '/' ) {
$linkingmode = " current " ;
}
2011-03-23 10:51:00 +01:00
2011-07-28 06:57:41 +02:00
} else {
$linkingmode = " current " ;
}
2011-03-23 10:51:00 +01:00
}
2011-07-28 06:57:41 +02:00
// already set in CMSMenu::populate_menu(), but from a static pre-controller
// context, so doesn't respect the current user locale in _t() calls - as a workaround,
// we simply call LeftAndMain::menu_title_for_class() again
// if we're dealing with a controller
if ( $menuItem -> controller ) {
$defaultTitle = LeftAndMain :: menu_title_for_class ( $menuItem -> controller );
$title = _t ( " { $menuItem -> controller } .MENUTITLE " , $defaultTitle );
} else {
$title = $menuItem -> title ;
}
$menu -> push ( new ArrayData ( array (
" MenuItem " => $menuItem ,
" Title " => Convert :: raw2xml ( $title ),
" Code " => DBField :: create ( 'Text' , $code ),
" Link " => $menuItem -> url ,
" LinkingMode " => $linkingmode
)));
2011-03-23 10:51:00 +01:00
}
}
2011-07-28 06:57:41 +02:00
2011-03-23 10:51:00 +01:00
// if no current item is found, assume that first item is shown
//if(!isset($foundCurrent))
return $menu ;
}
2011-04-15 04:12:57 +02:00
public function Menu () {
return $this -> renderWith ( $this -> getTemplatesWithSuffix ( '_Menu' ));
2011-03-23 10:51:00 +01:00
}
/**
* Return a list of appropriate templates for this class , with the given suffix
*/
protected function getTemplatesWithSuffix ( $suffix ) {
$classes = array_reverse ( ClassInfo :: ancestry ( $this -> class ));
foreach ( $classes as $class ) {
$templates [] = $class . $suffix ;
if ( $class == 'LeftAndMain' ) break ;
}
return $templates ;
}
2011-04-15 04:12:57 +02:00
public function Content () {
return $this -> renderWith ( $this -> getTemplatesWithSuffix ( '_Content' ));
2011-03-23 10:51:00 +01:00
}
public function getRecord ( $id ) {
$className = $this -> stat ( 'tree_class' );
2011-04-19 08:44:46 +02:00
if ( $className && $id instanceof $className ) {
2011-03-23 10:51:00 +01:00
return $id ;
2011-05-02 02:36:16 +02:00
} else if ( $id == 'root' ) {
return singleton ( $className );
2011-03-23 10:51:00 +01:00
} else if ( is_numeric ( $id )) {
return DataObject :: get_by_id ( $className , $id );
} else {
return false ;
}
}
/**
* @ return String HTML
*/
public function SiteTreeAsUL () {
return $this -> getSiteTreeFor ( $this -> stat ( 'tree_class' ));
}
/**
* Get a site tree HTML listing which displays the nodes under the given criteria .
*
* @ param $className The class of the root object
* @ param $rootID The ID of the root object . If this is null then a complete tree will be
* shown
* @ param $childrenMethod The method to call to get the children of the tree . For example ,
* Children , AllChildrenIncludingDeleted , or AllHistoricalChildren
* @ return String Nested unordered list with links to each page
*/
function getSiteTreeFor ( $className , $rootID = null , $childrenMethod = null , $numChildrenMethod = null , $filterFunction = null , $minNodeCount = 30 ) {
// Default childrenMethod and numChildrenMethod
if ( ! $childrenMethod ) $childrenMethod = 'AllChildrenIncludingDeleted' ;
if ( ! $numChildrenMethod ) $numChildrenMethod = 'numChildren' ;
// Get the tree root
2011-04-22 07:42:40 +02:00
$record = ( $rootID ) ? $this -> getRecord ( $rootID ) : null ;
$obj = $record ? $record : singleton ( $className );
2011-03-23 10:51:00 +01:00
// Mark the nodes of the tree to return
if ( $filterFunction ) $obj -> setMarkingFilterFunction ( $filterFunction );
$obj -> markPartialTree ( $minNodeCount , $this , $childrenMethod , $numChildrenMethod );
// Ensure current page is exposed
if ( $p = $this -> currentPage ()) $obj -> markToExpose ( $p );
// NOTE: SiteTree/CMSMain coupling :-(
2011-03-29 06:54:58 +02:00
if ( class_exists ( 'SiteTree' )) {
SiteTree :: prepopuplate_permission_cache ( 'CanEditType' , $obj -> markedNodeIDs (), 'SiteTree::can_edit_multiple' );
}
2011-03-23 10:51:00 +01:00
// getChildrenAsUL is a flexible and complex way of traversing the tree
$titleEval = '
" <li id= \" record- $child->ID\ " data - id = \ " $child->ID\ " class = \ " " . $child -> CMSTreeClasses ( $extraArg ) . " \" > " .
" <ins class= \" jstree-icon \" > </ins> " .
2011-06-09 05:48:13 +02:00
" <a href= \" " . Controller :: join_links ( $extraArg -> Link ( " show " ), $child -> ID ) . " \" title= \" '
2011-03-23 10:51:00 +01:00
. _t ( 'LeftAndMain.PAGETYPE' , 'Page type: ' )
. ' " . $child->class . " \ " ><ins class= \" jstree-icon \" > </ins> " . ( $child -> TreeTitle ) .
" </a> "
' ;
$html = $obj -> getChildrenAsUL (
" " ,
$titleEval ,
$this ,
true ,
$childrenMethod ,
$numChildrenMethod ,
$minNodeCount
);
// Wrap the root if needs be.
if ( ! $rootID ) {
$rootLink = $this -> Link ( 'show' ) . '/root' ;
// This lets us override the tree title with an extension
if ( $this -> hasMethod ( 'getCMSTreeTitle' ) && $customTreeTitle = $this -> getCMSTreeTitle ()) {
$treeTitle = $customTreeTitle ;
2011-03-24 09:39:47 +01:00
} elseif ( class_exists ( 'SiteConfig' )) {
2011-03-23 10:51:00 +01:00
$siteConfig = SiteConfig :: current_site_config ();
$treeTitle = $siteConfig -> Title ;
2011-03-24 09:39:47 +01:00
} else {
$treeTitle = '...' ;
2011-03-23 10:51:00 +01:00
}
2011-12-18 16:57:26 +01:00
$html = " <ul><li id= \" record-0 \" data-id= \" 0 \" class= \" Root nodelete \" ><a href= \" $rootLink\ " >< strong > $treeTitle </ strong ></ a > "
2011-03-23 10:51:00 +01:00
. $html . " </li></ul> " ;
}
return $html ;
}
/**
* Get a subtree underneath the request param 'ID' .
* If ID = 0 , then get the whole tree .
*/
public function getsubtree ( $request ) {
if ( $filterClass = $request -> requestVar ( 'FilterClass' )) {
if ( ! is_subclass_of ( $filterClass , 'CMSSiteTreeFilter' )) {
throw new Exception ( sprintf ( 'Invalid filter class passed: %s' , $filterClass ));
}
$filter = new $filterClass ( $request -> requestVars ());
} else {
$filter = null ;
}
$html = $this -> getSiteTreeFor (
$this -> stat ( 'tree_class' ),
$request -> getVar ( 'ID' ),
( $filter ) ? $filter -> getChildrenMethod () : null ,
null ,
( $filter ) ? array ( $filter , 'isPageIncluded' ) : null ,
$request -> getVar ( 'minNodeCount' )
);
// Trim off the outer tag
$html = preg_replace ( '/^[\s\t\r\n]*<ul[^>]*>/' , '' , $html );
$html = preg_replace ( '/<\/ul[^>]*>[\s\t\r\n]*$/' , '' , $html );
return $html ;
}
/**
* Save handler
*/
public function save ( $data , $form ) {
$className = $this -> stat ( 'tree_class' );
// Existing or new record?
$SQL_id = Convert :: raw2sql ( $data [ 'ID' ]);
if ( substr ( $SQL_id , 0 , 3 ) != 'new' ) {
$record = DataObject :: get_by_id ( $className , $SQL_id );
if ( $record && ! $record -> canEdit ()) return Security :: permissionFailure ( $this );
2011-10-07 12:27:56 +02:00
if ( ! $record || ! $record -> ID ) throw new HTTPResponse_Exception ( " Bad record ID # " . ( int ) $data [ 'ID' ], 404 );
2011-03-23 10:51:00 +01:00
} else {
if ( ! singleton ( $this -> stat ( 'tree_class' )) -> canCreate ()) return Security :: permissionFailure ( $this );
$record = $this -> getNewItem ( $SQL_id , false );
}
// save form data into record
$form -> saveInto ( $record , true );
$record -> write ();
$this -> extend ( 'onAfterSave' , $record );
$this -> response -> addHeader ( 'X-Status' , _t ( 'LeftAndMain.SAVEDUP' ));
// write process might've changed the record, so we reload before returning
$form = $this -> getEditForm ( $record -> ID );
2011-06-08 01:35:56 +02:00
return $form -> forTemplate ();
2011-03-23 10:51:00 +01:00
}
2011-04-19 11:16:56 +02:00
public function delete ( $data , $form ) {
$className = $this -> stat ( 'tree_class' );
$record = DataObject :: get_by_id ( $className , Convert :: raw2sql ( $data [ 'ID' ]));
if ( $record && ! $record -> canDelete ()) return Security :: permissionFailure ();
2011-10-07 12:27:56 +02:00
if ( ! $record || ! $record -> ID ) throw new HTTPResponse_Exception ( " Bad record ID # " . ( int ) $data [ 'ID' ], 404 );
2011-04-19 11:16:56 +02:00
$record -> delete ();
if ( $this -> isAjax ()) {
2011-06-08 01:35:56 +02:00
return $this -> EmptyForm () -> forTemplate ();
2011-04-19 11:16:56 +02:00
} else {
$this -> redirectBack ();
}
}
2011-03-23 10:51:00 +01:00
/**
* Update the position and parent of a tree node .
* Only saves the node if changes were made .
*
* Required data :
* - 'ID' : The moved node
* - 'ParentID' : New parent relation of the moved node ( 0 for root )
* - 'SiblingIDs' : Array of all sibling nodes to the moved node ( incl . the node itself ) .
* In case of a 'ParentID' change , relates to the new siblings under the new parent .
*
* @ return SS_HTTPResponse JSON string with a
*/
public function savetreenode ( $request ) {
if ( ! Permission :: check ( 'SITETREE_REORGANISE' ) && ! Permission :: check ( 'ADMIN' )) {
$this -> response -> setStatusCode (
403 ,
_t ( 'LeftAndMain.CANT_REORGANISE' , " You do not have permission to rearange the site tree. Your change was not saved. " )
);
return ;
}
$className = $this -> stat ( 'tree_class' );
$statusUpdates = array ( 'modified' => array ());
$id = $request -> requestVar ( 'ID' );
$parentID = $request -> requestVar ( 'ParentID' );
$siblingIDs = $request -> requestVar ( 'SiblingIDs' );
$statusUpdates = array ( 'modified' => array ());
if ( ! is_numeric ( $id ) || ! is_numeric ( $parentID )) throw new InvalidArgumentException ();
$node = DataObject :: get_by_id ( $className , $id );
if ( $node && ! $node -> canEdit ()) return Security :: permissionFailure ( $this );
if ( ! $node ) {
$this -> response -> setStatusCode (
500 ,
_t (
'LeftAndMain.PLEASESAVE' ,
" Please Save Page: This page could not be upated because it hasn't been saved yet. "
)
);
return ;
}
// Update hierarchy (only if ParentID changed)
if ( $node -> ParentID != $parentID ) {
$node -> ParentID = ( int ) $parentID ;
$node -> write ();
$statusUpdates [ 'modified' ][ $node -> ID ] = array (
'TreeTitle' => $node -> TreeTitle
);
// Update all dependent pages
2011-03-29 06:54:58 +02:00
if ( class_exists ( 'VirtualPage' )) {
if ( $virtualPages = DataObject :: get ( " VirtualPage " , " \" CopyContentFromID \" = $node->ID " )) {
foreach ( $virtualPages as $virtualPage ) {
$statusUpdates [ 'modified' ][ $virtualPage -> ID ] = array (
'TreeTitle' => $virtualPage -> TreeTitle ()
);
}
2011-03-23 10:51:00 +01:00
}
}
$this -> response -> addHeader ( 'X-Status' , _t ( 'LeftAndMain.SAVED' , 'saved' ));
}
// Update sorting
if ( is_array ( $siblingIDs )) {
$counter = 0 ;
foreach ( $siblingIDs as $id ) {
if ( $id == $node -> ID ) {
$node -> Sort = ++ $counter ;
$node -> write ();
$statusUpdates [ 'modified' ][ $node -> ID ] = array (
'TreeTitle' => $node -> TreeTitle
);
} else if ( is_numeric ( $id )) {
// Nodes that weren't "actually moved" shouldn't be registered as
// having been edited; do a direct SQL update instead
++ $counter ;
DB :: query ( sprintf ( " UPDATE \" %s \" SET \" Sort \" = %d WHERE \" ID \" = '%d' " , $className , $counter , $id ));
}
}
$this -> response -> addHeader ( 'X-Status' , _t ( 'LeftAndMain.SAVED' , 'saved' ));
}
return Convert :: raw2json ( $statusUpdates );
}
public function CanOrganiseSitetree () {
return ! Permission :: check ( 'SITETREE_REORGANISE' ) && ! Permission :: check ( 'ADMIN' ) ? false : true ;
}
/**
* Retrieves an edit form , either for display , or to process submitted data .
* Also used in the template rendered through { @ link Right ()} in the $EditForm placeholder .
*
* This is a " pseudo-abstract " methoed , usually connected to a { @ link getEditForm ()}
* method in an entwine subclass . This method can accept a record identifier ,
* selected either in custom logic , or through { @ link currentPageID ()} .
* The form usually construct itself from { @ link DataObject -> getCMSFields ()}
* for the specific managed subclass defined in { @ link LeftAndMain :: $tree_class } .
*
* @ param HTTPRequest $request Optionally contains an identifier for the
* record to load into the form .
* @ return Form Should return a form regardless wether a record has been found .
* Form might be readonly if the current user doesn ' t have the permission to edit
* the record .
*/
/**
* @ return Form
*/
function EditForm ( $request = null ) {
return $this -> getEditForm ();
}
2011-04-15 05:32:43 +02:00
/**
* Calls { @ link SiteTree -> getCMSFields ()}
*
* @ param Int $id
2011-05-11 09:51:54 +02:00
* @ param FieldList $fields
2011-04-15 05:32:43 +02:00
* @ return Form
*/
public function getEditForm ( $id = null , $fields = null ) {
2011-03-23 10:51:00 +01:00
if ( ! $id ) $id = $this -> currentPageID ();
if ( is_object ( $id )) {
$record = $id ;
} else {
2011-05-02 02:36:16 +02:00
$record = $this -> getRecord ( $id );
2011-03-23 10:51:00 +01:00
if ( $record && ! $record -> canView ()) return Security :: permissionFailure ( $this );
}
if ( $record ) {
2011-04-15 05:32:43 +02:00
$fields = ( $fields ) ? $fields : $record -> getCMSFields ();
2011-03-23 10:51:00 +01:00
if ( $fields == null ) {
user_error (
2011-10-28 03:37:27 +02:00
" getCMSFields() returned null - it should return a FieldList object.
2011-03-23 10:51:00 +01:00
Perhaps you forgot to put a return statement at the end of your method ? " ,
E_USER_ERROR
);
}
// Add hidden fields which are required for saving the record
// and loading the UI state
if ( ! $fields -> dataFieldByName ( 'ClassName' )) {
$fields -> push ( new HiddenField ( 'ClassName' ));
}
if (
Object :: has_extension ( $this -> stat ( 'tree_class' ), 'Hierarchy' )
&& ! $fields -> dataFieldByName ( 'ParentID' )
) {
$fields -> push ( new HiddenField ( 'ParentID' ));
}
2011-07-21 20:14:33 +02:00
// Added in-line to the form, but plucked into different view by LeftAndMain.Preview.js upon load
if ( in_array ( 'CMSPreviewable' , class_implements ( $record ))) {
$navField = new LiteralField ( 'SilverStripeNavigator' , $this -> getSilverStripeNavigator ());
$navField -> setAllowHTML ( true );
$fields -> push ( $navField );
}
2011-03-23 10:51:00 +01:00
if ( $record -> hasMethod ( 'getAllCMSActions' )) {
$actions = $record -> getAllCMSActions ();
} else {
$actions = $record -> getCMSActions ();
// add default actions if none are defined
if ( ! $actions || ! $actions -> Count ()) {
2011-04-19 11:16:56 +02:00
if ( $record -> hasMethod ( 'canDelete' ) && $record -> canDelete ()) {
$actions -> push ( $deleteAction = new FormAction ( 'delete' , _t ( 'ModelAdmin.DELETE' , 'Delete' )));
$deleteAction -> addExtraClass ( 'ss-ui-action-destructive' );
}
2011-04-19 08:44:46 +02:00
if ( $record -> hasMethod ( 'canEdit' ) && $record -> canEdit ()) {
2011-04-19 11:16:56 +02:00
$actions -> push ( $saveAction = new FormAction ( 'save' , _t ( 'CMSMain.SAVE' , 'Save' )));
$saveAction -> addExtraClass ( 'ss-ui-action-constructive' );
2011-03-23 10:51:00 +01:00
}
}
}
$form = new Form ( $this , " EditForm " , $fields , $actions );
2011-03-31 10:52:29 +02:00
$form -> addExtraClass ( 'cms-edit-form' );
2011-03-23 10:51:00 +01:00
$form -> loadDataFrom ( $record );
2011-10-29 21:56:33 +02:00
$form -> setTemplate ( $this -> getTemplatesWithSuffix ( '_EditForm' ));
2011-03-23 10:51:00 +01:00
2011-10-29 21:59:21 +02:00
// Set this if you want to split up tabs into a separate header row
// if($form->Fields()->hasTabset()) $form->Fields()->findOrMakeTab('Root')->setTemplate('CMSTabSet');
2011-03-23 10:51:00 +01:00
// Add a default or custom validator.
// @todo Currently the default Validator.js implementation
// adds javascript to the document body, meaning it won't
// be included properly if the associated fields are loaded
// through ajax. This means only serverside validation
// will kick in for pages+validation loaded through ajax.
// This will be solved by using less obtrusive javascript validation
// in the future, see http://open.silverstripe.com/ticket/2915 and
// http://open.silverstripe.com/ticket/3386
if ( $record -> hasMethod ( 'getCMSValidator' )) {
$validator = $record -> getCMSValidator ();
// The clientside (mainly LeftAndMain*.js) rely on ajax responses
// which can be evaluated as javascript, hence we need
// to override any global changes to the validation handler.
$validator -> setJavascriptValidationHandler ( 'prototype' );
$form -> setValidator ( $validator );
} else {
$form -> unsetValidator ();
}
2011-04-19 08:44:46 +02:00
if ( $record -> hasMethod ( 'canEdit' ) && ! $record -> canEdit ()) {
2011-03-23 10:51:00 +01:00
$readonlyFields = $form -> Fields () -> makeReadonly ();
$form -> setFields ( $readonlyFields );
}
} else {
$form = $this -> RootForm ();
}
return $form ;
}
function RootForm () {
return $this -> EmptyForm ();
}
/**
* Returns a placeholder form , used by { @ link getEditForm ()} if no record is selected .
* Our javascript logic always requires a form to be present in the CMS interface .
*
* @ return Form
*/
function EmptyForm () {
$form = new Form (
$this ,
" EditForm " ,
2011-05-11 09:51:54 +02:00
new FieldList (
2011-04-24 01:30:28 +02:00
// new HeaderField(
// 'WelcomeHeader',
// $this->getApplicationName()
// ),
// new LiteralField(
// 'WelcomeText',
// sprintf('<p id="WelcomeMessage">%s %s. %s</p>',
// _t('LeftAndMain_right.ss.WELCOMETO','Welcome to'),
// $this->getApplicationName(),
// _t('CHOOSEPAGE','Please choose an item from the left.')
// )
// )
2011-03-23 10:51:00 +01:00
),
2011-05-11 09:51:54 +02:00
new FieldList ()
2011-03-23 10:51:00 +01:00
);
$form -> unsetValidator ();
2011-03-31 10:52:29 +02:00
$form -> addExtraClass ( 'cms-edit-form' );
$form -> addExtraClass ( 'root-form' );
2011-04-15 05:32:43 +02:00
$form -> setTemplate ( $this -> getTemplatesWithSuffix ( '_EditForm' ));
2011-03-23 10:51:00 +01:00
return $form ;
}
/**
* @ return Form
*/
function AddForm () {
$class = $this -> stat ( 'tree_class' );
$typeMap = array ( $class => singleton ( $class ) -> i18n_singular_name ());
$form = new Form (
$this ,
'AddForm' ,
2011-05-11 09:51:54 +02:00
new FieldList (
2011-04-17 09:57:36 +02:00
new HiddenField ( 'ParentID' )
2011-03-23 10:51:00 +01:00
),
2011-05-11 09:51:54 +02:00
new FieldList (
2011-04-17 09:57:36 +02:00
$addAction = new FormAction ( 'doAdd' , _t ( 'AssetAdmin_left.ss.GO' , 'Go' ))
2011-03-23 10:51:00 +01:00
)
);
2011-04-17 09:57:36 +02:00
$addAction -> addExtraClass ( 'ss-ui-action-constructive' );
2011-03-31 10:52:29 +02:00
$form -> addExtraClass ( 'add-form' );
2011-03-23 10:51:00 +01:00
return $form ;
}
/**
* Add a new group and return its details suitable for ajax .
*/
public function doAdd ( $data , $form ) {
$class = $this -> stat ( 'tree_class' );
// check create permissions
if ( ! singleton ( $class ) -> canCreate ()) return Security :: permissionFailure ( $this );
// check addchildren permissions
if (
singleton ( $class ) -> hasDatabaseField ( 'Hierarchy' )
&& isset ( $data [ 'ParentID' ])
&& is_numeric ( $data [ 'ParentID' ])
) {
$parentRecord = DataObject :: get_by_id ( $class , $data [ 'ParentID' ]);
if (
$parentRecord -> hasMethod ( 'canAddChildren' )
&& ! $parentRecord -> canAddChildren ()
) return Security :: permissionFailure ( $this );
}
$record = Object :: create ( $class );
$form -> saveInto ( $record );
$record -> write ();
// Used in TinyMCE inline folder creation
if ( isset ( $data [ 'returnID' ])) {
return $record -> ID ;
} else if ( $this -> isAjax ()) {
$form = $this -> getEditForm ( $record -> ID );
2011-06-08 01:35:56 +02:00
return $form -> forTemplate ();
2011-03-23 10:51:00 +01:00
} else {
return $this -> redirect ( Controller :: join_links ( $this -> Link ( 'show' ), $record -> ID ));
}
}
/**
* Batch Actions Handler
*/
function batchactions () {
return new CMSBatchActionHandler ( $this , 'batchactions' , $this -> stat ( 'tree_class' ));
}
/**
* @ return Form
*/
function BatchActionsForm () {
$actions = $this -> batchactions () -> batchActionList ();
2011-04-22 13:34:01 +02:00
$actionsMap = array ( '-1' => _t ( 'LeftAndMain.DropdownBatchActionsDefault' , 'Actions' ));
2011-03-23 10:51:00 +01:00
foreach ( $actions as $action ) $actionsMap [ $action -> Link ] = $action -> Title ;
$form = new Form (
$this ,
'BatchActionsForm' ,
2011-05-11 09:51:54 +02:00
new FieldList (
2011-03-23 10:51:00 +01:00
new HiddenField ( 'csvIDs' ),
new DropdownField (
'Action' ,
false ,
$actionsMap
)
),
2011-05-11 09:51:54 +02:00
new FieldList (
2011-03-23 10:51:00 +01:00
// TODO i18n
new FormAction ( 'submit' , " Go " )
)
);
2011-04-24 01:05:59 +02:00
$form -> addExtraClass ( 'cms-batch-actions nostyle' );
2011-03-23 10:51:00 +01:00
$form -> unsetValidator ();
return $form ;
}
public function myprofile () {
$form = $this -> Member_ProfileForm ();
return $this -> customise ( array (
2011-04-15 05:32:43 +02:00
'Content' => ' ' ,
2011-03-23 10:51:00 +01:00
'Form' => $form
)) -> renderWith ( 'BlankPage' );
}
public function Member_ProfileForm () {
return new Member_ProfileForm ( $this , 'Member_ProfileForm' , Member :: currentUser ());
}
public function printable () {
$form = $this -> getEditForm ( $this -> currentPageID ());
if ( ! $form ) return false ;
$form -> transform ( new PrintableTransformation ());
$form -> setActions ( null );
Requirements :: clear ();
2011-03-23 11:07:31 +01:00
Requirements :: css ( SAPPHIRE_ADMIN_DIR . '/css/LeftAndMain_printable.css' );
2011-03-23 10:51:00 +01:00
return array (
" PrintForm " => $form
);
}
2011-07-21 20:14:33 +02:00
/**
* Used for preview controls , mainly links which switch between different states of the page .
*
* @ return ArrayData
*/
function getSilverStripeNavigator () {
$page = $this -> currentPage ();
if ( $page ) {
$navigator = new SilverStripeNavigator ( $page );
return $navigator -> renderWith ( $this -> getTemplatesWithSuffix ( '_SilverStripeNavigator' ));
} else {
return false ;
}
}
2011-03-23 10:51:00 +01:00
/**
* Identifier for the currently shown record ,
* in most cases a database ID . Inspects the following
* sources ( in this order ) :
* - GET / POST parameter named 'ID'
* - URL parameter named 'ID'
* - Session value namespaced by classname , e . g . " CMSMain.currentPage "
*
* @ return int
*/
public function currentPageID () {
if ( $this -> request -> requestVar ( 'ID' )) {
return $this -> request -> requestVar ( 'ID' );
} elseif ( $this -> request -> param ( 'ID' ) && is_numeric ( $this -> request -> param ( 'ID' ))) {
return $this -> request -> param ( 'ID' );
} elseif ( Session :: get ( " { $this -> class } .currentPage " )) {
return Session :: get ( " { $this -> class } .currentPage " );
} else {
return null ;
}
}
/**
* Forces the current page to be set in session ,
* which can be retrieved later through { @ link currentPageID ()} .
* Keep in mind that setting an ID through GET / POST or
* as a URL parameter will overrule this value .
*
* @ param int $id
*/
public function setCurrentPageID ( $id ) {
Session :: set ( " { $this -> class } .currentPage " , $id );
}
/**
* Uses { @ link getRecord ()} and { @ link currentPageID ()}
* to get the currently selected record .
*
* @ return DataObject
*/
public function currentPage () {
return $this -> getRecord ( $this -> currentPageID ());
}
/**
* Compares a given record to the currently selected one ( if any ) .
* Used for marking the current tree node .
*
* @ return boolean
*/
public function isCurrentPage ( DataObject $record ) {
return ( $record -> ID == $this -> currentPageID ());
}
/**
2011-05-15 05:43:21 +02:00
* URL to a previewable record which is shown through this controller .
* The controller might not have any previewable content , in which case
* this method returns FALSE .
*
* @ return String | boolean
2011-03-23 10:51:00 +01:00
*/
2011-05-15 05:43:21 +02:00
public function PreviewLink () {
2011-10-29 19:12:33 +02:00
return false ;
2011-05-15 05:43:21 +02:00
}
2011-03-23 10:51:00 +01:00
/**
* Return the version number of this application .
* Uses the subversion path information in < mymodule >/ silverstripe_version
* ( automacially replaced $URL $ placeholder ) .
*
* @ return string
*/
public function CMSVersion () {
2011-03-29 10:34:26 +02:00
$sapphireVersionFile = file_get_contents ( BASE_PATH . '/sapphire/silverstripe_version' );
2011-03-23 10:51:00 +01:00
$sapphireVersion = $this -> versionFromVersionFile ( $sapphireVersionFile );
2011-03-29 10:34:26 +02:00
return " sapphire: $sapphireVersion " ;
2011-03-23 10:51:00 +01:00
}
/**
* Return the version from the content of a silverstripe_version file
*/
public function versionFromVersionFile ( $fileContent ) {
if ( preg_match ( '/\/trunk\/silverstripe_version/' , $fileContent )) {
return " trunk " ;
} else {
preg_match ( " / \ /(?:branches|tags \ /rc|tags \ /beta|tags \ /alpha|tags) \ /([A-Za-z0-9._-]+) \ /silverstripe_version/ " , $fileContent , $matches );
return ( $matches ) ? $matches [ 1 ] : null ;
}
}
/**
* @ return array
*/
function SwitchView () {
if ( $page = $this -> currentPage ()) {
$nav = SilverStripeNavigator :: get_for_record ( $page );
return $nav [ 'items' ];
}
}
2011-04-15 04:12:57 +02:00
/**
* @ return SiteConfig
*/
function SiteConfig () {
2011-05-01 12:20:30 +02:00
return ( class_exists ( 'SiteConfig' )) ? SiteConfig :: current_site_config () : null ;
2011-04-15 04:12:57 +02:00
}
2011-03-23 10:51:00 +01:00
/**
* The application name . Customisable by calling
* LeftAndMain :: setApplicationName () - the first parameter .
*
* @ var String
*/
static $application_name = 'SilverStripe CMS' ;
/**
* @ param String $name
*/
2011-03-31 01:06:46 +02:00
static function setApplicationName ( $name ) {
2011-03-23 10:51:00 +01:00
self :: $application_name = $name ;
}
/**
* Get the application name .
2011-08-22 06:44:41 +02:00
*
* @ return string
2011-03-23 10:51:00 +01:00
*/
function getApplicationName () {
return self :: $application_name ;
}
2011-06-09 05:47:59 +02:00
/**
2011-08-22 06:44:41 +02:00
* @ return string
2011-06-09 05:47:59 +02:00
*/
function Title () {
2011-08-22 06:44:41 +02:00
$app = $this -> getApplicationName ();
return ( $section = $this -> SectionTitle ()) ? sprintf ( '%s - %s' , $app , $section ) : $app ;
2011-06-09 05:47:59 +02:00
}
2011-03-23 10:51:00 +01:00
/**
2011-08-22 06:44:41 +02:00
* Return the title of the current section . Either this is pulled from
* the current panel ' s menu_title or from the first active menu
*
* @ return string
2011-03-23 10:51:00 +01:00
*/
function SectionTitle () {
2011-08-22 06:44:41 +02:00
if ( $title = $this -> stat ( 'menu_title' )) return $title ;
2011-03-23 10:51:00 +01:00
// Get menu - use obj() to cache it in the same place as the template engine
$menu = $this -> obj ( 'MainMenu' );
2011-08-22 06:44:41 +02:00
2011-03-23 10:51:00 +01:00
foreach ( $menu as $menuItem ) {
2011-08-22 06:44:41 +02:00
if ( $menuItem -> LinkingMode != 'link' ) return $menuItem -> Title ;
2011-03-23 10:51:00 +01:00
}
}
/**
* Return the base directory of the tiny_mce codebase
*/
function MceRoot () {
return MCE_ROOT ;
}
2011-07-04 16:36:24 +02:00
/**
* Same as { @ link ViewableData -> CSSClasses ()}, but with a changed name
* to avoid problems when using { @ link ViewableData -> customise ()}
* ( which always returns " ArrayData " from the $original object ) .
*
* @ return String
*/
function BaseCSSClasses () {
return $this -> CSSClasses ();
}
2011-05-15 05:43:21 +02:00
function IsPreviewExpanded () {
return ( $this -> request -> getVar ( 'cms-preview-expanded' ));
}
2011-12-18 16:57:26 +01:00
/**
* @ return String
*/
function Locale () {
return DBField :: create ( 'DBLocale' , $this -> i18nLocale ());
}
2011-05-15 05:43:21 +02:00
2011-03-23 10:51:00 +01:00
/**
* Register the given javascript file as required in the CMS .
* Filenames should be relative to the base , eg , SAPPHIRE_DIR . '/javascript/loader.js'
*/
public static function require_javascript ( $file ) {
self :: $extra_requirements [ 'javascript' ][] = array ( $file );
}
/**
* Register the given stylesheet file as required .
*
* @ param $file String Filenames should be relative to the base , eg , THIRDPARTY_DIR . '/tree/tree.css'
* @ param $media String Comma - separated list of media - types ( e . g . " screen,projector " )
* @ see http :// www . w3 . org / TR / REC - CSS2 / media . html
*/
public static function require_css ( $file , $media = null ) {
self :: $extra_requirements [ 'css' ][] = array ( $file , $media );
}
/**
* Register the given " themeable stylesheet " as required .
* Themeable stylesheets have globally unique names , just like templates and PHP files .
* Because of this , they can be replaced by similarly named CSS files in the theme directory .
*
* @ param $name String The identifier of the file . For example , css / MyFile . css would have the identifier " MyFile "
* @ param $media String Comma - separated list of media - types ( e . g . " screen,projector " )
*/
static function require_themed_css ( $name , $media = null ) {
self :: $extra_requirements [ 'themedcss' ][] = array ( $name , $media );
}
}
/**
* @ package cms
* @ subpackage core
*/
class LeftAndMainMarkingFilter {
/**
* @ var array Request params ( unsanitized )
*/
protected $params = array ();
/**
* @ param array $params Request params ( unsanitized )
*/
function __construct ( $params = null ) {
$this -> ids = array ();
$this -> expanded = array ();
$parents = array ();
$q = $this -> getQuery ( $params );
$res = $q -> execute ();
if ( ! $res ) return ;
// And keep a record of parents we don't need to get parents
// of themselves, as well as IDs to mark
foreach ( $res as $row ) {
if ( $row [ 'ParentID' ]) $parents [ $row [ 'ParentID' ]] = true ;
$this -> ids [ $row [ 'ID' ]] = true ;
}
// We need to recurse up the tree,
// finding ParentIDs for each ID until we run out of parents
while ( ! empty ( $parents )) {
$res = DB :: query ( 'SELECT "ParentID", "ID" FROM "SiteTree" WHERE "ID" in (' . implode ( ',' , array_keys ( $parents )) . ')' );
$parents = array ();
foreach ( $res as $row ) {
if ( $row [ 'ParentID' ]) $parents [ $row [ 'ParentID' ]] = true ;
$this -> ids [ $row [ 'ID' ]] = true ;
$this -> expanded [ $row [ 'ID' ]] = true ;
}
}
}
protected function getQuery ( $params ) {
$where = array ();
$SQL_params = Convert :: raw2sql ( $params );
if ( isset ( $SQL_params [ 'ID' ])) unset ( $SQL_params [ 'ID' ]);
foreach ( $SQL_params as $name => $val ) {
switch ( $name ) {
default :
// Partial string match against a variety of fields
if ( ! empty ( $val ) && singleton ( " SiteTree " ) -> hasDatabaseField ( $name )) {
$where [] = " \" $name\ " LIKE '%$val%' " ;
}
}
}
return new SQLQuery (
array ( " ParentID " , " ID " ),
'SiteTree' ,
$where
);
}
function mark ( $node ) {
$id = $node -> ID ;
if ( array_key_exists (( int ) $id , $this -> expanded )) $node -> markOpened ();
return array_key_exists (( int ) $id , $this -> ids ) ? $this -> ids [ $id ] : false ;
}
}
?>