Class Perms_UI

Description

The Perms_UI:: class provides UI methods for the Horde permissions system.

$Horde: framework/Perms/Perms/UI.php,v 1.27.2.23 2009/01/06 15:23:30 jan Exp $

Copyright 2001-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 /Perms/Perms/UI.php (line 17)


	
			
Variable Summary
Method Summary
 Perms_UI Perms_UI ( &$perms, Perms $perms)
 void renderForm ([ $form_script = 'edit.php'])
 string renderTree ([ $current = PERMS_ROOT])
 void setForm ( &$form, Horde_Form $form)
 void setupAddForm (Perms $permission, [string $force_choice = null])
 void setupDeleteForm (object $permission)
 void setupEditForm (Horde_Permission $permission)
 void setVars ( &$vars, Variables $vars)
 mixed validateAddForm ( &$info)
 mixed validateDeleteForm ( &$info)
 mixed validateEditForm ( &$info)
Variables
Horde_Form $_form = null (line 31)

The Horde_Form object that will be used for displaying the edit form.

Perms $_perms (line 24)

The Perms object we're displaying UI stuff for.

string $_type = 'matrix' (line 45)

The permission type.

Variables $_vars = null (line 38)

The Variables object used in Horde_Form.

Methods
Constructor Perms_UI (line 52)

Constructor.

Perms_UI Perms_UI ( &$perms, Perms $perms)
  • Perms $perms: The Perms object to display UI stuff for.
  • &$perms
renderForm (line 512)

Renders the edit form.

void renderForm ([ $form_script = 'edit.php'])
  • $form_script
renderTree (line 62)

Return a Horde_Tree representation of the permissions tree.

  • return: The html showing the permissions as a Horde_Tree.
string renderTree ([ $current = PERMS_ROOT])
  • $current
setForm (line 166)

Set an existing form object to use for the edit form.

void setForm ( &$form, Horde_Form $form)
  • Horde_Form $form: An existing Horde_Form object to use.
  • &$form
setupAddForm (line 189)

Create a form to add a permission.

void setupAddForm (Perms $permission, [string $force_choice = null])
  • Perms $permission
  • string $force_choice: If the permission to be added can be one of many, setting this will force the choice to one particular.
setupDeleteForm (line 474)

Create a permission deleting form.

void setupDeleteForm (object $permission)
  • object $permission
setupEditForm (line 237)

Create a permission editing form.

void setupEditForm (Horde_Permission $permission)
setVars (line 176)

Set an existing vars object to use for the edit form.

void setVars ( &$vars, Variables $vars)
  • Variables $vars: An existing Variables object to use.
  • &$vars
validateAddForm (line 222)

Function to validate any add form input.

  • return: Either false if the form does not validate correctly or an array with all the form values.
mixed validateAddForm ( &$info)
  • &$info
validateDeleteForm (line 493)

Function to validate any delete form input.

  • return: If the delete button confirmation has been pressed return true, if any other submit button has been pressed return false. If form did not validate return null.
mixed validateDeleteForm ( &$info)
  • &$info
validateEditForm (line 428)

Function to validate any edit form input.

  • return: Either false if the form does not validate correctly or an array with all the form values.
mixed validateEditForm ( &$info)
  • &$info

Documentation generated on Sun, 30 Jan 2011 05:22:59 +0000 by phpDocumentor 1.4.3