eZPublish  4.4
pre_check.php File Reference

Namespaces

 index
 File containing (site)access functions.
 

Functions

 eZCheckList ()
 List of functions that should be checked by key identifier. More...
 
 eZCheckOrder ()
 Return the order that prechecks should be checked. More...
 
 eZCheckUser (array &$siteBasics, eZURI $uri)
 Check if user login is required. More...
 
 eZCheckValidity (array &$siteBasics, eZURI $uri)
 Checks if the installation is valid and returns a module redirect if required. More...
 
 eZHandlePreChecks (array &$siteBasics, eZURI $uri)
 Executes pre checks. More...
 
 precheckAllowed (array $prechecks)
 Uses [SitePrecheckRules] to check if a precheck is allowed or not. More...
 

Function Documentation

eZCheckList ( )

List of functions that should be checked by key identifier.

Deprecated:
As of 4.4, since SitePrecheckRules setting is not used or documented anywhere (documentation above was added when it was deprecated) Also validity checks needs to be done before session init and user check after..
Returns
array An associative array with items to run a check on, each items is an associative array. The item must contain: function -> name of the function

Referenced by eZHandlePreChecks().

eZCheckOrder ( )

Return the order that prechecks should be checked.

Deprecated:
As of 4.4, since SitePrecheckRules setting is not used or documented anywhere (documentation above was added when it was deprecated) Also validity checks needs to be done before session init and user check after..
Returns
array

Referenced by eZHandlePreChecks().

eZCheckUser ( array &  $siteBasics,
eZURI  $uri 
)

Check if user login is required.

If so, use login handler to redirect user.

Deprecated:
As of 4.4, moved to eZUserLoginHandler::preCheck()
Parameters
array$siteBasics
eZURI$uri
Returns
array|true|false|null An associative array on redirect with 'module' and 'function' keys, true on successful and false/null on #fail.
eZCheckValidity ( array &  $siteBasics,
eZURI  $uri 
)

Checks if the installation is valid and returns a module redirect if required.

If CheckValidity in SiteAccessSettings is false then no check is done.

Deprecated:
As of 4.4, moved to index.php for now
Parameters
array$siteBasics
eZURI$uri
eZHandlePreChecks ( array &  $siteBasics,
eZURI  $uri 
)

Executes pre checks.

Deprecated:
As of 4.4, since SitePrecheckRules setting is not used or documented anywhere (documentation above was added when it was deprecated) Also validity checks needs to be done before session init and user check after..
Parameters
array$siteBasics
eZURI$uri
Returns
array|null A structure with redirection information or null if nothing should be done.
precheckAllowed ( array  $prechecks)

Uses [SitePrecheckRules] to check if a precheck is allowed or not.

Setting seems to be able to be defined like this (site.ini): [SitePrecheckRules] Rules[]

access can be enabled or disabled, and will affect the later

Rules[]=access;enabled

precheckall can be true (makes prior access rule affect all prechecks)

Rules[]=precheckall;true

precheck needs to be set to the same key as the precheck you want to allow / disallow

Rules[]=precheck;validity

Deprecated:
As of 4.4, since SitePrecheckRules setting is not used or documented anywhere (documentation above was added when it was deprecated)
Parameters
array$prechecks
Returns
array The same $prechecks array but adjusted according to the SitePrecheckRules rules

Referenced by eZHandlePreChecks().