Open Monograph Press  3.3.0
PublicationDateForm Class Reference
Inheritance diagram for PublicationDateForm:
Form

Public Member Functions

 __construct ($submission, $publication, $publicationDate)
 
 execute (... $functionArgs)
 
 fetch ($request, $template=null, $display=false)
 
 getPublication ()
 
 getPublicationDate ()
 
 getSubmission ()
 
 initData ()
 
 readInputData ()
 
 setPublication ($publication)
 
 setPublicationDate ($publicationDate)
 
 setSubmission ($submission)
 
- Public Member Functions inherited from Form
 __construct ($template=null, $callHooks=true, $requiredLocale=null, $supportedLocales=null)
 
 _decomposeArray ($name, $value, $stack)
 
 addCheck ($formValidator)
 
 addError ($field, $message)
 
 addErrorField ($field)
 
 addSupportedFormLocale ($supportedLocale)
 
 display ($request=null, $template=null)
 
 getData ($key)
 
 getDefaultFormLocale ()
 
 getErrorsArray ()
 
 getLocaleFieldNames ()
 
 getRequiredLocale ()
 
 getTemplate ()
 
 isValid ()
 
 readUserVars ($vars)
 
 setData ($key, $value=null)
 
 setDefaultFormLocale ($defaultLocale)
 
 setTemplate ($template)
 
 validate ($callHooks=true)
 

Data Fields

 $_publication
 
 $_publicationDate
 
 $_submission
 
- Data Fields inherited from Form
 $_checks
 
 $_data
 
 $_errors
 
 $_template
 
 $cssValidation
 
 $defaultLocale
 
 $errorFields
 
 $errorsArray
 
 $formSectionErrors
 
 $requiredLocale
 
 $supportedLocales
 

Detailed Description

Form for adding/editing a publication date.

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

Constructor & Destructor Documentation

◆ __construct()

PublicationDateForm::__construct (   $submission,
  $publication,
  $publicationDate 
)

Member Function Documentation

◆ execute()

PublicationDateForm::execute (   $functionArgs)

Execute the form's action. (Note that it is assumed that the form has already been validated.)

Parameters
mixed$functionArgs,...Arguments from the caller to be passed to the hook consumer
Returns
mixed Result from the consumer to be passed to the caller. Send a true-ish result if you want the caller to do something with the return value.

Reimplemented from Form.

Definition at line 193 of file PublicationDateForm.inc.php.

References fatalError(), DAORegistry\getDAO(), Form\getData(), getPublication(), getPublicationDate(), and getSubmission().

◆ fetch()

PublicationDateForm::fetch (   $request,
  $template = null,
  $display = false 
)

Returns a string of the rendered form

Parameters
$requestPKPRequest
$templatestring the template to be rendered, mandatory if no template has been specified on class instantiation.
$displayboolean
Returns
string the rendered form

Reimplemented from Form.

Definition at line 136 of file PublicationDateForm.inc.php.

References fatalError(), DAORegistry\getDAO(), PKPTemplateManager\getManager(), getPublication(), getPublicationDate(), and getSubmission().

◆ getPublication()

PublicationDateForm::getPublication ( )

Get the Publication

Returns
Publication

Definition at line 101 of file PublicationDateForm.inc.php.

References $_publication.

Referenced by execute(), and fetch().

◆ getPublicationDate()

PublicationDateForm::getPublicationDate ( )

Get the date

Returns
PublicationDate

Definition at line 69 of file PublicationDateForm.inc.php.

References $_publicationDate.

Referenced by execute(), fetch(), and initData().

◆ getSubmission()

PublicationDateForm::getSubmission ( )

Get the Submission

Returns
Submission

Definition at line 85 of file PublicationDateForm.inc.php.

References $_submission.

Referenced by execute(), and fetch().

◆ initData()

PublicationDateForm::initData ( )

Initialize form data from the publication date.

Reimplemented from Form.

Definition at line 120 of file PublicationDateForm.inc.php.

References getPublicationDate().

◆ readInputData()

PublicationDateForm::readInputData ( )

Assign form data to user-submitted data.

See also
Form::readInputData()

Reimplemented from Form.

Definition at line 180 of file PublicationDateForm.inc.php.

References Form\readUserVars().

◆ setPublication()

PublicationDateForm::setPublication (   $publication)

Set the Publication

Parameters
Publication

Definition at line 109 of file PublicationDateForm.inc.php.

Referenced by __construct().

◆ setPublicationDate()

PublicationDateForm::setPublicationDate (   $publicationDate)

Set the date

Parameters

Definition at line 77 of file PublicationDateForm.inc.php.

Referenced by __construct().

◆ setSubmission()

PublicationDateForm::setSubmission (   $submission)

Set the Submission

Parameters
Submission

Definition at line 93 of file PublicationDateForm.inc.php.

Referenced by __construct().

Field Documentation

◆ $_publication

PublicationDateForm::$_publication

The publication associated with the format being edited

Definition at line 23 of file PublicationDateForm.inc.php.

Referenced by getPublication().

◆ $_publicationDate

PublicationDateForm::$_publicationDate

PublicationDate the code being edited

Definition at line 26 of file PublicationDateForm.inc.php.

Referenced by getPublicationDate().

◆ $_submission

PublicationDateForm::$_submission

The submission associated with the format being edited

Definition at line 20 of file PublicationDateForm.inc.php.

Referenced by getSubmission().


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