[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

/libraries/joomla/application/ -> menu.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License: GNU/GPL, see LICENSE.php
Version: $Id: menu.php 14401 2010-01-26 14:10:00Z louis $
File Size: 287 lines (5 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

JMenu:: (12 methods):
  __construct()
  getInstance()
  getItem()
  setDefault()
  getDefault()
  setActive()
  getActive()
  getItems()
  getParams()
  getMenu()
  authorize()
  load()


Class: JMenu  - X-Ref

JMenu class

__construct($options = array()   X-Ref
Class constructor

return: boolean True on success

getInstance($client, $options = array()   X-Ref
Returns a reference to a JMenu object

This method must be invoked as:
<pre>  $menu = &JSite::getMenu();</pre>

param: string  $client  The name of the client
param: array     $options An associative array of options
return: JMenu     A menu object.

getItem($id)   X-Ref
Get menu item by id

param: int The item id
return: mixed The item object, or null if not found

setDefault($id)   X-Ref
Set the default item by id

param: int The item id
return: True, if succesfull

getDefault()   X-Ref
Get menu item by id

return: object The item object

setActive($id)   X-Ref
Set the default item by id

param: int The item id
return: If successfull the active item, otherwise null

getActive()   X-Ref
Get menu item by id

return: object The item object

getItems($attribute, $value, $firstonly = false)   X-Ref
Gets menu items by attribute

param: string     The field name
param: string     The value of the field
param: boolean     If true, only returns the first item found
return: array

getParams($id)   X-Ref
Gets the parameter object for a certain menu item

param: int The item id
return: object A JParameter object

getMenu()   X-Ref
Getter for the menu array

return: array

authorize($id, $accessid = 0)   X-Ref
Method to check JMenu object authorization against an access control
object and optionally an access extension object

param: integer    $id            The menu id
param: integer    $accessid    The users access identifier
return: boolean    True if authorized

load()   X-Ref
Loads the menu items

return: array



Generated: Wed Mar 28 15:54:07 2012 Cross-referenced by PHPXref 0.7.1