Class: XML_Query2XML_ConfigException

Source Location: /XML_Query2XML-1.1.0/XML/Query2XML.php

Class Overview

PEAR_Exception
   |
   --XML_Query2XML_Exception
      |
      --XML_Query2XML_ConfigException

Exception that handles configuration errors.

Author(s):

Inherited Variables

Inherited Methods

Class: XML_Query2XML_Exception

XML_Query2XML_Exception::__construct(): Constructor method

Class Details

[line 2499]
Exception that handles configuration errors.

This exception handels errors in the $options array passed to XML_Query2XML::getXML() and wrong arguments passed to the constructor via XML_Query2XML::factory(). It provides the special method addConfigParents() that allows for exact specification where the error is located in the configuration array.

See: XML_Query2XML::getXML()

[ Top ]

Class Variables

$_configParents = ''

[line 2504]

The parent configuration options of the option that caused the error

Var: e.g. [level1][level2]
Access: protected

Type:

string

[ Top ]

$_details = ''

[line 2509]

The error details.

Access: protected

Type:

string

[ Top ]

Method Detail

__construct (Constructor) [line 2549]

XML_Query2XML_ConfigException __construct(
string
$details, [mixed
$configParents = ''])

Constructor method

See: XML_Query2XML_ConfigException::addConfigParents()
Access: public

Overrides XML_Query2XML_Exception::__construct() (Constructor method)

Parameters:

string	`$details`	—	A detailed error message.
mixed	`$configParents`	—	A single parent configuration option as a string or one or more parents as an array of strings. This argument is optional.

[ Top ]

addConfigParents [line 2529]

void addConfigParents(
mixed
$configParents)

Add multiple parent configuration options.

Access: public

Parameters:

mixed $configParents — A single parent configuration option as a string or one or more parents as an array of strings. If the option is in [elements][albums] pass array('elements', 'albums') as argument.

[ Top ]