FF_Action_AbstractProfile Class Reference

Inheritance diagram for FF_Action_AbstractProfile:

List of all members.

Public Member Functions
	createFormElements (&$in_formObj)
	getFormDefaults ($in_appName)
	getTableData ($in_rendererObj, $in_appName, $in_readOnly)
	successfulSave ()
	fillModelWithSubmitData ($in_submitData, $in_appName)
	_getFieldName ($in_fieldName, $in_appName)
	_getFieldParam ($in_field, $in_param, $in_appName)

---

Detailed Description

Definition at line 42 of file AbstractProfile.php.

---

Member Function Documentation

FF_Action_AbstractProfile::_getFieldName (  $  in_fieldName, $  in_appName )

Creates a field name out of the application name and the field by making all the elements for one application be an array of elements so as not to conflict with elements from other apps. Parameters: string  $in_fieldName The field name string  $in_appName The app name private Returns: string The field name Definition at line 146 of file AbstractProfile.php. Referenced by FF_Action_Profile::createFormElements(), FF_Action_Profile::getFormDefaults(), FF_Action_PermissionsProfile::getFormDefaults(), FF_Action_MaydayProfile::getFormDefaults(), and FF_Action_AlumniProfile::getFormDefaults().

FF_Action_AbstractProfile::_getFieldParam (  $  in_field, $  in_param, $  in_appName )

Gets one of the profile field parameters that can be set in the config file. Takes care of returning defaults if the value is not set. Parameters: string  $in_field The field name string  $in_param The param to get. Can be locked, required, value, desc string  $in_appName The app name private Returns: mixed The value from the specified param Definition at line 167 of file AbstractProfile.php. References $a_data. Referenced by FF_Action_Profile::getTableData(), and FF_Action_Profile::successfulSave().

FF_Action_AbstractProfile::createFormElements (  &$  in_formObj  )

Creates any form elements needed that this application wants to display on the user profile add/edit page. Parameters: object  $in_formObj The form object string  $in_appName The app name public Returns: void Definition at line 55 of file AbstractProfile.php.

FF_Action_AbstractProfile::fillModelWithSubmitData (  $  in_submitData, $  in_appName )

Gets the submit data and fills it into the model object. The model object is already filled with current data, so locked fields won't be lost. Parameters: array  $in_submitData The data from the submit form string  $in_appName The app name public Returns: void Reimplemented in FF_Action_AlumniProfile, FF_Action_MaydayProfile, FF_Action_PermissionsProfile, and FF_Action_Profile. Definition at line 127 of file AbstractProfile.php.

FF_Action_AbstractProfile::getFormDefaults (  $  in_appName  )

Converts the model to the appropriate form fields so that the default values can be filled into the form. Returns an array of 'field' => 'value' Parameters: string  $in_appName The application name public Returns: array The array of fields and values Reimplemented in FF_Action_AlumniProfile, FF_Action_MaydayProfile, FF_Action_PermissionsProfile, and FF_Action_Profile. Definition at line 72 of file AbstractProfile.php.

FF_Action_AbstractProfile::getTableData (  $  in_rendererObj, $  in_appName, $  in_readOnly )

Gets the array that we make a basic table out of. Has the form of 'data' => the cell data, 'title' => the cell description, 'titleStyles'/'dataStyles' => any attributes to apply to the title and data cells respectively. Parameters: object  $in_rendererObj The renderer object string  $in_appName The app name bool  $in_readOnly Get read-only table data (as opposed to form fields)? public Returns: array Definition at line 93 of file AbstractProfile.php.

FF_Action_AbstractProfile::successfulSave (   )

Called when the save() method is successful for an app. This allows it to update the output or modify session vars if needed. public Returns: void Reimplemented in FF_Action_Profile. Definition at line 108 of file AbstractProfile.php.

---

The documentation for this class was generated from the following file:

• AbstractProfile.php

---