Stud.IP  jlu_3.3 Revision
PluginNavigation Class Reference
Inheritance diagram for PluginNavigation:
Inheritance graph
Collaboration diagram for PluginNavigation:
Collaboration graph

Public Member Functions

 getCommand ()
 
 setCommand ($cmd)
 
 getPlugin ()
 
 setPlugin (StudIPPlugin $plugin)
 
 addSubNavigation ($name, PluginNavigation $navigation)
 
 getURL ()
 
 addLinkParam ($key, $value)
 
 setLinkParam ($link)
 
 setActive ($value=NULL)
 
- Public Member Functions inherited from StudipPluginNavigation
 __construct ($title='', $url=NULL)
 
 getDisplayname ()
 
 setDisplayname ($title)
 
 getLink ()
 
 setLink ($url)
 
 getIcon ()
 
 setIcon ($icon)
 
 hasIcon ()
 
 freezeActivation ()
 
 getSubmenu ()
 
 addSubmenu (StudipPluginNavigation $subnavigation)
 
 removeSubmenu (StudipPluginNavigation $subnavigation)
 
 clearSubmenu ()
 
- Public Member Functions inherited from AutoNavigation
 isActive ()
 
- Public Member Functions inherited from Navigation
 __construct ($title, $url=NULL, $params=NULL)
 
 initItem ()
 
 getImage ()
 
 getImageTag ()
 
 getTitle ()
 
 getDescription ()
 
 getURL ()
 
 getBadgeNumber ()
 
 getBadgeTimestamp ()
 
 hasBadgeNumber ()
 
 isActive ()
 
 isEnabled ()
 
 isVisible ($needs_image=false)
 
 setActive ($active)
 
 setEnabled ($enabled)
 
 setImage ($image, $options=array())
 
 setActiveImage ($image, $options=array())
 
 setTitle ($title)
 
 setDescription ($description)
 
 setURL ($url, $params=NULL)
 
 setBadgeNumber ($badgeNumber)
 
 setBadgeTimestamp ($badgeTimestamp)
 
 activeSubNavigation ()
 
 addSubNavigation ($name, Navigation $navigation)
 
 insertSubNavigation ($name, Navigation $navigation, $where)
 
 getSubNavigation ()
 
 removeSubNavigation ($name)
 
 getIterator ()
 

Protected Attributes

 $cmd = 'show'
 
 $plugin
 
- Protected Attributes inherited from StudipPluginNavigation
 $icon
 
- Protected Attributes inherited from Navigation
 $active
 
 $enabled
 
 $initialized = false
 
 $active_image
 
 $badgeNumber
 
 $badgeTimestamp
 
 $description
 
 $image
 
 $params
 
 $subnav
 
 $title
 
 $url
 

Additional Inherited Members

- Static Public Member Functions inherited from Navigation
static activateItem ($path)
 
static addItem ($path, Navigation $navigation)
 
static insertItem ($path, Navigation $navigation, $where)
 
static removeItem ($path)
 
static getItem ($path)
 
static hasItem ($path)
 
static setRootNavigation (Navigation $navigation)
 
- Protected Member Functions inherited from Navigation
 initSubNavigation ()
 

Member Function Documentation

◆ addLinkParam()

addLinkParam (   $key,
  $value 
)

Add a new parameter for the link generation. If the key is already in use, its value is replaced with the new one.

Deprecated:
Here is the caller graph for this function:

◆ addSubNavigation()

addSubNavigation (   $name,
PluginNavigation  $navigation 
)

Add the given item to the subnavigation of this object.

Deprecated:

◆ getCommand()

getCommand ( )

Returns the cmd of this Navigation object.

Deprecated:
Returns
string the cmd

◆ getPlugin()

getPlugin ( )

Returns the plugin of this Navigation's object.

Deprecated:
Returns
string the plugin

◆ getURL()

getURL ( )

Return the current URL associated with this navigation item.

Deprecated:

Reimplemented from Navigation.

Here is the call graph for this function:

◆ setActive()

setActive (   $value = NULL)
Deprecated:

Reimplemented from Navigation.

◆ setCommand()

setCommand (   $cmd)

Sets the cmd of this Navigation's object.

Deprecated:
Parameters
stringthe cmd

◆ setLinkParam()

setLinkParam (   $link)
Deprecated:
Here is the call graph for this function:

◆ setPlugin()

setPlugin ( StudIPPlugin  $plugin)

Sets the plugin of this Navigation's object.

Deprecated:
Parameters
stringthe plugin
Here is the call graph for this function:

Field Documentation

◆ $cmd

$cmd = 'show'
protected

◆ $plugin

$plugin
protected

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