Documentation

Horde_Prefs_CategoryManager
in package

Class for handling a list of categories stored in a user's preferences.

Tags
author

Chuck Hagenbuch chuck@horde.org

category

Horde

Table of Contents

add()  : mixed
Add a new category.
colors()  : array<string|int, mixed>
Returns the color for each of the user's categories.
fgColors()  : array<string|int, mixed>
Returns the foreground color for each of the user's categories.
get()  : mixed
Get all categories.
getJavaScript()  : mixed
TODO
getSelect()  : mixed
TODO
remove()  : bool
Delete a category.
setColor()  : mixed
TODO
setColors()  : mixed
TODO

Methods

add()

Add a new category.

public static add(string $category) : mixed
Parameters
$category : string

The name of the category to add.

Return values
mixed

False on failure, or the new category's name.

colors()

Returns the color for each of the user's categories.

public static colors() : array<string|int, mixed>
Return values
array<string|int, mixed>

A list of colors, key is the category name, value is the HTML color code.

fgColors()

Returns the foreground color for each of the user's categories.

public static fgColors() : array<string|int, mixed>
Return values
array<string|int, mixed>

A list of colors, key is the category name, value is the HTML color code.

get()

Get all categories.

public static get() : mixed
Return values
mixed

getJavaScript()

TODO

public static getJavaScript(mixed $formname, mixed $elementname) : mixed
Parameters
$formname : mixed
$elementname : mixed
Return values
mixed

getSelect()

TODO

public static getSelect(mixed $id[, mixed $current = null ]) : mixed
Parameters
$id : mixed
$current : mixed = null
Return values
mixed

remove()

Delete a category.

public static remove(string $category) : bool
Parameters
$category : string

The category to remove.

Return values
bool

True on success, false on failure.

setColor()

TODO

public static setColor(mixed $category, mixed $color) : mixed
Parameters
$category : mixed
$color : mixed
Return values
mixed

setColors()

TODO

public static setColors(mixed $colors) : mixed
Parameters
$colors : mixed
Return values
mixed

Search results