tslib_menu Class Reference

Inherited by tslib_gmenu, tslib_imgmenu, tslib_jsmenu, and tslib_tmenu.

List of all members.

Public Member Functions
	start (&$tmpl, &$sys_page, $id, $conf, $menuNumber)
	The initialization of the object.
	makeMenu ()
	Creates the menu in the internal variables, ready for output.
	includeMakeMenu ($conf, $altSortField)
	Includes the PHP script defined for the HMENU special type "userdefined".
	filterMenuPages (&$data, $banUidArray, $spacer)
	Checks if a page is OK to include in the final menu item array.
	procesItemStates ($splitCount)
	Generating the per-menu-item configuration arrays based on the settings for item states (NO, RO, ACT, CUR etc) set in ->mconf (config for the current menu object) Basically it will produce an individual array for each menu item based on the item states.
	link ($key, $altTarget='', $typeOverride='')
	Creates the URL, target and onclick values for the menu item link.
	subMenu ($uid)
	Creates a submenu level to the current level - if configured for.
	isNext ($uid, $MPvar='')
	Returns true if the page with UID $uid is the NEXT page in root line (which means a submenu should be drawn).
	isActive ($uid, $MPvar='')
	Returns true if the page with UID $uid is active (in the current rootline).
	isCurrent ($uid, $MPvar='')
	Returns true if the page with UID $uid is the CURRENT page (equals $GLOBALS['TSFE']->id).
	isSubMenu ($uid)
	Returns true if there is a submenu with items for the page id, $uid Used by the item states "IFSUB" and "ACTIFSUB" to check if there is a submenu.
	isItemState ($kind, $key)
	Used by procesItemStates() to evaluate if a menu item (identified by $key) is in a certain state.
	accessKey ($title)
	Creates an access-key for a GMENU menu item based on the menu item titles first letter.
	userProcess ($mConfKey, $passVar)
	Calls a user function for processing of internal data.
	setATagParts ()
	Creates the tag parts for the current item (in $this->I, [A1] and [A2]) based on other information in this array (like $this->I['linkHREF']).
	getPageTitle ($title, $nav_title)
	Returns the title for the navigation.
	getMPvar ($key)
	Return MPvar string for entry $key in ->menuArr.
	getDoktypeExcludeWhere ()
	Returns where clause part to exclude 'not in menu' pages.
Public Attributes
	$menuNumber = 1
	$entryLevel = 0
	$subLevelClass = ''
	$spacerIDList = '199'
	$doktypeExcludeList = '56'
	$alwaysActivePIDlist = array()
	$imgNamePrefix = 'img'
	$imgNameNotRandom = 0
	$debug = 0
	$parent_cObj = ''
	$GMENU_fixKey = 'gmenu'
	$MP_array = array()
	$conf = Array()
	$mconf = Array()
	$tmpl
	$sys_page
	$id
	$nextActive
	$menuArr
	$hash
	$result = Array()
	$rL_uidRegister = ''
	$INPfixMD5
	$I
	$WMresult
	$WMfreezePrefix
	$WMmenuItems
	$WMextraScript
	$alternativeMenuTempArray = ''

---

Member Function Documentation

tslib_menu::accessKey (  $  title  )

Creates an access-key for a GMENU menu item based on the menu item titles first letter. Parameters: string  Menu item title. Returns: array Returns an array with keys "code" ("accesskey" attribute for the img-tag) and "alt" (text-addition to the "alt" attribute) if an access key was defined. Otherwise array was empty private Definition at line 1303 of file class.tslib_menu.php. References $a, $key, $result, and accessKey(). Referenced by accessKey(), and setATagParts(). { // The global array ACCESSKEY is used to globally control if letters are already used!! $result = Array(); $titleLen = strlen($title); for ($a=0;$a<$titleLen;$a++) { $key = strtoupper(trim(substr($title,$a,1))); if ($key && !isset($GLOBALS['TSFE']->accessKey[$key])) { $GLOBALS['TSFE']->accessKey[$key]=1; $result['code'] = ' accesskey="'.$key.'"'; $result['alt'] = ' (ALT+'.$key.')'; break; } } return $result; }

tslib_menu::filterMenuPages (  &$  data, $  banUidArray, $  spacer )

Checks if a page is OK to include in the final menu item array. Pages can be excluded if the doktype is wrong, if they are hidden in navigation, have a uid in the list of banned uids etc. Parameters: array  Array of menu items array  Array of page uids which are to be excluded boolean  If set, then the page is a spacer. Returns: boolean Returns true if the page can be safely included. Definition at line 838 of file class.tslib_menu.php. Referenced by makeMenu(). { if ($data['_SAFE']) return TRUE; $uid = $data['uid']; if ($this->mconf['SPC'] || !$spacer) { // If the spacer-function is not enabled, spacers will not enter the $menuArr if (!t3lib_div::inList($this->doktypeExcludeList,$data['doktype'])) { // Page may not be 'not_in_menu' or 'Backend User Section' if (!$data['nav_hide']) { // Not hidden in navigation if (!t3lib_div::inArray($banUidArray,$uid)) { // not in banned uid's // Checks if the default language version can be shown: // Block page is set, if l18n_cfg allows plus: 1) Either default language or 2) another language but NO overlay record set for page! $blockPage = $data['l18n_cfg']&1 && (!$GLOBALS['TSFE']->sys_language_uid || ($GLOBALS['TSFE']->sys_language_uid && !$data['_PAGES_OVERLAY'])); if (!$blockPage) { // Checking if a page should be shown in the menu depending on whether a translation exists: $tok = TRUE; if ($GLOBALS['TSFE']->sys_language_uid && $data['l18n_cfg']&2) { // There is an alternative language active AND the current page requires a translation: if (!$data['_PAGES_OVERLAY']) { $tok = FALSE; } } // Continue if token is true: if ($tok) { // Checking if "&L" should be modified so links to non-accessible pages will not happen. if ($this->conf['protectLvar']) { $Lvar = intval(t3lib_div::_GP('L')); if (($this->conf['protectLvar']=='all' || $data['l18n_cfg']&2) && $Lvar!=$GLOBALS['TSFE']->sys_language_uid) { // page cannot be access in locaization and Lvar is different than sys_language uid - this means we must check! $olRec = $GLOBALS['TSFE']->sys_page->getPageOverlay($data['uid'], $Lvar); if (!count($olRec)) { // If no pages_language_overlay record then page can NOT be accessed in the language pointed to by "&L" and therefore we protect the link by setting "&L=0" $data['_ADD_GETVARS'].= '&L=0'; } } } return TRUE; } } } } } } }

tslib_menu::getDoktypeExcludeWhere (   )

Returns where clause part to exclude 'not in menu' pages. Returns: string where clause part. private Definition at line 1384 of file class.tslib_menu.php. { return $this->doktypeExcludeList ? ' AND pages.doktype NOT IN ('.$this->doktypeExcludeList.')' : ''; }

tslib_menu::getMPvar (  $  key  )

Return MPvar string for entry $key in ->menuArr. Parameters: integer  Pointer to element in ->menuArr string  Implode token. Returns: string MP vars for element. See also: link() Definition at line 1369 of file class.tslib_menu.php. Referenced by link(). { if ($GLOBALS['TYPO3_CONF_VARS']['FE']['enable_mount_pids']) { $localMP_array = $this->MP_array; if ($this->menuArr[$key]['_MP_PARAM']) $localMP_array[] = $this->menuArr[$key]['_MP_PARAM']; // NOTICE: "_MP_PARAM" is allowed to be a commalist of PID pairs! $MP_params = count($localMP_array) ? implode(',',$localMP_array) : ''; return $MP_params; } }

tslib_menu::getPageTitle (  $  title, $  nav_title )

Returns the title for the navigation. Parameters: string  The current page title string  The current value of the naviation title Returns: string Returns the navigation title if it is NOT blank, otherwise the page title. private Definition at line 1357 of file class.tslib_menu.php. { return strcmp(trim($nav_title),'') ? $nav_title : $title; }

tslib_menu::includeMakeMenu (  $  conf, $  altSortField )

Includes the PHP script defined for the HMENU special type "userdefined". This script is supposed to populate the array $menuItemsArray with a set of page records comprising the menu. The "userdefined" type is depreciated since "userfunction" has arrived since and is a better choice for many reasons (like using classes/functions for rendering the menu) Parameters: array  TypoScript parameters for "special.". In particular the property "file" is reserved and specifies the file to include. Seems like any other property can be used freely by the script. string  The sorting field. Can be used from the script in the $incFile. Returns: array An array with the menu items private Definition at line 822 of file class.tslib_menu.php. Referenced by makeMenu(). { $incFile = $GLOBALS['TSFE']->tmpl->getFileName($conf['file']); if ($incFile && $GLOBALS['TSFE']->checkFileInclude($incFile)) { include($incFile); } return is_array($menuItemsArray) ? $menuItemsArray : array(); }

tslib_menu::isActive (  $  uid, $  MPvar = '' )

Returns true if the page with UID $uid is active (in the current rootline). Parameters: integer  Page uid to evaluate. string  MPvar for the current position of item. Returns: boolean True if page with $uid is active private Definition at line 1205 of file class.tslib_menu.php. Referenced by tslib_tmenu_layers::extProc_beforeLinking(), tslib_gmenu_layers::extProc_beforeLinking(), tslib_gmenu_foldout::extProc_beforeLinking(), isItemState(), and link(). { // Check for always active PIDs: if (count($this->alwaysActivePIDlist) && in_array($uid,$this->alwaysActivePIDlist)) { return TRUE; } $testUid = $uid.($MPvar?':'.$MPvar:''); if ($uid && in_array('ITEM:'.$testUid, $this->rL_uidRegister)) { return TRUE; } }

tslib_menu::isCurrent (  $  uid, $  MPvar = '' )

Returns true if the page with UID $uid is the CURRENT page (equals $GLOBALS['TSFE']->id). Parameters: integer  Page uid to evaluate. string  MPvar for the current position of item. Returns: boolean True if page $uid = $GLOBALS['TSFE']->id private Definition at line 1226 of file class.tslib_menu.php. Referenced by isItemState(). { $testUid = $uid.($MPvar?':'.$MPvar:''); if ($uid && !strcmp(end($this->rL_uidRegister),'ITEM:'.$testUid)) { return TRUE; } }

tslib_menu::isItemState (  $  kind, $  key )

Used by procesItemStates() to evaluate if a menu item (identified by $key) is in a certain state. Parameters: string  The item state to evaluate (SPC, IFSUB, ACT etc... but no xxxRO states of course) integer  Key pointing to menu item from ->menuArr Returns: boolean True (integer!=0) if match, otherwise false (=0, zero) private See also: procesItemStates() Definition at line 1266 of file class.tslib_menu.php. References isActive(), isCurrent(), and isSubMenu(). Referenced by procesItemStates(). { $natVal=0; if ($this->menuArr[$key]['ITEM_STATE']) { // If any value is set for ITEM_STATE the normal evaluation is discarded if (!strcmp($this->menuArr[$key]['ITEM_STATE'],$kind)) {$natVal=1;} } else { switch($kind) { case 'SPC': $natVal = $this->menuArr[$key]['isSpacer']; break; case 'IFSUB': $natVal = $this->isSubMenu($this->menuArr[$key]['uid']); break; case 'ACT': $natVal = $this->isActive($this->menuArr[$key]['uid'], $this->getMPvar($key)); break; case 'ACTIFSUB': $natVal = $this->isActive($this->menuArr[$key]['uid'], $this->getMPvar($key)) && $this->isSubMenu($this->menuArr[$key]['uid']); break; case 'CUR': $natVal = $this->isCurrent($this->menuArr[$key]['uid'], $this->getMPvar($key)); break; case 'USR': $natVal = $this->menuArr[$key]['fe_group']; break; } } return $natVal; }

tslib_menu::isNext (  $  uid, $  MPvar = '' )

Returns true if the page with UID $uid is the NEXT page in root line (which means a submenu should be drawn). Parameters: integer  Page uid to evaluate. string  MPvar for the current position of item. Returns: boolean True if page with $uid is active private See also: subMenu() Definition at line 1184 of file class.tslib_menu.php. Referenced by subMenu(). { // Check for always active PIDs: if (count($this->alwaysActivePIDlist) && in_array($uid,$this->alwaysActivePIDlist)) { return TRUE; } $testUid = $uid.($MPvar?':'.$MPvar:''); if ($uid && $testUid==$this->nextActive) { return TRUE; } }

tslib_menu::isSubMenu (  $  uid  )

Returns true if there is a submenu with items for the page id, $uid Used by the item states "IFSUB" and "ACTIFSUB" to check if there is a submenu. Parameters: integer  Page uid for which to search for a submenu Returns: boolean Returns true if there was a submenu with items found private Definition at line 1241 of file class.tslib_menu.php. Referenced by isItemState(). { // Looking for a mount-pid for this UID since if that exists we should look for a subpages THERE and not in the input $uid; $mount_info = $this->sys_page->getMountPointInfo($uid); if (is_array($mount_info)) { $uid = $mount_info['mount_pid']; } $recs = $this->sys_page->getMenu($uid,'uid,pid,doktype,mount_pid,mount_pid_ol'); foreach($recs as $theRec) { if (!t3lib_div::inList($this->doktypeExcludeList,$theRec['doktype']) && !$theRec['nav_hide']) { // If a menu item seems to be another type than 'Not in menu', then return true (there were items!) return TRUE; } } }

tslib_menu::link (  $  key, $  altTarget = '', $  typeOverride = '' )

Creates the URL, target and onclick values for the menu item link. Returns them in an array as key/value pairs for -tag attributes This function doesn't care about the url, because if we let the url be redirected, it will be logged in the stat!!! Parameters: integer  Pointer to a key in the $this->menuArr array where the value for that key represents the menu item we are linking to (page record) string  Alternative target integer  Alternative type Returns: array Returns an array with A-tag attributes as key/value pairs (HREF, TARGET and onClick) private Definition at line 1082 of file class.tslib_menu.php. References $conf, $LD, getMPvar(), and isActive(). Referenced by tslib_tmenu::writeMenu(). { // Mount points: $MP_var = $this->getMPvar($key); $MP_params = $MP_var ? '&MP='.rawurlencode($MP_var) : ''; // Setting override ID if ($this->mconf['overrideId'] || $this->menuArr[$key]['overrideId']) { $overrideArray = array(); // If a user script returned the value overrideId in the menu array we use that as page id $overrideArray['uid'] = $this->mconf['overrideId']?$this->mconf['overrideId']:$this->menuArr[$key]['overrideId']; $overrideArray['alias'] = ''; $MP_params = ''; // clear MP parameters since ID was changed. } else { $overrideArray=''; } // Setting main target: $mainTarget = $altTarget ? $altTarget : $this->mconf['target']; // Creating link: if ($this->mconf['collapse'] && $this->isActive($this->menuArr[$key]['uid'], $this->getMPvar($key))) { $thePage = $this->sys_page->getPage($this->menuArr[$key]['pid']); $LD = $this->tmpl->linkData($thePage,$mainTarget,'','',$overrideArray, $this->mconf['addParams'].$MP_params.$this->menuArr[$key]['_ADD_GETVARS'], $typeOverride); } else { $LD = $this->tmpl->linkData($this->menuArr[$key],$mainTarget,'','',$overrideArray, $this->mconf['addParams'].$MP_params.$this->menuArr[$key]['_ADD_GETVARS'], $typeOverride); } // Overriding URL / Target if set to do so: if ($this->menuArr[$key]['_OVERRIDE_HREF']) { $LD['totalURL'] = $this->menuArr[$key]['_OVERRIDE_HREF']; if ($this->menuArr[$key]['_OVERRIDE_TARGET']) $LD['target'] = $this->menuArr[$key]['_OVERRIDE_TARGET']; } // OnClick open in windows. $onClick=''; if ($this->mconf['JSWindow']) { $conf=$this->mconf['JSWindow.']; $url=$LD['totalURL']; $LD['totalURL'] = '#'; $onClick= 'openPic(\''.$GLOBALS['TSFE']->baseUrlWrap($url).'\',\''.($conf['newWindow']?md5($url):'theNewPage').'\',\''.$conf['params'].'\'); return false;'; $GLOBALS['TSFE']->setJS('openPic'); } // out: $list = array(); $list['HREF'] = strlen($LD['totalURL']) ? $LD['totalURL'] : $GLOBALS['TSFE']->baseUrl; // Added this check: What it does is to enter the baseUrl (if set, which it should for "realurl" based sites) as URL if the calculated value is empty. The problem is that no link is generated with a blank URL and blank URLs might appear when the realurl encoding is used and a link to the frontpage is generated. $list['TARGET'] = $LD['target']; $list['onClick'] = $onClick; return $list; }

tslib_menu::makeMenu (   )

Creates the menu in the internal variables, ready for output. Basically this will read the page records needed and fill in the internal $this->menuArr Based on a hash of this array and some other variables the $this->result variable will be loaded either from cache OR by calling the generate() method of the class to create the menu for real. Returns: void Definition at line 313 of file class.tslib_menu.php. References $id, $nextActive, $val, filterMenuPages(), getKey(), header(), includeMakeMenu(), spacer(), and userProcess(). { if ($this->id) { $temp = array(); $altSortFieldValue = trim($this->mconf['alternativeSortingField']); $altSortField = $altSortFieldValue ? $altSortFieldValue : 'sorting'; if ($this->menuNumber==1 && $this->conf['special']) { // ... only for the FIRST level of a HMENU $value = $this->conf['special.']['value']; switch($this->conf['special']) { case 'userdefined': $temp = $this->includeMakeMenu($this->conf['special.'],$altSortField); break; case 'userfunction': $temp = $this->parent_cObj->callUserFunction( $this->conf['special.']['userFunc'], array_merge($this->conf['special.'],array('_altSortField'=>$altSortField)), '' ); if (!is_array($temp)) $temp=array(); break; case 'language': $temp = array(); // Getting current page record NOT overlaid by any translation: $currentPageWithNoOverlay = $this->sys_page->getRawRecord('pages',$GLOBALS['TSFE']->page['uid']); // Traverse languages set up: $languageItems = t3lib_div::intExplode(',',$value); foreach($languageItems as $sUid) { // Find overlay record: if ($sUid) { $lRecs = $this->sys_page->getPageOverlay($GLOBALS['TSFE']->page['uid'],$sUid); } else $lRecs=array(); // Checking if the "disabled" state should be set. if ( ($GLOBALS['TSFE']->page['l18n_cfg']&2 && $sUid && !count($lRecs)) // Blocking for all translations? || ($GLOBALS['TSFE']->page['l18n_cfg']&1 && (!$sUid || !count($lRecs))) // Blocking default translation? || (!$this->conf['special.']['normalWhenNoLanguage'] && $sUid && !count($lRecs)) ) { $iState = $GLOBALS['TSFE']->sys_language_uid==$sUid ? 'USERDEF2' : 'USERDEF1'; } else { $iState = $GLOBALS['TSFE']->sys_language_uid==$sUid ? 'ACT' : 'NO'; } // Adding menu item: $temp[] = array_merge( array_merge($currentPageWithNoOverlay, $lRecs), array( 'ITEM_STATE' => $iState, '_ADD_GETVARS' => '&L='.$sUid, '_SAFE' => TRUE ) ); } break; case 'directory': if ($value=='') { $value=$GLOBALS['TSFE']->page['uid']; } $items=t3lib_div::intExplode(',',$value); foreach($items as $id) { $MP = $this->tmpl->getFromMPmap($id); // Checking if a page is a mount page and if so, change the ID and set the MP var properly. $mount_info = $this->sys_page->getMountPointInfo($id); if (is_array($mount_info)) { if ($mount_info['overlay']) { // Overlays should already have their full MPvars calculated: $MP = $this->tmpl->getFromMPmap($mount_info['mount_pid']); $MP = $MP ? $MP : $mount_info['MPvar']; } else { $MP = ($MP ? $MP.',' : '').$mount_info['MPvar']; } $id = $mount_info['mount_pid']; } // Get sub-pages: $res = $GLOBALS['TSFE']->cObj->exec_getQuery('pages',Array('pidInList'=>$id,'orderBy'=>$altSortField)); while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) { // Keep mount point? $mount_info = $this->sys_page->getMountPointInfo($row['uid'], $row); if (is_array($mount_info) && $mount_info['overlay']) { // There is a valid mount point. $mp_row = $this->sys_page->getPage($mount_info['mount_pid']); // Using "getPage" is OK since we need the check for enableFields AND for type 2 of mount pids we DO require a doktype < 200! if (count($mp_row)) { $row = $mp_row; $row['_MP_PARAM'] = $mount_info['MPvar']; } else unset($row); // If the mount point could not be fetched with respect to enableFields, unset the row so it does not become a part of the menu! } // Add external MP params, then the row: if (is_array($row)) { if ($MP) $row['_MP_PARAM'] = $MP.($row['_MP_PARAM'] ? ','.$row['_MP_PARAM'] : ''); $temp[$row['uid']] = $this->sys_page->getPageOverlay($row); } } } break; case 'list': if ($value=='') { $value=$this->id; } $loadDB = t3lib_div::makeInstance('FE_loadDBGroup'); $loadDB->start($value, 'pages'); $loadDB->additionalWhere['pages']=tslib_cObj::enableFields('pages'); $loadDB->getFromDB(); foreach($loadDB->itemArray as $val) { $MP = $this->tmpl->getFromMPmap($val['id']); // Keep mount point? $mount_info = $this->sys_page->getMountPointInfo($val['id']); if (is_array($mount_info) && $mount_info['overlay']) { // There is a valid mount point. $mp_row = $this->sys_page->getPage($mount_info['mount_pid']); // Using "getPage" is OK since we need the check for enableFields AND for type 2 of mount pids we DO require a doktype < 200! if (count($mp_row)) { $row = $mp_row; $row['_MP_PARAM'] = $mount_info['MPvar']; if ($mount_info['overlay']) { // Overlays should already have their full MPvars calculated: $MP = $this->tmpl->getFromMPmap($mount_info['mount_pid']); if ($MP) unset($row['_MP_PARAM']); } } else unset($row); // If the mount point could not be fetched with respect to enableFields, unset the row so it does not become a part of the menu! } else { $row = $loadDB->results['pages'][$val['id']]; } // Add external MP params, then the row: if (is_array($row)) { if ($MP) $row['_MP_PARAM'] = $MP.($row['_MP_PARAM'] ? ','.$row['_MP_PARAM'] : ''); $temp[] = $this->sys_page->getPageOverlay($row); } } break; case 'updated': if ($value=='') { $value=$GLOBALS['TSFE']->page['uid']; } $items=t3lib_div::intExplode(',',$value); if (t3lib_div::testInt($this->conf['special.']['depth'])) { $depth = t3lib_div::intInRange($this->conf['special.']['depth'],1,20); // Tree depth } else { $depth=20; } $limit = t3lib_div::intInRange($this->conf['special.']['limit'],0,100); // max number of items $maxAge = intval(tslib_cObj::calc($this->conf['special.']['maxAge'])); if (!$limit) $limit=10; $mode = $this->conf['special.']['mode']; // *'auto', 'manual', 'tstamp' // Get id's $id_list_arr = Array(); foreach($items as $id) { $bA = t3lib_div::intInRange($this->conf['special.']['beginAtLevel'],0,100); $id_list_arr[] = tslib_cObj::getTreeList(-1*$id,$depth-1+$bA,$bA-1); } $id_list = implode(',',$id_list_arr); // Get sortField (mode) switch($mode) { case 'starttime': $sortField = 'starttime'; break; case 'lastUpdated': case 'manual': $sortField = 'lastUpdated'; break; case 'tstamp': $sortField = 'tstamp'; break; case 'crdate': $sortField = 'crdate'; break; default: $sortField = 'SYS_LASTCHANGED'; break; } // Get $extraWhere = ' AND pages.nav_hide=0'.$this->getDoktypeExcludeWhere(); if ($this->conf['special.']['excludeNoSearchPages']) { $extraWhere.= ' AND pages.no_search=0'; } if ($maxAge>0) { $extraWhere.=' AND '.$sortField.'>'.($GLOBALS['SIM_EXEC_TIME']-$maxAge); } $res = $GLOBALS['TSFE']->cObj->exec_getQuery('pages',Array('pidInList'=>'0', 'uidInList'=>$id_list, 'where'=>$sortField.'>=0'.$extraWhere, 'orderBy'=>($altSortFieldValue ? $altSortFieldValue : $sortField.' desc'),'max'=>$limit)); while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) { $temp[$row['uid']]=$this->sys_page->getPageOverlay($row); } break; case 'keywords': list($value)=t3lib_div::intExplode(',',$value); if (!$value) { $value=$GLOBALS['TSFE']->page['uid']; } if ($this->conf['special.']['setKeywords'] || $this->conf['special.']['setKeywords.']) { $kw = $this->parent_cObj->stdWrap($this->conf['special.']['setKeywords'], $this->conf['special.']['setKeywords.']); } else { $value_rec=$this->sys_page->getPage($value); // The page record of the 'value'. $kfieldSrc = $this->conf['special.']['keywordsField.']['sourceField'] ? $this->conf['special.']['keywordsField.']['sourceField'] : 'keywords'; $kw = trim(tslib_cObj::keywords($value_rec[$kfieldSrc])); // keywords. } $mode = $this->conf['special.']['mode']; // *'auto', 'manual', 'tstamp' switch($mode) { case 'starttime': $sortField = 'starttime'; break; case 'lastUpdated': case 'manual': $sortField = 'lastUpdated'; break; case 'tstamp': $sortField = 'tstamp'; break; case 'crdate': $sortField = 'crdate'; break; default: $sortField = 'SYS_LASTCHANGED'; break; } // depth, limit, extra where if (t3lib_div::testInt($this->conf['special.']['depth'])) { $depth = t3lib_div::intInRange($this->conf['special.']['depth'],0,20); // Tree depth } else { $depth=20; } $limit = t3lib_div::intInRange($this->conf['special.']['limit'],0,100); // max number of items $extraWhere = ' AND pages.uid!='.$value.' AND pages.nav_hide=0'.$this->getDoktypeExcludeWhere(); if ($this->conf['special.']['excludeNoSearchPages']) { $extraWhere.= ' AND pages.no_search=0'; } // start point $eLevel = tslib_cObj::getKey (intval($this->conf['special.']['entryLevel']),$this->tmpl->rootLine); $startUid = intval($this->tmpl->rootLine[$eLevel]['uid']); // which field is for keywords $kfield = 'keywords'; if ( $this->conf['special.']['keywordsField'] ) { list($kfield) = explode(' ',trim ($this->conf['special.']['keywordsField'])); } // If there are keywords and the startuid is present. if ($kw && $startUid) { $bA = t3lib_div::intInRange($this->conf['special.']['beginAtLevel'],0,100); $id_list=tslib_cObj::getTreeList(-1*$startUid,$depth-1+$bA,$bA-1); $kwArr = explode(',',$kw); foreach($kwArr as $word) { $word = trim($word); if ($word) { $keyWordsWhereArr[] = $kfield.' LIKE "%'.$GLOBALS['TYPO3_DB']->quoteStr($word, 'pages').'%"'; } } $res = $GLOBALS['TSFE']->cObj->exec_getQuery('pages',Array('pidInList'=>'0', 'uidInList'=>$id_list, 'where'=>'('.implode(' OR ',$keyWordsWhereArr).')'.$extraWhere, 'orderBy'=>($altSortFieldValue ? $altSortFieldValue : $sortField.' desc'),'max'=>$limit)); while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) { $temp[$row['uid']]=$this->sys_page->getPageOverlay($row); } } break; case 'rootline': $begin_end = explode('|',$this->conf['special.']['range']); if (!t3lib_div::testInt($begin_end[0])) {intval($begin_end[0]);} if (!t3lib_div::testInt($begin_end[1])) {$begin_end[1]=-1;} $beginKey = tslib_cObj::getKey ($begin_end[0],$this->tmpl->rootLine); $endKey = tslib_cObj::getKey ($begin_end[1],$this->tmpl->rootLine); if ($endKey<$beginKey) {$endKey=$beginKey;} $rl_MParray = array(); foreach($this->tmpl->rootLine as $k_rl => $v_rl) { // For overlaid mount points, set the variable right now: if ($v_rl['_MP_PARAM'] && $v_rl['_MOUNT_OL']) { $rl_MParray[] = $v_rl['_MP_PARAM']; } // Traverse rootline: if ($k_rl>=$beginKey && $k_rl<=$endKey) { $temp_key=$k_rl; $temp[$temp_key]=$this->sys_page->getPage($v_rl['uid']); if (count($temp[$temp_key])) { if (!$temp[$temp_key]['target']) { // If there are no specific target for the page, put the level specific target on. $temp[$temp_key]['target'] = $this->conf['special.']['targets.'][$k_rl]; $temp[$temp_key]['_MP_PARAM'] = implode(',',$rl_MParray); } } else unset($temp[$temp_key]); } // For normal mount points, set the variable for next level. if ($v_rl['_MP_PARAM'] && !$v_rl['_MOUNT_OL']) { $rl_MParray[] = $v_rl['_MP_PARAM']; } } break; case 'browse': list($value)=t3lib_div::intExplode(',',$value); if (!$value) { $value=$GLOBALS['TSFE']->page['uid']; } if ($value!=$this->tmpl->rootLine[0]['uid']) { // Will not work out of rootline $recArr=array(); $value_rec=$this->sys_page->getPage($value); // The page record of the 'value'. if ($value_rec['pid']) { // 'up' page cannot be outside rootline $recArr['up']=$this->sys_page->getPage($value_rec['pid']); // The page record of 'up'. } if ($recArr['up']['pid'] && $value_rec['pid']!=$this->tmpl->rootLine[0]['uid']) { // If the 'up' item was NOT level 0 in rootline... $recArr['index']=$this->sys_page->getPage($recArr['up']['pid']); // The page record of "index". } // prev / next is found $prevnext_menu = $this->sys_page->getMenu($value_rec['pid'],'*',$altSortField); $lastKey=0; $nextActive=0; reset($prevnext_menu); while(list($k_b,$v_b)=each($prevnext_menu)) { if ($nextActive) { $recArr['next']=$v_b; $nextActive=0; } if ($v_b['uid']==$value) { if ($lastKey) { $recArr['prev']=$prevnext_menu[$lastKey]; } $nextActive=1; } $lastKey=$k_b; } reset($prevnext_menu); $recArr['first']=pos($prevnext_menu); end($prevnext_menu); $recArr['last']=pos($prevnext_menu); // prevsection / nextsection is found if (is_array($recArr['index'])) { // You can only do this, if there is a valid page two levels up! $prevnextsection_menu = $this->sys_page->getMenu($recArr['index']['uid'],'*',$altSortField); $lastKey=0; $nextActive=0; reset($prevnextsection_menu); while(list($k_b,$v_b)=each($prevnextsection_menu)) { if ($nextActive) { $sectionRec_temp = $this->sys_page->getMenu($v_b['uid'],'*',$altSortField); if (count($sectionRec_temp)) { reset($sectionRec_temp); $recArr['nextsection']=pos($sectionRec_temp); end ($sectionRec_temp); $recArr['nextsection_last']=pos($sectionRec_temp); $nextActive=0; } } if ($v_b['uid']==$value_rec['pid']) { if ($lastKey) { $sectionRec_temp = $this->sys_page->getMenu($prevnextsection_menu[$lastKey]['uid'],'*',$altSortField); if (count($sectionRec_temp)) { reset($sectionRec_temp); $recArr['prevsection']=pos($sectionRec_temp); end ($sectionRec_temp); $recArr['prevsection_last']=pos($sectionRec_temp); } } $nextActive=1; } $lastKey=$k_b; } } if ($this->conf['special.']['items.']['prevnextToSection']) { if (!is_array($recArr['prev']) && is_array($recArr['prevsection_last'])) { $recArr['prev']=$recArr['prevsection_last']; } if (!is_array($recArr['next']) && is_array($recArr['nextsection'])) { $recArr['next']=$recArr['nextsection']; } } $items = explode('|',$this->conf['special.']['items']); $c=0; while(list($k_b,$v_b)=each($items)) { $v_b=strtolower(trim($v_b)); if (intval($this->conf['special.'][$v_b.'.']['uid'])) { $recArr[$v_b] = $this->sys_page->getPage(intval($this->conf['special.'][$v_b.'.']['uid'])); // fetches the page in case of a hardcoded pid in template } if (is_array($recArr[$v_b])) { $temp[$c]=$recArr[$v_b]; if ($this->conf['special.'][$v_b.'.']['target']) { $temp[$c]['target']=$this->conf['special.'][$v_b.'.']['target']; } if (is_array($this->conf['special.'][$v_b.'.']['fields.'])) { reset($this->conf['special.'][$v_b.'.']['fields.']); while(list($fk,$val)=each($this->conf['special.'][$v_b.'.']['fields.'])) { $temp[$c][$fk]=$val; } } $c++; } } } break; } } elseif (is_array($this->alternativeMenuTempArray)) { // Setting $temp array if not level 1. $temp = $this->alternativeMenuTempArray; } elseif ($this->mconf['sectionIndex']) { if ($GLOBALS['TSFE']->sys_language_uid && count($this->sys_page->getPageOverlay($this->id))) { $sys_language_uid = intval($GLOBALS['TSFE']->sys_language_uid); } else $sys_language_uid=0; $selectSetup = Array( 'pidInList'=>$this->id, 'orderBy'=>$altSortField, 'where' => 'colPos=0 AND sys_language_uid='.$sys_language_uid, 'andWhere' => 'sectionIndex!=0' ); switch($this->mconf['sectionIndex.']['type']) { case 'all': unset($selectSetup['andWhere']); break; case 'header': $selectSetup['andWhere']='header_layout!=100 AND header!=""'; break; } $basePageRow=$this->sys_page->getPage($this->id); if (is_array($basePageRow)) { $res = $GLOBALS['TSFE']->cObj->exec_getQuery('tt_content', $selectSetup); while ($row = $GLOBALS['TYPO3_DB']->sql_fetch_assoc($res)) { $temp[$row['uid']]=$basePageRow; $temp[$row['uid']]['title']=$row['header']; $temp[$row['uid']]['subtitle']=$row['subheader']; $temp[$row['uid']]['starttime']=$row['starttime']; $temp[$row['uid']]['endtime']=$row['endtime']; $temp[$row['uid']]['fe_group']=$row['fe_group']; $temp[$row['uid']]['media']=$row['media']; $temp[$row['uid']]['header_layout']=$row['header_layout']; $temp[$row['uid']]['bodytext']=$row['bodytext']; $temp[$row['uid']]['image']=$row['image']; $temp[$row['uid']]['sectionIndex_uid']=$row['uid']; } } } else { // Default: $temp = $this->sys_page->getMenu($this->id,'*',$altSortField); // gets the menu } $c=0; $c_b=0; $minItems = intval($this->mconf['minItems'] ? $this->mconf['minItems'] : $this->conf['minItems']); $maxItems = intval($this->mconf['maxItems'] ? $this->mconf['maxItems'] : $this->conf['maxItems']); $begin = tslib_cObj::calc($this->mconf['begin'] ? $this->mconf['begin'] : $this->conf['begin']); $banUidArray=array(); if (trim($this->conf['excludeUidList'])) { $banUidArray = t3lib_div::intExplode(',', $this->conf['excludeUidList']); } // Fill in the menuArr with elements that should go into the menu: $this->menuArr = Array(); foreach($temp as $data) { $spacer = (t3lib_div::inList($this->spacerIDList,$data['doktype']) || !strcmp($data['ITEM_STATE'],'SPC')) ? 1 : 0; // if item is a spacer, $spacer is set if ($this->filterMenuPages($data, $banUidArray, $spacer)) { $c_b++; if ($begin<=$c_b) { // If the beginning item has been reached. $this->menuArr[$c] = $data; $this->menuArr[$c]['isSpacer'] = $spacer; $c++; if ($maxItems && $c>=$maxItems) { break; } } } } // Fill in fake items, if min-items is set. if ($minItems) { while($c<$minItems) { $this->menuArr[$c] = Array( 'title' => '...', 'uid' => $GLOBALS['TSFE']->id ); $c++; } } // Setting number of menu items $GLOBALS['TSFE']->register['count_menuItems'] = count($this->menuArr); // Passing the menuArr through a user defined function: if ($this->mconf['itemArrayProcFunc']) { if (!is_array($this->parentMenuArr)) {$this->parentMenuArr=array();} $this->menuArr = $this->userProcess('itemArrayProcFunc',$this->menuArr); } $this->hash = md5(serialize($this->menuArr).serialize($this->mconf).serialize($this->tmpl->rootLine).serialize($this->MP_array)); $serData = $this->sys_page->getHash($this->hash, 60*60*24); if (!$serData) { $this->generate(); $this->sys_page->storeHash($this->hash, serialize($this->result),'MENUDATA'); } else { $this->result=unserialize($serData); } } }

tslib_menu::procesItemStates (  $  splitCount  )

Generating the per-menu-item configuration arrays based on the settings for item states (NO, RO, ACT, CUR etc) set in ->mconf (config for the current menu object) Basically it will produce an individual array for each menu item based on the item states. BUT in addition the "optionSplit" syntax for the values is ALSO evaluated here so that all property-values are "option-splitted" and the output will thus be resolved. Is called from the "generate" functions in the extension classes. The function is processor intensive due to the option split feature in particular. But since the generate function is not always called (since the ->result array may be cached, see makeMenu) it doesn't hurt so badly. Parameters: integer  Number of menu items in the menu Returns: array An array with two keys: array($NOconf,$ROconf) - where $NOconf contains the resolved configuration for each item when NOT rolled-over and $ROconf contains the ditto for the mouseover state (if any) private Definition at line 894 of file class.tslib_menu.php. References isItemState(). Referenced by tslib_imgmenu::generate(), and tslib_tmenu::generate(). { // Prepare normal settings if (!is_array($this->mconf['NO.']) && $this->mconf['NO']) $this->mconf['NO.']=array(); // Setting a blank array if NO=1 and there are no properties. $NOconf = $this->tmpl->splitConfArray($this->mconf['NO.'],$splitCount); // Prepare rollOver settings, overriding normal settings $ROconf=array(); if ($this->mconf['RO']) { $ROconf = $this->tmpl->splitConfArray($this->mconf['RO.'],$splitCount); } // Prepare IFSUB settings, overriding normal settings // IFSUB is true if there exist submenu items to the current item if ($this->mconf['IFSUB']) { $IFSUBinit = 0; // Flag: If $IFSUB is generated reset($NOconf); while (list($key,$val)=each($NOconf)) { if ($this->isItemState('IFSUB',$key)) { if (!$IFSUBinit) { // if this is the first IFSUB element, we must generate IFSUB. $IFSUBconf = $this->tmpl->splitConfArray($this->mconf['IFSUB.'],$splitCount); if ($this->mconf['IFSUBRO']) { $IFSUBROconf = $this->tmpl->splitConfArray($this->mconf['IFSUBRO.'],$splitCount); } $IFSUBinit = 1; } $NOconf[$key] = $IFSUBconf[$key]; // Substitute normal with ifsub if ($ROconf) { // If rollOver on normal, we must apply a state for rollOver on the active $ROconf[$key] = $IFSUBROconf[$key] ? $IFSUBROconf[$key] : $IFSUBconf[$key]; // If RollOver on active then apply this } } } } // Prepare active settings, overriding normal settings if ($this->mconf['ACT']) { $ACTinit = 0; // Flag: If $ACT is generated reset($NOconf); while (list($key,$val)=each($NOconf)) { // Find active if ($this->isItemState('ACT',$key)) { if (!$ACTinit) { // if this is the first active, we must generate ACT. $ACTconf = $this->tmpl->splitConfArray($this->mconf['ACT.'],$splitCount); // Prepare active rollOver settings, overriding normal active settings if ($this->mconf['ACTRO']) { $ACTROconf = $this->tmpl->splitConfArray($this->mconf['ACTRO.'],$splitCount); } $ACTinit = 1; } $NOconf[$key] = $ACTconf[$key]; // Substitute normal with active if ($ROconf) { // If rollOver on normal, we must apply a state for rollOver on the active $ROconf[$key] = $ACTROconf[$key] ? $ACTROconf[$key] : $ACTconf[$key]; // If RollOver on active then apply this } } } } // Prepare active/IFSUB settings, overriding normal settings // ACTIFSUB is true if there exist submenu items to the current item and the current item is active if ($this->mconf['ACTIFSUB']) { $ACTIFSUBinit = 0; // Flag: If $ACTIFSUB is generated reset($NOconf); while (list($key,$val)=each($NOconf)) { // Find active if ($this->isItemState('ACTIFSUB',$key)) { if (!$ACTIFSUBinit) { // if this is the first active, we must generate ACTIFSUB. $ACTIFSUBconf = $this->tmpl->splitConfArray($this->mconf['ACTIFSUB.'],$splitCount); // Prepare active rollOver settings, overriding normal active settings if ($this->mconf['ACTIFSUBRO']) { $ACTIFSUBROconf = $this->tmpl->splitConfArray($this->mconf['ACTIFSUBRO.'],$splitCount); } $ACTIFSUBinit = 1; } $NOconf[$key] = $ACTIFSUBconf[$key]; // Substitute normal with active if ($ROconf) { // If rollOver on normal, we must apply a state for rollOver on the active $ROconf[$key] = $ACTIFSUBROconf[$key] ? $ACTIFSUBROconf[$key] : $ACTIFSUBconf[$key]; // If RollOver on active then apply this } } } } // Prepare CUR (current) settings, overriding normal settings // CUR is true if the current page equals the item here! if ($this->mconf['CUR']) { $CURinit = 0; // Flag: If $CUR is generated reset($NOconf); while (list($key,$val)=each($NOconf)) { if ($this->isItemState('CUR',$key)) { if (!$CURinit) { // if this is the first 'current', we must generate CUR. Basically this control is just inherited from the other implementations as current would only exist one time and thats it (unless you use special-features of HMENU) $CURconf = $this->tmpl->splitConfArray($this->mconf['CUR.'],$splitCount); if ($this->mconf['CURRO']) { $CURROconf = $this->tmpl->splitConfArray($this->mconf['CURRO.'],$splitCount); } $CURinit = 1; } $NOconf[$key] = $CURconf[$key]; // Substitute normal with current if ($ROconf) { // If rollOver on normal, we must apply a state for rollOver on the active $ROconf[$key] = $CURROconf[$key] ? $CURROconf[$key] : $CURconf[$key]; // If RollOver on active then apply this } } } } // Prepare active settings, overriding normal settings if ($this->mconf['USR']) { $USRinit = 0; // Flag: If $USR is generated reset($NOconf); while (list($key,$val)=each($NOconf)) { // Find active if ($this->isItemState('USR',$key)) { if (!$USRinit) { // if this is the first active, we must generate USR. $USRconf = $this->tmpl->splitConfArray($this->mconf['USR.'],$splitCount); // Prepare active rollOver settings, overriding normal active settings if ($this->mconf['USRRO']) { $USRROconf = $this->tmpl->splitConfArray($this->mconf['USRRO.'],$splitCount); } $USRinit = 1; } $NOconf[$key] = $USRconf[$key]; // Substitute normal with active if ($ROconf) { // If rollOver on normal, we must apply a state for rollOver on the active $ROconf[$key] = $USRROconf[$key] ? $USRROconf[$key] : $USRconf[$key]; // If RollOver on active then apply this } } } } // Prepare spacer settings, overriding normal settings if ($this->mconf['SPC']) { $SPCinit = 0; // Flag: If $SPC is generated reset($NOconf); while (list($key,$val)=each($NOconf)) { // Find spacers if ($this->isItemState('SPC',$key)) { if (!$SPCinit) { // if this is the first spacer, we must generate SPC. $SPCconf = $this->tmpl->splitConfArray($this->mconf['SPC.'],$splitCount); $SPCinit = 1; } $NOconf[$key] = $SPCconf[$key]; // Substitute normal with spacer } } } // Prepare Userdefined settings if ($this->mconf['USERDEF1']) { $USERDEF1init = 0; // Flag: If $USERDEF1 is generated reset($NOconf); while (list($key,$val)=each($NOconf)) { // Find active if ($this->isItemState('USERDEF1',$key)) { if (!$USERDEF1init) { // if this is the first active, we must generate USERDEF1. $USERDEF1conf = $this->tmpl->splitConfArray($this->mconf['USERDEF1.'],$splitCount); // Prepare active rollOver settings, overriding normal active settings if ($this->mconf['USERDEF1RO']) { $USERDEF1ROconf = $this->tmpl->splitConfArray($this->mconf['USERDEF1RO.'],$splitCount); } $USERDEF1init = 1; } $NOconf[$key] = $USERDEF1conf[$key]; // Substitute normal with active if ($ROconf) { // If rollOver on normal, we must apply a state for rollOver on the active $ROconf[$key] = $USERDEF1ROconf[$key] ? $USERDEF1ROconf[$key] : $USERDEF1conf[$key]; // If RollOver on active then apply this } } } } // Prepare Userdefined settings if ($this->mconf['USERDEF2']) { $USERDEF2init = 0; // Flag: If $USERDEF2 is generated reset($NOconf); while (list($key,$val)=each($NOconf)) { // Find active if ($this->isItemState('USERDEF2',$key)) { if (!$USERDEF2init) { // if this is the first active, we must generate USERDEF2. $USERDEF2conf = $this->tmpl->splitConfArray($this->mconf['USERDEF2.'],$splitCount); // Prepare active rollOver settings, overriding normal active settings if ($this->mconf['USERDEF2RO']) { $USERDEF2ROconf = $this->tmpl->splitConfArray($this->mconf['USERDEF2RO.'],$splitCount); } $USERDEF2init = 1; } $NOconf[$key] = $USERDEF2conf[$key]; // Substitute normal with active if ($ROconf) { // If rollOver on normal, we must apply a state for rollOver on the active $ROconf[$key] = $USERDEF2ROconf[$key] ? $USERDEF2ROconf[$key] : $USERDEF2conf[$key]; // If RollOver on active then apply this } } } } return array($NOconf,$ROconf); }

tslib_menu::setATagParts (   )

Creates the tag parts for the current item (in $this->I, [A1] and [A2]) based on other information in this array (like $this->I['linkHREF']). Returns: void private Definition at line 1344 of file class.tslib_menu.php. References accessKey(). Referenced by tslib_tmenu::writeMenu(). { $this->I['A1'] = '<a '.t3lib_div::implodeAttributes($this->I['linkHREF'],1).$this->I['val']['ATagParams'].$this->I['addATagParams'].$this->I['accessKey']['code'].'>'; $this->I['A2'] = '</a>'; }

tslib_menu::start (  &$  tmpl, &$  sys_page, $  id, $  conf, $  menuNumber )

The initialization of the object. This just sets some internal variables. Parameters: object  The $GLOBALS['TSFE']->tmpl object object  The $GLOBALS['TSFE']->sys_page object integer  A starting point page id. This should probably be blank since the 'entryLevel' value will be used then. array  The TypoScript configuration for the HMENU cObject integer  Menu number; 1,2,3. Should probably be '1' Returns: boolean Returns true on success See also: tslib_cObj::HMENU() Definition at line 187 of file class.tslib_menu.php. References $entryLevel, debug(), getKey(), and menu(). { // Init: $this->conf = $conf; $this->menuNumber = $menuNumber; $this->mconf = $conf[$this->menuNumber.'.']; $this->debug=$GLOBALS['TSFE']->debug; // Sets the internal vars. $tmpl MUST be the template-object. $sys_page MUST be the sys_page object if ($this->conf[$this->menuNumber] && is_object($tmpl) && is_object($sys_page)) { $this->tmpl = &$tmpl; $this->sys_page = &$sys_page; // alwaysActivePIDlist initialized: if (trim($this->conf['alwaysActivePIDlist'])) { $this->alwaysActivePIDlist = t3lib_div::intExplode(',', $this->conf['alwaysActivePIDlist']); } // 'not in menu' doktypes if($this->conf['excludeDoktypes']) { $this->doktypeExcludeList = $GLOBALS['TYPO3_DB']->cleanIntList($this->conf['excludeDoktypes']); } if($this->conf['includeNotInMenu']) { $exclDoktypeArr = t3lib_div::trimExplode(',',$this->doktypeExcludeList,1); $exclDoktypeArr = t3lib_div::removeArrayEntryByValue($exclDoktypeArr,'5'); $this->doktypeExcludeList = implode(',',$exclDoktypeArr); } // EntryLevel $this->entryLevel = tslib_cObj::getKey ($conf['entryLevel'],$this->tmpl->rootLine); // Set parent page: If $id not stated with start() then the base-id will be found from rootLine[$this->entryLevel] if ($id) { // Called as the next level in a menu. It is assumed that $this->MP_array is set from parent menu. $this->id = intval($id); } else { // This is a BRAND NEW menu, first level. So we take ID from rootline and also find MP_array (mount points) $this->id = intval($this->tmpl->rootLine[$this->entryLevel]['uid']); // Traverse rootline to build MP_array of pages BEFORE the entryLevel // (MP var for ->id is picked up in the next part of the code...) foreach($this->tmpl->rootLine as $entryLevel => $levelRec) { // For overlaid mount points, set the variable right now: if ($levelRec['_MP_PARAM'] && $levelRec['_MOUNT_OL']) { $this->MP_array[] = $levelRec['_MP_PARAM']; } // Break when entry level is reached: if ($entryLevel>=$this->entryLevel) break; // For normal mount points, set the variable for next level. if ($levelRec['_MP_PARAM'] && !$levelRec['_MOUNT_OL']) { $this->MP_array[] = $levelRec['_MP_PARAM']; } } } // Return false if no page ID was set (thus no menu of subpages can be made). if ($this->id<=0) { return FALSE; } // Check if page is a mount point, and if so set id and MP_array // (basically this is ONLY for non-overlay mode, but in overlay mode an ID with a mount point should never reach this point anyways, so no harm done...) $mount_info = $this->sys_page->getMountPointInfo($this->id); if (is_array($mount_info)) { $this->MP_array[] = $mount_info['MPvar']; $this->id = $mount_info['mount_pid']; } // Gather list of page uids in root line (for "isActive" evaluation). Also adds the MP params in the path so Mount Points are respected. // (List is specific for this rootline, so it may be supplied from parent menus for speed...) if (!is_array($this->rL_uidRegister)) { $rl_MParray = array(); foreach($this->tmpl->rootLine as $v_rl) { // For overlaid mount points, set the variable right now: if ($v_rl['_MP_PARAM'] && $v_rl['_MOUNT_OL']) { $rl_MParray[] = $v_rl['_MP_PARAM']; } // Add to register: $this->rL_uidRegister[] = 'ITEM:'.$v_rl['uid'].(count($rl_MParray) ? ':'.implode(',',$rl_MParray) : ''); // For normal mount points, set the variable for next level. if ($v_rl['_MP_PARAM'] && !$v_rl['_MOUNT_OL']) { $rl_MParray[] = $v_rl['_MP_PARAM']; } } } // Setting "nextActive": This is the page uid + MPvar of the NEXT page in rootline. Used to expand the menu if we are in the right branch of the tree // Notice: The automatic expansion of a menu is designed to work only when no "special" modes are used. if (is_array($this->tmpl->rootLine[$this->entryLevel+$this->menuNumber])) { $nextMParray = $this->MP_array; if ($this->tmpl->rootLine[$this->entryLevel+$this->menuNumber]['_MOUNT_OL']) { // In overlay mode, add next level MPvars as well: $nextMParray[] = $this->tmpl->rootLine[$this->entryLevel+$this->menuNumber]['_MP_PARAM']; } $this->nextActive = $this->tmpl->rootLine[$this->entryLevel+$this->menuNumber]['uid']. (count($nextMParray)?':'.implode(',',$nextMParray):''); } else { $this->nextActive = ''; } // imgNamePrefix if ($this->mconf['imgNamePrefix']) { $this->imgNamePrefix=$this->mconf['imgNamePrefix']; } $this->imgNameNotRandom = $this->mconf['imgNameNotRandom']; // subLevelClass $cls = strtolower($this->conf[$this->menuNumber+1]); if ($cls && t3lib_div::inList($this->tmpl->menuclasses,$cls)) { $this->subLevelClass = $cls; } $retVal = TRUE; } else { $GLOBALS['TT']->setTSlogMessage('ERROR in menu',3); $retVal = FALSE; } return $retVal; }

tslib_menu::subMenu (  $  uid  )

Creates a submenu level to the current level - if configured for. Parameters: integer  Page id of the current page for which a submenu MAY be produced (if conditions are met) Returns: string HTML content of the submenu private Definition at line 1142 of file class.tslib_menu.php. References isNext(). Referenced by tslib_tmenu_layers::extProc_beforeLinking(), tslib_gmenu_layers::extProc_beforeLinking(), and tslib_gmenu_foldout::extProc_beforeLinking(). { // Setting alternative menu item array if _SUB_MENU has been defined in the current ->menuArr $altArray = ''; if (is_array($this->menuArr[$this->I['key']]['_SUB_MENU']) && count($this->menuArr[$this->I['key']]['_SUB_MENU'])) { $altArray = $this->menuArr[$this->I['key']]['_SUB_MENU']; } // Make submenu if the page is the next active if ($this->subLevelClass && ($this->mconf['expAll'] || $this->isNext($uid, $this->getMPvar($this->I['key'])) || is_array($altArray)) && !$this->mconf['sectionIndex']) { $submenu = t3lib_div::makeInstance('tslib_'.$this->subLevelClass); $submenu->entryLevel = $this->entryLevel+1; $submenu->rL_uidRegister = $this->rL_uidRegister; $submenu->MP_array = $this->MP_array; if ($this->menuArr[$this->I['key']]['_MP_PARAM']) { $submenu->MP_array[] = $this->menuArr[$this->I['key']]['_MP_PARAM']; } // especially scripts that build the submenu needs the parent data $submenu->parentMenuArr = $this->menuArr; // Setting alternativeMenuTempArray (will be effective only if an array) if (is_array($altArray)) { $submenu->alternativeMenuTempArray = $altArray; } if ($submenu->start($this->tmpl, $this->sys_page, $uid, $this->conf, $this->menuNumber+1)) { $submenu->makeMenu(); return $submenu->writeMenu(); } } }

tslib_menu::userProcess (  $  mConfKey, $  passVar )

Calls a user function for processing of internal data. Used for the properties "IProcFunc" and "itemArrayProcFunc" Parameters: string  Key pointing for the property in the current ->mconf array holding possibly parameters to pass along to the function/method. Currently the keys used are "IProcFunc" and "itemArrayProcFunc". mixed  A variable to pass to the user function and which should be returned again from the user function. The idea is that the user function modifies this variable according to what you want to achieve and then returns it. For "itemArrayProcFunc" this variable is $this->menuArr, for "IProcFunc" it is $this->I Returns: mixed The processed $passVar private Definition at line 1329 of file class.tslib_menu.php. Referenced by makeMenu(), and tslib_tmenu::writeMenu(). { if ($this->mconf[$mConfKey]) { $funcConf = $this->mconf[$mConfKey.'.']; $funcConf['parentObj']=&$this; $passVar = $GLOBALS['TSFE']->cObj->callUserFunction($this->mconf[$mConfKey], $funcConf, $passVar); } return $passVar; }

---

Member Data Documentation

tslib_menu::$alternativeMenuTempArray = ''

Definition at line 174 of file class.tslib_menu.php.

tslib_menu::$alwaysActivePIDlist = array()

Definition at line 149 of file class.tslib_menu.php.

tslib_menu::$conf = Array()

Definition at line 158 of file class.tslib_menu.php. Referenced by link().

tslib_menu::$debug = 0

Definition at line 152 of file class.tslib_menu.php.

tslib_menu::$doktypeExcludeList = '56'

Definition at line 148 of file class.tslib_menu.php.

tslib_menu::$entryLevel = 0

Definition at line 145 of file class.tslib_menu.php. Referenced by start().

tslib_menu::$GMENU_fixKey = 'gmenu'

Reimplemented in tslib_gmenu_foldout, tslib_gmenu_layers, and tslib_tmenu_layers. Definition at line 154 of file class.tslib_menu.php.

tslib_menu::$hash

Definition at line 165 of file class.tslib_menu.php.

tslib_menu::$I

Definition at line 169 of file class.tslib_menu.php.

tslib_menu::$id

Definition at line 162 of file class.tslib_menu.php. Referenced by makeMenu().

tslib_menu::$imgNameNotRandom = 0

Definition at line 151 of file class.tslib_menu.php.

tslib_menu::$imgNamePrefix = 'img'

Definition at line 150 of file class.tslib_menu.php.

tslib_menu::$INPfixMD5

Definition at line 168 of file class.tslib_menu.php.

tslib_menu::$mconf = Array()

Definition at line 159 of file class.tslib_menu.php.

tslib_menu::$menuArr

Definition at line 164 of file class.tslib_menu.php.

tslib_menu::$menuNumber = 1

Definition at line 144 of file class.tslib_menu.php.

tslib_menu::$MP_array = array()

Definition at line 155 of file class.tslib_menu.php.

tslib_menu::$nextActive

Definition at line 163 of file class.tslib_menu.php. Referenced by makeMenu().

tslib_menu::$parent_cObj = ''

Definition at line 153 of file class.tslib_menu.php.

tslib_menu::$result = Array()

Definition at line 166 of file class.tslib_menu.php. Referenced by accessKey().

tslib_menu::$rL_uidRegister = ''

Definition at line 167 of file class.tslib_menu.php.

tslib_menu::$spacerIDList = '199'

Definition at line 147 of file class.tslib_menu.php.

tslib_menu::$subLevelClass = ''

Definition at line 146 of file class.tslib_menu.php.

tslib_menu::$sys_page

Definition at line 161 of file class.tslib_menu.php.

tslib_menu::$tmpl

Definition at line 160 of file class.tslib_menu.php.

tslib_menu::$WMextraScript

Reimplemented in tslib_gmenu_layers, and tslib_tmenu_layers. Definition at line 173 of file class.tslib_menu.php.

tslib_menu::$WMfreezePrefix

Definition at line 171 of file class.tslib_menu.php.

tslib_menu::$WMmenuItems

Definition at line 172 of file class.tslib_menu.php.

tslib_menu::$WMresult

Definition at line 170 of file class.tslib_menu.php.

---

The documentation for this class was generated from the following file:

• typo3/sysext/cms/tslib/class.tslib_menu.php

---