VerificationCode
in package
implements
ActionInterface
Uses
BackwardCompatibility
Shows the verification code or let it be heard.
TrueType fonts supplied by www.LarabieFonts.com.
Table of Contents
Interfaces
- ActionInterface
- Interface for all action classes.
Properties
- $code : string
- $verification_id : string
- $obj : object
- $backcompat : array<string|int, mixed>
Methods
- call() : void
- Convenience method to load() and execute() an instance of this class.
- execute() : void
- Do the job.
- exportStatic() : void
- Provides a way to export a class's public static properties and methods to global namespace.
- load() : object
- Static wrapper for constructor.
- __construct() : mixed
- Constructor. Protected to force instantiation via self::load().
- createWaveFile() : bool
- Creates a wave file that spells the letters of $word.
- showCodeImage() : bool
- Show an image containing the visual verification code for registration.
- showLetterImage() : bool
- Show a letter for the visual verification code.
Properties
$code
public
string
$code
The verification code.
$verification_id
public
string
$verification_id
Identifier passed in 'vid' URL parameter.
$obj
protected
static object
$obj
An instance of this class. This is used by the load() method to prevent mulitple instantiations.
$backcompat
private
static array<string|int, mixed>
$backcompat
= ['func_names' => ['call' => 'VerificationCode']]
BackwardCompatibility settings for this class.
Methods
call()
Convenience method to load() and execute() an instance of this class.
public
static call() : void
execute()
Do the job.
public
execute() : void
exportStatic()
Provides a way to export a class's public static properties and methods to global namespace.
public
static exportStatic() : void
To do so:
- Use this trait in the class.
- At the END of the class's file, call its exportStatic() method.
Although it might not seem that way at first glance, this approach conforms to section 2.3 of PSR 1, since executing this method is simply a dynamic means of declaring functions when the file is included; it has no other side effects.
Regarding the $backcompat items:
A class's static properties are not exported to global variables unless explicitly included in $backcompat['prop_names']. Likewise, a class's static methods are not exported as global functions unless explicitly included in $backcompat['func_names'].
$backcompat['prop_names'] is a simple array where the keys are the names of one or more of a class's static properties, and the values are the names of global variables. In each case, the global variable will be set to a reference to the static property. Static properties that are not named in this array will not be exported.
$backcompat['func_names'] is a simple array where the keys are the names of one or more of a class's static methods, and the values are the names that should be used for global functions that will encapsulate those methods. Methods that are not named in this array will not be exported.
Adding non-static properties or methods to the $backcompat arrays will produce runtime errors. It is the responsibility of the developer to make sure not to do this.
load()
Static wrapper for constructor.
public
static load() : object
Return values
object —An instance of this class.
__construct()
Constructor. Protected to force instantiation via self::load().
protected
__construct() : mixed
createWaveFile()
Creates a wave file that spells the letters of $word.
protected
createWaveFile(string $word) : bool
Tries the user's language first, and defaults to english. Used by VerificationCode() (Register.php).
Parameters
- $word : string
Return values
bool —false on failure
showCodeImage()
Show an image containing the visual verification code for registration.
protected
showCodeImage(string $code) : bool
Requires the GD extension. Uses a random font for each letter from default_theme_dir/fonts. Outputs a gif or a png (depending on whether gif ix supported).
Parameters
- $code : string
-
The code to display
Return values
bool —False if something goes wrong. Otherwise, dies.
showLetterImage()
Show a letter for the visual verification code.
protected
showLetterImage(string $letter) : bool
Alternative function for showCodeImage() in case GD is missing. Includes an image from a random sub directory of default_theme_dir/fonts.
Parameters
- $letter : string
-
A letter to show as an image
Return values
bool —False if something went wrong. Otherwise, dies.