Class: Tagger
Generates a series of tag names linking to a source of data. The names
are alphabetical and organized into 6 different sizes so as to visually
display which tags contain the most data.
Query types:
1. Single table
create table news (
id
title
category
body
)
select category as tag, count(*) as count
from news
group by category asc
Constructor:
$tagger = new Tagger (array ('news', 'category'));
2. Separate category table
create table news (
id
title
category_id
body
)
create table news_category (
id
name
)
select news_category.name as tag, count(*) as count
from news, news_category
where news.category_id = news_category.id
group by news_category.name asc
Constructor:
$tagger = new Tagger (
array ('news', 'category_id'),
array ('news_category', 'id', 'name')
);
Properties
$template
The template to use to generate the menu item.
$fill
The object or associative array to use to fill the template with upon
calling render().
$span
The span of this cell. Set to -1 and the cell will disappear. Use
$this->attrs['colspan'] or ['rowspan'] to set these properties in the
corresponding HTML <td> tag.
$attrs = array ()
Contains all HTML <td> properties for the current object.
$default
$default is an optional default value to place in cells whose
templates result in no output.
$type = 'db'
$collection
$limit
$fields
$total = 0
$list = false
$remember = array ()
$skipHeaders = array ()
$header = ''
$footer = ''
$editUrl = false
$addUrl = false
$deleteUrl = false
$error
Contains the most recent error message if an error has occurred,
false otherwise.
$name
The name of the menu.
$xpos
The distance from the left edge of the browser window to display
the menu in collapsible display mode. Default is 0.
$ypos
The distance from the top edge of the browser window to display
the menu in collapsible display mode. Default is 0.
$menuWidth
The width of the drop menu this item is a part of. Used for
inheriting to a child menu.
$lineHeight
The height of this item and each item in its parent drop menu.
Used for inheriting to a child menu.
$itemTemplate
The template used to draw each drop menu item.
$direction = 'right'
The direction of the drop menu this item is a part of. Used for
inheriting to a child menu.
$items = array ()
An array of DropMenuItem objects
$extraMouseOver = ''
Optional extra JavaScript to call when the item is in focus.
$extraMouseOut = ''
Optional extra JavaScript to call when the item loses focus.
$text
The text of the menu item.
$link
The URL to link this item to.
$menu_tpl
The menu template to use to generate child drop menus.
$child
The child DropMenu object of this item.
$mouseover
The private mouseover data detailing this item's behaviour.
$matrix = array ()
Contains the grid.
$table
The name of the database table (if any) that this menu is being
pulled from.
$row = array ()
Contains all HTML <tr> properties for the current object.
$cell = array ()
Contains all HTML <td> properties for the current object,
if this layout is not the top-level layout object.
$tree
Contains a multi-dimensional array of MenuItem objects.
$idcolumn
The name of the column in the database table that contains the
primary key values.
$showcolumn
The name of the column in the database table that is to be
displayed.
$refcolumn
The name of the column in the database table that makes a
self-reference to the primary key, or id, column.
$listcolumn
The name of the column in the database table that says
whether or not to display each record as an item.
$sortcolumn
The field to sort by, in case of a sort field. A sort field outweighs
the default sorting alphabetically.
$sortorder
The sort order, either 'ASC' (ascending) or 'DESC' (descending).
$sitelliteAllowed
Specifies whether or not to use the global $sitellite object
(from the Sitellite CMS-only package saf.App.Conf.Sitellite) to add
automatic permission limits on the database query. For more information,
see saf.App.Conf.Sitellite in DocReader.
$cache = false
$cacheLocation = 'cache/.menu'
$closedPic
The path to the image to use for the'"closed' graphic in the
collapsible display mode. Defaults to '/pix/false.gif'.
$openedPic
The path to the image to use for the'"opened' graphic in the
collapsible display mode. Defaults to '/pix/true.gif'.
$hideValue
The value that the database column in $listcolumn is supposed
to contain when a field is not to be shown. Defaults to 'no'.
$colours
An array of background colours for this item, which is the
same as the $colours property of saf.GUI.Menu.
$jsDir
The directory to find the JavaScript for the collapsible view
in. Default is '/js'.
$includedJs
Remembers whether or not the JavaScript for the collapsible
display mode has been included yet or not.
$initFunc
The name of the JavaScript init() function for this menu.
Different menus on the same page need separate init() functions.
The default is 'saf_xbinit_' plus the name of the database table
linked to this menu.
$id
The (usually) unique id of this item.
$title
The title of this item.
$parent
A reference to the parent of this item, or false if there
is no parent.
$children
An array of child items.
$url
URL prefix for pager links.
$data_table
$data_col
$tag_table
$tag_table_key
$tag_col
Return to Top
Methods
Tagger ($data_table, $tag_table = false)
fetch ()
getLevel ($n, $b, $c)
display ($url = 0)
Return to Top