access.php

Show:

inherited

Constants
Functions

Table of Contents

File containing (site)access functions

Copyright: Copyright (C) 1999-2010 eZ Systems AS. All rights reserved.
Deprecated: This file and its compatibility functions/constants will be removed in "4.6"
License: GNU General Public License v2.0
Package: index
Version: 4.4.0

Constants

 
                EZ_ACCESS_TYPE_DEFAULT
                = 1

Integer constants that identify the siteaccess matching used

See: \eZSiteAccess

 
                EZ_ACCESS_TYPE_URI
                = 2

 
                EZ_ACCESS_TYPE_PORT
                = 3

 
                EZ_ACCESS_TYPE_HTTP_HOST
                = 4

 
                EZ_ACCESS_TYPE_INDEX_FILE
                = 5

 
                EZ_ACCESS_TYPE_STATIC
                = 6

 
                EZ_ACCESS_TYPE_SERVER_VAR
                = 7

 
                EZ_ACCESS_TYPE_URL
                = 8

 
                EZ_ACCESS_SUBTYPE_PRE
                = 1

 
                EZ_ACCESS_SUBTYPE_POST
                = 2

Functions

accessAllowed(
          \eZURI $uri
          )
        
        :
          array

Checks if access is allowed to a module/view based on site.ini[SiteAccessRules]Rules settings

Parameters

Name	Type	Description
$uri	\eZURI

Returns

Type	Description
array	An associative array with: 'result' => bool Indicates if access is allowed 'module' => string Module name 'view' => string View name 'view_checked' => bool Indicates if view access has been checked

Details

See: \eZModule::accessAllowed()

accessDebugEnabled(
          
          )
        
        :
          bool

Checks if site access debug is enabled

Returns

Type	Description
bool

Details

See: \eZSiteAccess::debugEnabled()

accessExtraDebugEnabled(
          
          )
        
        :
          bool

Checks if extra site access debug is enabled

Returns

Type	Description
bool

Details

See: \eZSiteAccess::extraDebugEnabled()

accessMatchRegexp(
          string $text, string $reg, int $num
          )
        
        :
          string | null

Match a regex expression

Parameters

Name	Type	Description
$text	string
$reg	string
$num	int

Returns

Type	Description
string \| null

Details

See: \eZSiteAccess::matchRegexp()

accessMatchText(
          string $text, string $match_pre, string $match_post
          )
        
        :
          string | null

Match a text string with pre or/or post text strings

Parameters

Name	Type	Description
$text	string
$match_pre	string
$match_post	string

Returns

Type	Description
string \| null

Details

See: \eZSiteAccess::matchText()

accessType(
          \eZURI $uri, string $host, \string(numeric) $port, string $file
          )
        
        :
          array

Goes trough the access matching rules and returns the access match.

The returned match is an associative array with: name => string Name of the siteaccess (same as folder name) type => int The constant that represent the matching used uri_part => array(string) List of path elements that was used in start of url for the match

Parameters

Name	Type	Description
$uri	\eZURI
$host	string
$port	\string(numeric)
$file	string	Example '/index.php'

Returns

Type	Description
array

Details

See: \eZSiteAccess::match()

changeAccess(
          array $access
          )
        
        :
          array

Changes the site access to what's defined in $access. It will change the access path in eZSys and prepend an override dir to eZINI

Parameters

Name	Type	Description
$access	array	An associative array with 'name' (string), 'type' (int) and 'uri_part' (array).

Returns

Type	Description
array	The $access parameter

Details

See: \eZSiteAccess::change()