PHP Class SiteSetupForm, pkp-lib

Inheritance: extends PKPSiteSettingsForm

Public Methods

Method	Description
__construct ( $template = null )	Constructor.
_getDeleteFileLinkAction ( $settingName, $request ) : LinkAction	Get the delete file link action.
_getFileUploadLinkAction ( $settingName, $fileType, $request ) : LinkAction	Get a link action for file upload.
addValidationChecks ( ) : boolean	Handle any additional form validation checks.
deleteEntry ( )	Avoid warnings when Listbuilder::unpack tries to call this method.
deleteFile ( $fileSettingName, $request ) : boolean	Delete an uploaded file.
execute ( $request )	Save site settings.
fetch ( $request, $params = null )
initData ( $request )
insertEntry ( )	Avoid warnings when Listbuilder::unpack tries to call this method.
readInputData ( )	Assign form data to user-submitted data.
renderFileView ( $fileSettingName, $request ) : string	Render a template to show details about an uploaded file in the form and a link action to delete it.
updateEntry ( $request, $rowId, $newRowId )	Overriden method from ListbuilderHandler.

Constructor.

public __construct ( $template = null )
$template		string? Optional name of template file to use for form presentation

Get the delete file link action.

public _getDeleteFileLinkAction ( $settingName, $request ) : LinkAction
$request		Request
return	LinkAction

Get a link action for file upload.

public _getFileUploadLinkAction ( $settingName, $fileType, $request ) : LinkAction
$settingName		string
$fileType		string The uploaded file type.
$request		Request
return	LinkAction

(See SettingsTabHandler)

public addValidationChecks ( ) : boolean
return	boolean

Avoid warnings when Listbuilder::unpack tries to call this method.

public deleteEntry ( )

Delete an uploaded file.

public deleteFile ( $fileSettingName, $request ) : boolean
$fileSettingName		string
return	boolean

Save site settings.

public execute ( $request )

See also: PKPSiteSettingsForm::initData()

public initData ( $request )
$request		PKPRequest

Avoid warnings when Listbuilder::unpack tries to call this method.

public insertEntry ( )

Assign form data to user-submitted data.

public readInputData ( )

Render a template to show details about an uploaded file in the form and a link action to delete it.

public renderFileView ( $fileSettingName, $request ) : string
$fileSettingName		string The uploaded file setting name.
$request		Request
return	string

Overriden method from ListbuilderHandler.

public updateEntry ( $request, $rowId, $newRowId )
$request		Request
$rowId		mixed
$newRowId		array

public fetch ( $request, $params = null )
$request		PKPRequest
$params		array