Galette\Core\CheckModules Class Reference

Public Member Functions
	__construct (bool $do=true)
	doCheck (bool $translated=true)
	toHtml (bool $translated=true)
	isValid ()
	isGood (string $module)
	getGoods ()
	getShoulds ()
	getMissings ()

Protected Member Functions
	isExtensionLoaded (string $ext)

Detailed Description

Required modules checking

Author

Johan Cwiklinski johan.nosp@m.@x-t.nosp@m.nd.be

Constructor & Destructor Documentation

__construct()

Galette\Core\CheckModules::__construct

(

bool

$do = true

)

Constructor

Parameters

boolean

$do

Whether to do checks, defaults to true

Member Function Documentation

doCheck()

Galette\Core\CheckModules::doCheck

(

bool

$translated = true

)

Check various modules and dispatch them between:

• good: module that are present,
• may: modules that may be present but are not,
• should: modules that should be present but are not,
• missing: required modules that are missing

Parameters

boolean

$translated

Use translations (default to true)

Returns

void

getGoods()

Galette\Core\CheckModules::getGoods

(

)

Retrieve good modules

Returns

array<string,string>

getMissings()

Galette\Core\CheckModules::getMissings

(

)

Retrieve missing modules

Returns

array<int,string>

getShoulds()

Galette\Core\CheckModules::getShoulds

(

)

Retrieve modules that should be present

Returns

array<int,string>

isExtensionLoaded()

Galette\Core\CheckModules::isExtensionLoaded ( string  $ext )

protected

Check if a module is loaded

Parameters

string

$ext

Module name

Returns

bool

isGood()

Galette\Core\CheckModules::isGood

(

string

$module

)

Check if a specific module is OK for that instance

Parameters

string

$module

Module name to check

Returns

boolean

isValid()

Galette\Core\CheckModules::isValid

(

)

Check if it is ok to use Galette with current modules

Returns

boolean

toHtml()

Galette\Core\CheckModules::toHtml

(

bool

$translated = true

)

HTML formatted results for checks

Parameters

boolean

$translated

Use translations (default to true)

Returns

string

---

The documentation for this class was generated from the following file:

• /home/docs/checkouts/readthedocs.org/user_builds/galette-apidoc/checkouts/develop/galette/lib/Galette/Core/CheckModules.php