ICanBoogie\Module\Descriptor

Complexity

Total Complexity

2

Size/Duplication

Total Lines	136
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	normalize()	0	21	1
A	__construct()	0	1	1

<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <olivier.laviale@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie\Module;

/**
 * Module descriptor options.
 *
 * @package ICanBoogie\Module
 */
final class Descriptor
{
	/**
	 * Defines the category for the module.
	 *
	 * When modules are listed they are usually grouped by category. The category is also often
	 * used to create the main navigation menu of the admin interface.
	 *
	 * The category of the module is translated within the `module_category` scope.
	 */
	const CATEGORY = 'category';

	/**
	 * Defines the PHP class of the module.
	 *
	 * If the class is not defined it is resolved during indexing using the {@link NS}
	 * tag and the following pattern : `<namespace>\Module`.
	 */
	const CLASSNAME = 'class';

	/**
	 * Defines a short description of what the module do.
	 */
	const DESCRIPTION = 'description';

	/**
	 * Defines the state of the module.
	 */
	const DISABLED = 'disabled';

	/**
	 * Defines extra values.
	 */
	const EXTRA = 'extra';

	/**
	 * Defines the parent module the module inherits from.
	 */
	const INHERITS = 'inherits';

	/**
	 * Defines the identifier of the module.
	 *
	 * If the identifier is not defined the name of the module directory is used instead.
	 */
	const ID = 'id';

	/**
	 * Defines the state of the module.
	 *
	 * Required modules are always enabled.
	 */
	const REQUIRED = 'required';

	/**
	 * Defines the modules that the module requires.
	 *
	 * The required modules are defined using an array of identifiers.
	 */
	const REQUIRES = 'requires';

	/**
	 * Defines the models of the module.
	 */
	const MODELS = 'models';

	/**
	 * Defines the namespace of the module.
	 *
	 * This attribute must be defined at construct time.
	 */
	const NS = 'namespace';

	/**
	 * Path to the module's directory.
	 *
	 * This tag is resolved when the module is indexed.
	 */
	const PATH = 'path';

	/**
	 * General permission of the module.
	 */
	const PERMISSION = 'permission';

	/**
	 * Defines the permissions added by the module.
	 */
	const PERMISSIONS = 'permissions';

	/**
	 * Defines the title of the module.
	 *
	 * The title of the module is translated within the `module_title` scope.
	 */
	const TITLE = 'title';

	/**
	 * Defines the weight of the module.
	 *
	 * The weight of the module is resolved during modules indexing according to the
	 * {@link EXTENDS} and {@link REQUIRES} tags.
	 */
	const WEIGHT = 'weight';

	/**
	 * Normalizes a descriptor array.
	 *
	 * @param array $descriptor
	 *
	 * @return array
	 */
	static public function normalize(array $descriptor)
	{
		return $descriptor + [

			Descriptor::CATEGORY => null,
			Descriptor::CLASSNAME => $descriptor[Descriptor::NS] . '\Module',
			Descriptor::DESCRIPTION => null,
			Descriptor::DISABLED => false,
			Descriptor::EXTRA => [],
			Descriptor::INHERITS => null,
			Descriptor::ID => null,
			Descriptor::MODELS => [],
			Descriptor::PATH => null,
			Descriptor::PERMISSION => null,
			Descriptor::PERMISSIONS => [],
			Descriptor::REQUIRED => false,
			Descriptor::REQUIRES => [],
			Descriptor::WEIGHT => 0

		];
	}

	private function __construct() {}
}