Agreement
in package
implements
ActionInterface
Uses
BackwardCompatibility
The purpose of this class is to show the user the registration agreement and privacy policy, and to ask the user to accept them if they haven't already done so.
Table of Contents
Interfaces
- ActionInterface
- Interface for all action classes.
Properties
- $obj : object
- $backcompat : array<string|int, mixed>
Methods
- call() : void
- Convenience method to load() and execute() an instance of this class.
- canRequireAgreement() : bool
- Checks whether this user needs to accept the registration agreement.
- canRequirePrivacyPolicy() : bool
- Checks whether this user needs to accept the privacy policy.
- execute() : void
- Shows the registration agreement and privacy policy.
- 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().
- prepareAgreementContext() : void
- Loads the registration agreement and privacy policy into Utils::$context for display.
Properties
$obj
protected
static object
$obj
An instance of the class. This is used by the load() method to prevent mulitple instantiations.
$backcompat
private
static array<string|int, mixed>
$backcompat
= ['func_names' => ['call' => 'Agreement', 'canRequireAgreement' => 'canRequireAgreement', 'canRequirePrivacyPolicy' => 'canRequirePrivacyPolicy']]
BackwardCompatibility settings for this class.
Methods
call()
Convenience method to load() and execute() an instance of this class.
public
static call() : void
canRequireAgreement()
Checks whether this user needs to accept the registration agreement.
public
static canRequireAgreement() : bool
Return values
bool —Whether they need to accept the agreement.
canRequirePrivacyPolicy()
Checks whether this user needs to accept the privacy policy.
public
static canRequirePrivacyPolicy() : bool
Return values
bool —Whether they need to accept the policy.
execute()
Shows the registration agreement and privacy policy.
public
execute() : void
If the user hasn't yet accepted one or both of them, also shows the button to do so.
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
prepareAgreementContext()
Loads the registration agreement and privacy policy into Utils::$context for display.
protected
prepareAgreementContext() : void