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

Public Member Functions

 _getAnnouncementTypesAssocId ()
 
 _setAnnouncementAssocId ($announcement)
 
 display ()
 
 execute ()
 
 getContextId ()
 
 getLocaleFieldNames ()
 
 initData ()
 
 PKPAnnouncementForm ($contextId, $announcementId=null)
 
 readInputData ()
 
 setDateExpire ($announcement)
 
- 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)
 

Public Attributes

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

Detailed Description

Form for managers to create/edit announcements.

Definition at line 19 of file PKPAnnouncementForm.inc.php.

Member Function Documentation

PKPAnnouncementForm::_getAnnouncementTypesAssocId ( )

Get the association information for announcement types.

Returns
array (assocType, assocId);

Definition at line 212 of file PKPAnnouncementForm.inc.php.

PKPAnnouncementForm::_setAnnouncementAssocId (   $announcement)

Helper function to assign the AssocType and the AssocId

Parameters
$announcementAnnouncement the announcement to be modified

Definition at line 221 of file PKPAnnouncementForm.inc.php.

PKPAnnouncementForm::display ( )

Display the form.

Definition at line 96 of file PKPAnnouncementForm.inc.php.

PKPAnnouncementForm::execute ( )

Save announcement.

Definition at line 145 of file PKPAnnouncementForm.inc.php.

PKPAnnouncementForm::getContextId ( )

Get the current context id.

Returns
int

Definition at line 76 of file PKPAnnouncementForm.inc.php.

References DAORegistry\getDAO().

PKPAnnouncementForm::getLocaleFieldNames ( )

Get the list of localized field names for this object

Returns
array

Definition at line 88 of file PKPAnnouncementForm.inc.php.

PKPAnnouncementForm::initData ( )

Initialize form data from current announcement.

Definition at line 113 of file PKPAnnouncementForm.inc.php.

PKPAnnouncementForm::PKPAnnouncementForm (   $contextId,
  $announcementId = null 
)

Constructor

Parameters
$contextIdint
announcementIdint leave as default for new announcement

Definition at line 37 of file PKPAnnouncementForm.inc.php.

PKPAnnouncementForm::readInputData ( )

Assign form data to user-submitted data.

Definition at line 137 of file PKPAnnouncementForm.inc.php.

PKPAnnouncementForm::setDateExpire (   $announcement)

Helper function to assign the date expire. Must be implemented by subclasses.

Parameters
$annoucementAnnouncement the announcement to be modified
Returns
boolean

Definition at line 200 of file PKPAnnouncementForm.inc.php.

Member Data Documentation

announcementId PKPAnnouncementForm::$announcementId

int the ID of the announcement being edited

Definition at line 24 of file PKPAnnouncementForm.inc.php.


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