MessageGroupConfigurationParser Class Reference

Utility class to parse and validate message group configurations. More...

Public Member Functions
	getHopefullyValidConfigurations ( $data, $callback=null)
	Easy to use function to get valid group configurations from YAML.
	getDocumentsFromYaml ( $data)
	Given a Yaml string, returns the non-empty documents as an array.
	parseDocuments (array $documents)
	Returns group configurations from YAML documents.
	getBaseSchema ()
	validate (array $config)
	Validates group configuration against schema.

Static Public Member Functions
static	mergeTemplate (array $base, array $specific)
	Merges a document template (base) to actual definition (specific)

Detailed Description

Utility class to parse and validate message group configurations.

Since

2014.01

Definition at line 14 of file MessageGroupConfigurationParser.php.

Constructor & Destructor Documentation

__construct()

MessageGroupConfigurationParser::__construct

(

)

Definition at line 17 of file MessageGroupConfigurationParser.php.

Member Function Documentation

getBaseSchema()

MessageGroupConfigurationParser::getBaseSchema

(

)

Definition at line 110 of file MessageGroupConfigurationParser.php.

getDocumentsFromYaml()

MessageGroupConfigurationParser::getDocumentsFromYaml

(

$data

)

Given a Yaml string, returns the non-empty documents as an array.

Parameters

string

$data

Returns

string[]

Definition at line 72 of file MessageGroupConfigurationParser.php.

getHopefullyValidConfigurations()

MessageGroupConfigurationParser::getHopefullyValidConfigurations	(		$data,
			$callback = null )

Easy to use function to get valid group configurations from YAML.

Those not matching schema will be ignored, if schema validation is enabled.

Parameters

string	$data	Yaml
callable | null	$callback	Optional callback which is called on errors. Parameters are document index, processed configuration and error message.

Returns

array Group configurations indexed by message group id.

Definition at line 33 of file MessageGroupConfigurationParser.php.

mergeTemplate()

static MessageGroupConfigurationParser::mergeTemplate ( array $base, array $specific )

static

Merges a document template (base) to actual definition (specific)

Parameters

array	$base
array	$specific

Returns

array

Definition at line 155 of file MessageGroupConfigurationParser.php.

parseDocuments()

MessageGroupConfigurationParser::parseDocuments

(

array

$documents

)

Returns group configurations from YAML documents.

If there is document containing template, it will be merged with other configurations.

Parameters

array

$documents

Returns

array[][] Unvalidated group configurations

Definition at line 83 of file MessageGroupConfigurationParser.php.

validate()

MessageGroupConfigurationParser::validate

(

array

$config

)

Validates group configuration against schema.

Parameters

array

$config

Exceptions

Exception

If configuration is not valid.

Definition at line 120 of file MessageGroupConfigurationParser.php.

---

The documentation for this class was generated from the following file:

• MessageGroupConfigurationParser.php