Class Prefs_CategoryManager

Description

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

$Horde: framework/Prefs/Prefs/CategoryManager.php,v 1.11.10.11 2009/01/06 15:23:31 jan Exp $

Copyright 2004-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /Prefs/Prefs/CategoryManager.php (line 17)


	
			
Method Summary
 mixed add (string $category)
 array colors ()
 array fgColors ()
 void get ()
 void getJavaScript ( $formname,  $elementname)
 void getSelect ( $id, [ $current = null])
 boolean remove (string $category)
 void setColor ( $category,  $color)
 void setColors ( $colors)
Methods
add (line 113)

Add a new category.

  • return: False on failure, or the new category's name.
mixed add (string $category)
  • string $category: The name of the category to add.
colors (line 171)

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

  • return: A list of colors, key is the category name, value is the HTML color code.
array colors ()
fgColors (line 199)

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

  • return: A list of colors, key is the category name, value is the HTML color code.
array fgColors ()
get (line 22)

Get all categories.

void get ()
getJavaScript (line 76)
void getJavaScript ( $formname,  $elementname)
  • $formname
  • $elementname
getSelect (line 37)
void getSelect ( $id, [ $current = null])
  • $id
  • $current
remove (line 139)

Delete a category.

  • return: True on success, false on failure.
boolean remove (string $category)
  • string $category: The category to remove.
setColor (line 212)
void setColor ( $category,  $color)
  • $category
  • $color
setColors (line 219)
void setColors ( $colors)
  • $colors

Documentation generated on Sun, 30 Jan 2011 05:15:44 +0000 by phpDocumentor 1.4.3