{eac}Doojigger Reference

encryption_extension extends abstract_extension
in package

Extension: encryption - string encryption/decryption - {eac}Doojigger for WordPress

Tags
category

WordPress Plugin

author

Kevin Burkholder KBurkholder@EarthAsylum.com

copyright

Copyright (c) 2021 EarthAsylum Consulting <www.EarthAsylum.com>

version
1.x
link
https://eacDoojigger.earthasylum.com/
see
https://eacDoojigger.earthasylum.com/phpdoc/

Table of Contents

ALIAS  = null
ALLOW_ADMIN  = 0b1
ALLOW_ALL  = self::ALLOW_ADMIN | self::ALLOW_NETWORK | self::ALLOW_CRON | self::ALLOW_CLI
ALLOW_CLI  = 0b10000
ALLOW_CRON  = 0b1000
ALLOW_NETWORK  = 0b100
ALLOW_NON_PHP  = 0b1000000
DEFAULT_DISABLED  = 0b100000
ONLY_ADMIN  = 0b10
VERSION  = '24.0515.1'
__call()  : mixed
magic method to call plugin or extension methods
__construct()  : void
constructor method
__destruct()  : void
Extension destructor
__get()  : mixed
magic method to call parent plugin __get()
addActionsAndFilters()  : void
Add extension actions and filter
addShortcodes()  : void
Add extension shortcodes
admin_options_help()  : void
Add help tab on admin page
admin_options_settings()  : void
register options on options_settings_page
decode()  : string
the string was base64 encoded (for transport)
decrypt()  : string
decrypt the string
encode()  : string
the string is returned base 64 encoded (for transport)
encrypt()  : string
encrypt the string
getAlias()  : const
get the extension alias
getClassName()  : bool
getClassName - get the class/extension name without namespace
getVersion()  : const
get the extension version
initialize()  : void
initialize method - called from main plugin
is_network_enabled()  : bool
is_network_enabled - set or test extension enabled for use at the network level
is_network_option()  : bool|mixed
is this class network enabled and does option match a value
isEnabled()  : bool
isEnabled - set or test extension enabled for use
setKeys()  : void
get key/salt
validate_encryption_key()  : mixed
encryption key validation

Constants

ALLOW_ALL

public mixed ALLOW_ALL = self::ALLOW_ADMIN | self::ALLOW_NETWORK | self::ALLOW_CRON | self::ALLOW_CLI

Methods

__call()

magic method to call plugin or extension methods

public __call(mixed $method, mixed $arguments) : mixed
Parameters
$method : mixed

the method name or [extension,method]

$arguments : mixed

the arguments to method name

Return values
mixed —

result of method called

__construct()

constructor method

public __construct(object $plugin) : void
Parameters
$plugin : object

main plugin object

Return values
void —

__get()

magic method to call parent plugin __get()

public __get(string $property) : mixed
Parameters
$property : string

the property name or extension name

Return values
mixed —

result of plugin __get()

addActionsAndFilters()

Add extension actions and filter

public addActionsAndFilters() : void

Called after loading, instantiating, and initializing all extensions

Return values
void —

addShortcodes()

Add extension shortcodes

public addShortcodes() : void

Called after loading, instantiating, and initializing all extensions

Return values
void —

admin_options_settings()

register options on options_settings_page

public admin_options_settings() : void
Tags
access

public

Return values
void —

decode()

the string was base64 encoded (for transport)

public static decode(string $encrypted_string[, bool $site = false ]) : string
Parameters
$encrypted_string : string
  • data to be decrypted
$site : bool = false
  • use site keys
Return values
string —

| WP_Error

decrypt()

decrypt the string

public static decrypt(string $encrypted_string[, bool $site = false ]) : string
Parameters
$encrypted_string : string
  • data to be decrypted
$site : bool = false
  • use site keys
Return values
string —

| WP_Error

encode()

the string is returned base 64 encoded (for transport)

public static encode(string $data[, int $bits = null ][, bool $site = false ]) : string
Parameters
$data : string
  • data to be encrypted
$bits : int = null
  • cipher bit size (256, 192, 128)
$site : bool = false
  • use site keys
Return values
string —

| WP_Error

encrypt()

encrypt the string

public static encrypt(string $data[, int $bits = null ][, bool $site = false ]) : string
Parameters
$data : string
  • data to be encrypted
$bits : int = null
  • cipher bit size (256, 192, 128)
$site : bool = false
  • use site keys
Return values
string —

| WP_Error

getClassName()

getClassName - get the class/extension name without namespace

public getClassName([object $class = null ]) : bool
Parameters
$class : object = null

optional class object

Return values
bool —

getVersion()

get the extension version

public getVersion() : const
Return values
const —

VERSION string

is_network_enabled()

is_network_enabled - set or test extension enabled for use at the network level

public is_network_enabled() : bool
Return values
bool —

is_network_option()

is this class network enabled and does option match a value

public is_network_option(string $optionName[, mixed $value = null ]) : bool|mixed
Parameters
$optionName : string

option name

$value : mixed = null

check this value

Return values
bool|mixed —

option is set and has value

isEnabled()

isEnabled - set or test extension enabled for use

public isEnabled([bool|string $enabled = null ][, bool $perm = null ]) : bool
Parameters
$enabled : bool|string = null

true|false or other extension name

$perm : bool = null

optional, to permanently set enabled option

Return values
bool —

setKeys()

get key/salt

public static setKeys([bool $site = false ]) : void
Parameters
$site : bool = false
  • use site keys when truthy
Return values
void —

validate_encryption_key()

encryption key validation

public validate_encryption_key(string $value, string $fieldName, array<string|int, mixed> $metaData, mixed $priorValue) : mixed
Parameters
$value : string
  • the value POSTed
$fieldName : string
  • the name of the field/option
$metaData : array<string|int, mixed>
  • the option metadata
$priorValue : mixed
Return values
mixed —

Search results