pre_check.php

Show:

inherited

Table of Contents

File containing pre check functions as used to validate request

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Proprietary Use License v1.0
Package: index
Version: 4.5.0

Functions

eZCheckList(
          
          )
        
        :
          array

List of functions that should be checked by key identifier

Returns

Type	Description
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

Details

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..

eZCheckOrder(
          
          )
        
        :
          array

Return the order that prechecks should be checked

Returns

Type	Description
array

Details

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..

eZCheckUser(
          array $siteBasics, \eZURI $uri
          )
        
        :
          array | true | false | null

Check if user login is required. If so, use login handler to redirect user.

Parameters

Name	Type	Description
$siteBasics	array
$uri	\eZURI

Returns

Type	Description
array \| true \| false \| null	An associative array on redirect with 'module' and 'function' keys, true on successful and false/null on #fail.

Details

Deprecated: As of 4.4, moved to {@link eZUserLoginHandler::preCheck()}

eZCheckValidity(
          array $siteBasics, \eZURI $uri
          )
        
        :
          void

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

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

Parameters

Name	Type	Description
$siteBasics	array
$uri	\eZURI

Details

Deprecated: As of 4.4, moved to index.php for now

eZHandlePreChecks(
          array $siteBasics, \eZURI $uri
          )
        
        :
          array | null

Executes pre checks

Parameters

Name	Type	Description
$siteBasics	array
$uri	\eZURI

Returns

Type	Description
array \| null	A structure with redirection information or null if nothing should be done.

Details

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..

precheckAllowed(
          array $prechecks
          )
        
        :
          array

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

Parameters

Name	Type	Description
$prechecks	array

Returns

Type	Description
array	The same $prechecks array but adjusted according to the SitePrecheckRules rules

Details

Deprecated: As of 4.4, since SitePrecheckRules setting is not used or documented anywhere (documentation above was added when it was deprecated)