Public Member Functions | |
| __construct ($user) | |
| execute (... $functionArgs) | |
| fetch ($request, $template=null, $display=false) | |
| initData () | |
| readInputData () | |
 Public Member Functions inherited from BaseProfileForm | |
| __construct ($template, $user) | |
| getUser () | |
| 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) | |
Additional Inherited Members | |
| Data Fields inherited from BaseProfileForm | |
| $_user | |
| Data Fields inherited from Form | |
| $_checks | |
| $_data | |
| $_errors | |
| $_template | |
| $cssValidation | |
| $defaultLocale | |
| $errorFields | |
| $errorsArray | |
| $formSectionErrors | |
| $requiredLocale | |
| $supportedLocales | |
Detailed Description
Form to edit user's API key settings.
Definition at line 20 of file APIProfileForm.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| APIProfileForm::__construct | ( | $user | ) |
Member Function Documentation
◆ execute()
| APIProfileForm::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 BaseProfileForm.
Definition at line 75 of file APIProfileForm.inc.php.
References PKPApplication\get(), Form\getData(), and Config\getVar().
◆ fetch()
| APIProfileForm::fetch | ( | $request, | |
$template = null, |
|||
$display = false |
|||
| ) |
Fetch the form to edit user's API key settings.
- Returns
- string JSON-encoded form contents.
- See also
- BaseProfileForm::fetch
Reimplemented from Form.
Definition at line 54 of file APIProfileForm.inc.php.
References PKPTemplateManager\getManager(), and Config\getVar().
◆ initData()
| APIProfileForm::initData | ( | ) |
Initialize form data for a new form.
Reimplemented from Form.
Definition at line 33 of file APIProfileForm.inc.php.
References BaseProfileForm\getUser(), and Form\setData().
◆ readInputData()
| APIProfileForm::readInputData | ( | ) |
Assign form data to user-submitted data.
Reimplemented from Form.
Definition at line 41 of file APIProfileForm.inc.php.
References Form\readUserVars().
The documentation for this class was generated from the following file:
