Overview

Packages

  • awl
    • AuthPlugin
    • AwlDatabase
    • Browser
    • classEditor
    • DataEntry
    • DataUpdate
    • EMail
    • iCalendar
    • MenuSet
    • PgQuery
    • Session
    • Translation
    • User
    • Utilities
    • Validation
    • vCalendar
    • vComponent
    • XMLDocument
    • XMLElement
  • None
  • PHP

Classes

  • MenuOption
  • MenuSet

Functions

  • _CompareMenuSequence
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class MenuOption

Each menu option is an object.

Package: awl\MenuSet
Copyright: Catalyst IT Ltd, Morphoss Ltd <http://www.morphoss.com/>
License: GNU GPL v2 or later
Author: Andrew McMillan <andrew@mcmillan.net.nz>
Located at MenuSet.php
Methods summary
public
# MenuOption( string $label, string $target, string $title = "", string $style = "menu", integer $sortkey = 1000 )

The thing we click

The thing we click

Parameters

$label
string
$label The label to display for this option.
$target
string
$target The URL to target for this option.
$title
string
$title Some tooltip help for the title tag.
$style
string
$style A base class name for this option.
$sortkey
integer
$sortkey An (optional) value to allow option ordering.
public string
# Render( )

Convert the menu option into an HTML string

Convert the menu option into an HTML string

Returns

string
The HTML fragment for the menu option.
public
# Set( string $attribute, string $value )

Set arbitrary attributes of the menu option

Set arbitrary attributes of the menu option

Parameters

$attribute
string
$attribute An arbitrary attribute to be set in the hyperlink.
$value
string
$value A value for this attribute.
public
# Active( string $style = false )

Mark it as active, with a fancy style to distinguish that

Mark it as active, with a fancy style to distinguish that

Parameters

$style
string
$style A style used to highlight that the option is active.
public
# AddSubmenu( mixed & $submenu_set )

This menu option is now promoted to the head of a tree

This menu option is now promoted to the head of a tree

public boolean
# IsActive( )

Whether this option is currently active.

Whether this option is currently active.

Returns

boolean
The value of the active flag.
public boolean
# MaybeActive( mixed $test_pattern, mixed $active_style )

Whether this option is currently active.

Whether this option is currently active.

Returns

boolean
The value of the active flag.
Properties summary
public string $label
#

The label for the menu item

The label for the menu item

public string $target
#

The target URL for the menu

The target URL for the menu

public string $title
#

The title for the item when moused over, which should be displayed as a tooltip.

The title for the item when moused over, which should be displayed as a tooltip.

public string $active
#

Whether the menu option is active

Whether the menu option is active

public string $sortkey
#

For sorting menu options

For sorting menu options

public string $style
#

Style to render the menu option with.

Style to render the menu option with.

public string $submenu_set
#

The MenuSet that this menu is a parent of

The MenuSet that this menu is a parent of

public reference $self
#

A reference to this menu option itself

A reference to this menu option itself

public string $rendered
#

The rendered HTML fragment (once it has been).

The rendered HTML fragment (once it has been).

AWL API documentation generated by ApiGen 2.8.0