ConstraintRegistry.php

<?php

namespace SMW\Constraint;

use SMW\ConstraintFactory;
use SMW\Constraint\Constraints\NullConstraint;
use SMW\Constraint\Constraints\NamespaceConstraint;
use SMW\Constraint\Constraints\UniqueValueConstraint;
use SMW\Constraint\Constraints\NonNegativeIntegerConstraint;
use SMW\Constraint\Constraints\MustExistsConstraint;
use SMW\Constraint\Constraints\SingleValueConstraint;
use SMW\Constraint\Constraints\MandatoryPropertiesConstraint;
use SMW\Constraint\Constraints\ShapeConstraint;
use SMW\MediaWiki\HookDispatcherAwareTrait;

/**
 * @license GNU GPL v2+
 * @since 3.1
 *
 * @author mwjames
 */
class ConstraintRegistry {

	use HookDispatcherAwareTrait;

	/**
	 * @var ConstraintFactory
	 */
	private $constraintFactory;

	/**
	 * @var []
	 */
	private $constraints = [];

	/**
	 * @var []
	 */
	private $instances = [];

	/**
	 * @var boolean
	 */
	private $hasViolation = false;

	/**
	 * @since 3.1
	 *
	 * @param ConstraintFactory $constraintFactory
	 */
	public function __construct( ConstraintFactory $constraintFactory ) {
		$this->constraintFactory = $constraintFactory;
	}

	/**
	 * @since 3.1
	 *
	 * @param string $key
	 * @param Constraint|string $constraint
	 */
	public function registerConstraint( $key, $constraint ) {

		if ( $this->constraints === [] ) {
			$this->initConstraints();
		}

		$this->constraints[$key] = $constraint;
	}

	/**
	 * @since 3.1
	 *
	 * @return []
	 */
	public function getConstraintKeys() {

		if ( $this->constraints === [] ) {
			$this->initConstraints();
		}

		return array_keys( $this->constraints );
	}

	/**
	 * @since 3.1
	 *
	 * @param string $key
	 *
	 * @return Constraint
	 */
	public function getConstraintByKey( $key ) {

		if ( $this->constraints === [] ) {
			$this->initConstraints();
		}

		if ( isset( $this->constraints[$key] ) ) {
			return $this->loadInstance( $this->constraints[$key] );
		}

		return $this->loadInstance( $this->constraints['null'] );
	}

	private function initConstraints() {

		$this->constraints = [
			'null' => NullConstraint::class,
			'allowed_namespaces' => NamespaceConstraint::class,
			'unique_value_constraint' => UniqueValueConstraint::class,
			'single_value_constraint' => SingleValueConstraint::class,
			'non_negative_integer' => NonNegativeIntegerConstraint::class,
			'must_exists' => MustExistsConstraint::class,
			'mandatory_properties' => MandatoryPropertiesConstraint::class,
			'shape_constraint' => ShapeConstraint::class
		];

		$this->hookDispatcher->onInitConstraints( $this );
	}

	private function loadInstance( $class ) {

		if ( is_callable( $class ) ) {
			return $class();
		} elseif ( $class instanceof Constraint ) {
			return $class;
		} elseif ( !isset( $this->instances[$class] ) ) {
			$this->instances[$class] = $this->constraintFactory->newConstraintByClass( $class );
		}

		return $this->instances[$class];
	}

}