Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
AppearanceForm Class Reference
Inheritance diagram for AppearanceForm:
ContextSettingsForm Form

Public Member Functions

 _getDeleteFileLinkAction ($settingName, $request)
 
 _getFileUploadLinkAction ($settingName, $fileType, $request)
 
 _renderAllFormImagesViews ($request)
 
 AppearanceForm ($wizardMode=false, $additionalSettings=array())
 
 deleteEntry ()
 
 deleteFile ($fileSettingName, $request)
 
 execute ($request)
 
 fetch ($request)
 
 getImagesSettingsName ()
 
 getLocaleFieldNames ()
 
 insertEntry ()
 
 renderFileView ($fileSettingName, $request)
 
 updateEntry ($request, $rowId, $newRowId)
 
- Public Member Functions inherited from ContextSettingsForm
 ContextSettingsForm ($settings, $template, $wizardMode)
 
 execute ($request)
 
 fetch ($request, $params=null)
 
 getSettings ()
 
 getWizardMode ()
 
 initData ($request)
 
 readInputData ($request)
 
 setSettings ($settings)
 
 setWizardMode ($wizardMode)
 
- Public Member Functions inherited from Form
 _decomposeArray ($name, $value, $stack)
 
 addCheck ($formValidator)
 
 addError ($field, $message)
 
 addErrorField ($field)
 
 display ($request=null, $template=null)
 
 execute ($object=null)
 
 fetch ($request, $template=null, $display=false)
 
 Form ($template=null, $callHooks=true, $requiredLocale=null, $supportedLocales=null)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getFormLocale ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 initData ()
 
 isLocaleResubmit ()
 
 isValid ()
 
 readInputData ()
 
 readUserDateVars ($vars)
 
 readUserVars ($vars)
 
 setData ($key, $value)
 
 setTemplate ($template)
 
 smartyFormLanguageChooser ($params, &$smarty)
 
 validate ($callHooks=true)
 

Additional Inherited Members

- Public Attributes inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Form to edit appearance settings.

Definition at line 18 of file AppearanceForm.inc.php.

Member Function Documentation

AppearanceForm::_getDeleteFileLinkAction (   $settingName,
  $request 
)

Get the delete file link action.

Parameters
$settingNamestring File setting name.
$requestRequest
Returns
LinkAction

Definition at line 329 of file AppearanceForm.inc.php.

AppearanceForm::_getFileUploadLinkAction (   $settingName,
  $fileType,
  $request 
)

Get a link action for file upload.

Parameters
$settingNamestring
$fileTypestring The uploaded file type.
$requestRequest
Returns
LinkAction

Definition at line 302 of file AppearanceForm.inc.php.

Referenced by fetch().

AppearanceForm::_renderAllFormImagesViews (   $request)

Render all form images views.

Parameters
$requestRequest
Returns
array

Definition at line 286 of file AppearanceForm.inc.php.

AppearanceForm::AppearanceForm (   $wizardMode = false,
  $additionalSettings = array() 
)

Constructor.

Parameters
$wizardModebool True IFF this form is to be opened in wizard mode
$additionalSettingsarray Additional settings to add, if any

Definition at line 31 of file AppearanceForm.inc.php.

AppearanceForm::deleteEntry ( )

Avoid warnings when Listbuilder::unpack tries to call this method.

Definition at line 266 of file AppearanceForm.inc.php.

AppearanceForm::deleteFile (   $fileSettingName,
  $request 
)

Delete an uploaded file.

Parameters
$fileSettingNamestring
$requestPKPRequest
Returns
boolean

Definition at line 176 of file AppearanceForm.inc.php.

AppearanceForm::execute (   $request)

See Also
Form::execute()
Parameters
$requestPKPRequest

Definition at line 206 of file AppearanceForm.inc.php.

AppearanceForm::fetch (   $request)

See Also
Form::fetch()
Parameters
$requestPKPRequest
$paramsarray optional

Definition at line 89 of file AppearanceForm.inc.php.

References _getFileUploadLinkAction().

AppearanceForm::getImagesSettingsName ( )

Get the images settings name (setting name => alt text locale key).

Returns
array

Definition at line 58 of file AppearanceForm.inc.php.

Referenced by insertEntry().

AppearanceForm::getLocaleFieldNames ( )

Get the list of field names that need to support multiple locales

Returns
array

Definition at line 72 of file AppearanceForm.inc.php.

AppearanceForm::insertEntry ( )

Avoid warnings when Listbuilder::unpack tries to call this method.

Definition at line 273 of file AppearanceForm.inc.php.

References getImagesSettingsName().

AppearanceForm::renderFileView (   $fileSettingName,
  $request 
)

Render a template to show details about an uploaded file in the form and a link action to delete it.

Parameters
$fileSettingNamestring The uploaded file setting name.
$requestRequest
Returns
string

Definition at line 132 of file AppearanceForm.inc.php.

AppearanceForm::updateEntry (   $request,
  $rowId,
  $newRowId 
)

Overriden method from ListbuilderHandler.

Parameters
$requestRequest
$rowIdmixed
$newRowIdarray

Definition at line 241 of file AppearanceForm.inc.php.


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