Inheritance diagram for LocaleFileForm:

Public Member Functions
	__construct ($customLocalePlugin, $filePath, $locale)

	fetch ($request)

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)

	execute (... $functionArgs)

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

	getData ($key)

	getDefaultFormLocale ()

	getErrorsArray ()

	getLocaleFieldNames ()

	getRequiredLocale ()

	getTemplate ()

	initData ()

	isValid ()

	readInputData ()

	readUserVars ($vars)

	setData ($key, $value=null)

	setDefaultFormLocale ($defaultLocale)

	setTemplate ($template)

	validate ($callHooks=true)

Data Fields
	$filePath

	$locale

	$plugin

Data Fields inherited from Form
	$_checks

	$_data

	$_errors

	$_template

	$cssValidation

	$defaultLocale

	$errorFields

	$errorsArray

	$formSectionErrors

	$requiredLocale

	$supportedLocales

Detailed Description

Definition at line 14 of file LocaleFileForm.inc.php.

Constructor & Destructor Documentation

◆ __construct()

LocaleFileForm::__construct	(	$customLocalePlugin,
		$filePath,
		$locale
	)

Constructor

Parameters

$customLocalePlugin	object
$filePath	string
$locale	string

Definition at line 36 of file LocaleFileForm.inc.php.

References $filePath, and $locale.

Member Function Documentation

◆ fetch()

LocaleFileForm::fetch ( $request )

Returns a string of the rendered form

Parameters

$request	PKPRequest
$template	string the template to be rendered, mandatory if no template has been specified on class instantiation.
$display	boolean

Returns: string the rendered form

Definition at line 46 of file LocaleFileForm.inc.php.

References $filePath, $locale, PKPTemplateManager\getManager(), CustomLocaleAction\isLocaleFile(), and LocaleFile\load().

Field Documentation

◆ $filePath

$filePath LocaleFileForm::$filePath

string

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

Referenced by __construct(), and fetch().

◆ $locale

$locale LocaleFileForm::$locale

string

Definition at line 25 of file LocaleFileForm.inc.php.

Referenced by __construct(), and fetch().

◆ $plugin

LocaleFileForm::$plugin

Custom locale plugin

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

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

LocaleFileForm.inc.php

Public Member Functions

Data Fields