swRegistrationUI
software registration UI for use with {eac}SoftwareRegistry - {eac}Doojigger for WordPress
Tags
Table of Contents
- form_request_activate() : string
- filter for options_form_post_ _activate_registration OR _revise_registration
- form_request_create() : string
- filter for options_form_post_ _create_registration
- form_request_delete() : string
- filter for options_form_post_ _delete_registration
- form_request_refresh() : string
- filter for options_form_post_ _refresh_registration
- getRegistryHelp() : array<string|int, mixed>
- get registry contextual help
- swRegistrationUI() : void
- swRegistrationUI method
- update_request_refresh() : void
- filter for version_updated
Methods
form_request_activate()
filter for options_form_post_ _activate_registration OR _revise_registration
public
form_request_activate(string $function[, string $fieldName = null ][, array<string|int, mixed> $metaData = null ][, string $priorValue = null ]) : string
Parameters
- $function : string
-
- the value (button) POSTed
- $fieldName : string = null
-
- the name of the field/option
- $metaData : array<string|int, mixed> = null
-
- the option metadata
- $priorValue : string = null
-
- the prior option value
Return values
string —$function
form_request_create()
filter for options_form_post_ _create_registration
public
form_request_create(string $function[, string $fieldName = null ][, array<string|int, mixed> $metaData = null ][, string $priorValue = null ]) : string
Parameters
- $function : string
-
- the value (button) POSTed
- $fieldName : string = null
-
- the name of the field/option
- $metaData : array<string|int, mixed> = null
-
- the option metadata
- $priorValue : string = null
-
- the prior option value
Return values
string —$function
form_request_delete()
filter for options_form_post_ _delete_registration
public
form_request_delete(string $function[, string $fieldName = null ][, array<string|int, mixed> $metaData = null ][, string $priorValue = null ]) : string
Parameters
- $function : string
-
- the value (button) POSTed
- $fieldName : string = null
-
- the name of the field/option
- $metaData : array<string|int, mixed> = null
-
- the option metadata
- $priorValue : string = null
-
- the prior option value OR registry key
Return values
string —$function
form_request_refresh()
filter for options_form_post_ _refresh_registration
public
form_request_refresh(string $function[, string $fieldName = null ][, array<string|int, mixed> $metaData = null ][, string $priorValue = null ]) : string
Parameters
- $function : string
-
- the value (button) POSTed
- $fieldName : string = null
-
- the name of the field/option
- $metaData : array<string|int, mixed> = null
-
- the option metadata
- $priorValue : string = null
-
- the prior option value OR registry key
Return values
string —$function
getRegistryHelp()
get registry contextual help
public
getRegistryHelp([string $registrationKey = null ]) : array<string|int, mixed>
Parameters
- $registrationKey : string = null
-
registry key
Return values
array<string|int, mixed> —help content
swRegistrationUI()
swRegistrationUI method
public
swRegistrationUI() : void
should be called from __construct() in 'options_settings_page' action add_action( 'options_settings_page', [$this,'swRegistrationUI'], PHP_INT_MAX );
Return values
void —update_request_refresh()
filter for version_updated
public
update_request_refresh([string|null $curVersion = null ][, string $newVersion = null ][, bool $asNetworkAdmin = false ]) : void
Parameters
- $curVersion : string|null = null
-
currently installed version number
- $newVersion : string = null
-
version being installed/updated
- $asNetworkAdmin : bool = false
-
running as network admin