Open Journal Systems  3.3.0
PKPAuthorForm Class Reference
Inheritance diagram for PKPAuthorForm:
Form AuthorForm

Public Member Functions

 __construct ($publication, $author)
 
 execute (... $functionParams)
 
 fetch ($request, $template=null, $display=false)
 
 getAuthor ()
 
 getPublication ()
 
 initData ()
 
 readInputData ()
 
 setAuthor ($author)
 
 setPublication ($publication)
 
- 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

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

Detailed Description

Form for adding/editing a author.

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

Constructor & Destructor Documentation

◆ __construct()

PKPAuthorForm::__construct (   $publication,
  $author 
)

Constructor.

Definition at line 28 of file PKPAuthorForm.inc.php.

References Form\addCheck(), setAuthor(), Form\setDefaultFormLocale(), and setPublication().

Member Function Documentation

◆ execute()

PKPAuthorForm::execute (   $functionParams)

Save author

See also
Form::execute()

Reimplemented from Form.

Definition at line 175 of file PKPAuthorForm.inc.php.

References fatalError(), PKPServices\get(), PKPApplication\get(), getAuthor(), DAORegistry\getDAO(), Form\getData(), and getPublication().

◆ fetch()

PKPAuthorForm::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 128 of file PKPAuthorForm.inc.php.

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

◆ getAuthor()

PKPAuthorForm::getAuthor ( )

Get the author

Returns
Author

Definition at line 63 of file PKPAuthorForm.inc.php.

References $_author.

Referenced by execute(), and initData().

◆ getPublication()

PKPAuthorForm::getPublication ( )

Get the Publication

Returns
Publication

Definition at line 79 of file PKPAuthorForm.inc.php.

References $_publication.

Referenced by execute(), and fetch().

◆ initData()

PKPAuthorForm::initData ( )

Initialize form data from the associated author.

Reimplemented from Form.

Definition at line 98 of file PKPAuthorForm.inc.php.

References getAuthor().

◆ readInputData()

PKPAuthorForm::readInputData ( )

Assign form data to user-submitted data.

See also
Form::readInputData()

Reimplemented from Form.

Definition at line 153 of file PKPAuthorForm.inc.php.

References Form\readUserVars().

◆ setAuthor()

PKPAuthorForm::setAuthor (   $author)

Set the author

Parameters

Definition at line 71 of file PKPAuthorForm.inc.php.

Referenced by __construct().

◆ setPublication()

PKPAuthorForm::setPublication (   $publication)

Set the Publication

Parameters
Publication

Definition at line 87 of file PKPAuthorForm.inc.php.

Referenced by __construct().

Field Documentation

◆ $_author

PKPAuthorForm::$_author

Author the author being edited

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

Referenced by getAuthor().

◆ $_publication

PKPAuthorForm::$_publication

The publication associated with the contributor being edited

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

Referenced by getPublication().


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