kernel/private/options/ezpextensionoptions.php

Show: inherited
Table of Contents

File containing the options object for the eZExtension class

Copyright
Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.  
License
eZ Business Use License Agreement Version 2.0  
Package
kernel  
Version
4.6.0  

\ezpExtensionOptions

Package: kernel

Class containing options for eZExtension, this option system is only used by eZExtension::getHandlerClass so far.

Parent(s)
\ezcBaseOptions
$options
array
\ezcBasePropertyNotFoundException If $options contains an undefined property \ezcBaseValueException If $options contains a property with an illegal value

Properties

Propertypublicstring  $aliasOptionalIndex= ''

Default : null

Default : null
Details
Type
string
Magic
 
Property
Default : null  
Propertypublicstring  $aliasSection= ''

Default : null

Default : null
Details
Type
string
Magic
 
Property
Default : null  
Propertypublicstring  $aliasVariable= ''

Default : null

Default : null
Details
Type
string
Magic
 
Property
Default : null  
Propertypublicstring  $callMethod= ''

Name of function to call on the object to see if handler is valid. Default : null

Name of function to call on the object to see if handler is valid. Default : null
Details
Type
string
Magic
 
Property
Name of function to call on the object to see if handler is valid. Default : null  
Propertypublicstring  $handlerIndex= ''

Sets this if you need to pick a certain index in the ini setting (given that it is an array). Default : null

Sets this if you need to pick a certain index in the ini setting (given that it is an array). Default : null
Details
Type
string
Magic
 
Property
Sets this if you need to pick a certain index in the ini setting (given that it is an array). Default : null  
Propertypublicarray  $handlerParams= ''

The list of parameters to pass to the handler Default : null

The list of parameters to pass to the handler Default : null
Details
Type
array
Magic
 
Property
The list of parameters to pass to the handler Default : null  
Propertypublicstring  $iniFile= ''

Contains the ini file to read the handler settings from.

Contains the ini file to read the handler settings from.
Details
Type
string
Magic
 
Property
Contains the ini file to read the handler settings from.  
Propertypublicstring  $iniSection= ''

Contains the ini [section] where the handler settings are defined. Default : 'HandlerSettings'

Contains the ini [section] where the handler settings are defined. Default : 'HandlerSettings'
Details
Type
string
Magic
 
Property
Contains the ini [section] where the handler settings are defined. Default : 'HandlerSettings'  
Propertypublicstring  $iniVariable= ''

Contains the variable name of the ini setting to read handler name from (it can be array or string). Default : 'HandlerClassName'

Contains the variable name of the ini setting to read handler name from (it can be array or string). Default : 'HandlerClassName'
Details
Type
string
Magic
 
Property
Contains the variable name of the ini setting to read handler name from (it can be array or string). Default : 'HandlerClassName'  

Methods

methodpublic__construct(  $options = array() ) : void

Parameters
Name Type Description
$options
methodpublic__set(  $name,  $value ) : void

Parameters
Name Type Description
$name
$value
Documentation was generated by DocBlox 0.18.1.