PHP Class PhpIniRequirement

Inheritance: extends Requirement
Show file Open project: pagekit/pagekit

Public Methods

Method Description
__construct ( string $cfgName, boolean | callback $evaluation, boolean $approveCfgAbsence = false, string | null $testMessage = null, string | null $helpHtml = null, string | null $helpText = null, boolean $optional = false ) Constructor that initializes the requirement.

Method Details

__construct() public method

Constructor that initializes the requirement.
public __construct ( string $cfgName, boolean | callback $evaluation, boolean $approveCfgAbsence = false, string | null $testMessage = null, string | null $helpHtml = null, string | null $helpText = null, boolean $optional = false )
$cfgName string The configuration name used for ini_get()
$evaluation boolean | callback Either a Boolean indicating whether the configuration should evaluate to true or false, or a callback function receiving the configuration value as parameter to determine the fulfillment of the requirement
$approveCfgAbsence boolean If true the Requirement will be fulfilled even if the configuration option does not exist, i.e. ini_get() returns false. This is helpful for abandoned configs in later PHP versions or configs of an optional extension, like Suhosin. Example: You require a config to be true but PHP later removes this config and defaults it to true internally.
$testMessage string | null The message for testing the requirement (when null and $evaluation is a Boolean a default message is derived)
$helpHtml string | null The help text formatted in HTML for resolving the problem (when null and $evaluation is a Boolean a default help is derived)
$helpText string | null The help text (when null, it will be inferred from $helpHtml, i.e. stripped from HTML tags)
$optional boolean Whether this is only an optional recommendation not a mandatory requirement