Open Journal Systems  3.3.0
GenreForm Class Reference
Inheritance diagram for GenreForm:
Form

Public Member Functions

 __construct ($genreId=null)
 
 execute (... $functionArgs)
 
 fetch ($request, $template=null, $display=false)
 
 getGenreId ()
 
 initData ($args)
 
 readInputData ()
 
 setGenreId ($genreId)
 
- 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 ()
 
 initData ()
 
 isValid ()
 
 readUserVars ($vars)
 
 setData ($key, $value=null)
 
 setDefaultFormLocale ($defaultLocale)
 
 setTemplate ($template)
 
 validate ($callHooks=true)
 

Data Fields

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

Detailed Description

Form for adding/editing a Submission File Genre.

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

Constructor & Destructor Documentation

◆ __construct()

GenreForm::__construct (   $genreId = null)

Constructor.

Definition at line 42 of file GenreForm.inc.php.

References Form\addCheck(), PKPApplication\get(), DAORegistry\getDAO(), and setGenreId().

Member Function Documentation

◆ execute()

GenreForm::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.
boolean

Reimplemented from Form.

Definition at line 123 of file GenreForm.inc.php.

References PKPApplication\get(), DAORegistry\getDAO(), Form\getData(), getGenreId(), and setGenreId().

◆ fetch()

GenreForm::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 99 of file GenreForm.inc.php.

References PKPTemplateManager\getManager(), and AppLocale\requireComponents().

◆ getGenreId()

GenreForm::getGenreId ( )

Get the genre id

Returns
int

Definition at line 34 of file GenreForm.inc.php.

References $_genreId.

Referenced by execute(), and initData().

◆ initData()

GenreForm::initData (   $args)

Initialize form data from current settings.

Parameters
$argsarray

Definition at line 65 of file GenreForm.inc.php.

References PKPApplication\get(), DAORegistry\getDAO(), and getGenreId().

◆ readInputData()

GenreForm::readInputData ( )

Assign form data to user-submitted data.

See also
Form::readInputData()

Reimplemented from Form.

Definition at line 115 of file GenreForm.inc.php.

References Form\readUserVars().

◆ setGenreId()

GenreForm::setGenreId (   $genreId)

Set the genre id

Parameters
$genreIdint

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

Referenced by __construct(), and execute().

Field Documentation

◆ $_genreId

GenreForm::$_genreId

the id for the genre being edited

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

Referenced by getGenreId().


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