Stencil_Handler_Factory

Complexity

Total Complexity

21

Size/Duplication

Total Lines	185
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

13 Methods

Rating	Name	Duplication	Size	Complexity
A	set_hierarchy_handler()	0	3	1
A	set_page_type_handler()	0	3	1
A	remove_page_type_handler()	0	3	1
A	set_page_type_hooker()	0	3	1
A	remove_page_type_hooker()	0	3	1
A	get_hierarchy_handler()	0	3	1
A	get_page_type_handler()	0	3	1
A	get_page_type_hooker()	0	3	1
A	run_page_type_handler()	0	3	1
A	run_page_type_hook()	0	3	1
A	execute_handler()	0	5	2
B	set_settable_handler()	0	22	6
A	get_settable_handler()	0	17	3

<?php
/**
 * Factory for PageType handlers
 *
 * @package Stencil
 */

/**
 * Class HandlerFactory
 */
class Stencil_Handler_Factory implements Stencil_Handler_Factory_Interface {

	/**
	 * Format the class name:
	 */
	const CLASS_FORMAT = 'Stencil_%s';

	/**
	 * List of registered Handlers
	 *
	 * @var array
	 */
	private static $handlers = array();

	/**
	 * Set a hierarchy handler for a page
	 *
	 * @param string                 $page Page to set.
	 * @param array|Traversable|null $handler Optional. Handler to use.
	 */
	public static function set_hierarchy_handler( $page, $handler = null ) {
		self::set_settable_handler( 'Hierarchy', $page, $handler = null );
	}

	/**
	 * Set a page type handler
	 *
	 * @param string   $page Page to set.
	 * @param callable $handler Handler to use.
	 */
	public static function set_page_type_handler( $page, $handler ) {
		self::set_settable_handler( 'PageType', $page, $handler );
	}

	/**
	 * Remove handler for a page.
	 *
	 * @param string $page Page to remove from.
	 */
	public static function remove_page_type_handler( $page ) {
		self::set_settable_handler( 'PageType', $page );
	}

	/**
	 * Set page type hooking function
	 *
	 * @param string   $page Page to set to.
	 * @param callable $handler Handler to use.
	 */
	public static function set_page_type_hooker( $page, $handler ) {
		self::set_settable_handler( 'PageHook', $page, $handler );
	}

	/**
	 * Remove page hooker from page
	 *
	 * @param string $page Page to remove from.
	 */
	public static function remove_page_type_hooker( $page ) {
		self::set_settable_handler( 'PageHook', $page );
	}

	/**
	 * Get current hierarchy handler for page
	 *
	 * @param string $page Page to get from.
	 *
	 * @return array|Traversable
	 */
	public static function get_hierarchy_handler( $page ) {
		return self::get_settable_handler( $page, 'Hierarchy' );
	}

	/**
	 * Get the current page type handler
	 *
	 * @param string $page Page to get from.
	 *
	 * @return callable
	 */
	public static function get_page_type_handler( $page ) {
		return self::get_settable_handler( $page, 'Page_Type' );
	}

	/**
	 * Get the current page type hooker
	 *
	 * @param string $page Page to get from.
	 *
	 * @return callable
	 */
	public static function get_page_type_hooker( $page ) {
		return self::get_settable_handler( $page, 'Page_Hook' );
	}

	/**
	 * Run the handler for the specified page
	 *
	 * @param string                    $page Page to call handler for
	 * @param Stencil_Handler_Interface $controller Controller that initiated the call
	 */
	public static function run_page_type_handler( $page, Stencil_Handler_Interface $controller ) {
		self::execute_handler( self::get_page_type_handler( $page ), $controller );
	}

	/**
	 * Run the hooker for the specified page
	 *
	 * @param string                    $page Page to call handler for
	 * @param Stencil_Handler_Interface $controller Controller that initiated the call
	 */
	public static function run_page_type_hook( $page, Stencil_Handler_Interface $controller ) {
		self::execute_handler( self::get_page_type_hooker( $page ), $controller );
	}

	/**
	 * Execute a handler if it is callable
	 *
	 * @param callable|array            $handler The handler for the page requested
	 * @param Stencil_Handler_Interface $controller Controller that initiated the call
	 */
	private static function execute_handler( $handler, Stencil_Handler_Interface $controller ) {
		if ( is_callable( $handler ) ) {
			call_user_func( $handler, $controller );
		}
	}

	/**
	 * Unified setter function
	 *
	 * @param string     $type Type of object.
	 * @param string     $page Page name.
	 * @param mixed|null $handler Handler to apply.
	 *
	 * @throws InvalidArgumentException For invalid argument types.
	 */
	private static function set_settable_handler( $type, $page, $handler = null ) {
		// Create NullObject for empty handler, i.e. remove functionality.
		if ( empty( $handler ) ) {
			$handler = Stencil_Subclass_Factory::create_null( sprintf( self::CLASS_FORMAT, $type ) );
		}

		switch ( $type ) {
			case 'Hierarchy':
				if ( ! is_array( $handler ) && ! ( $handler instanceof Traversable ) ) {
					throw new InvalidArgumentException( 'Expected $handler to be array or Traversable.' );
				}
				break;

			default:
				if ( ! is_callable( $handler ) ) {
					throw new InvalidArgumentException( 'Expected $handler to be callable.' );
				}
				break;
		}

		self::$handlers[ $type ][ $page ] = $handler;
	}

	/**
	 * Unified getter function
	 *
	 * @param string $page Page to get from.
	 * @param string $type Type to get.
	 *
	 * @return array Callable function
	 */
	private static function get_settable_handler( $page, $type ) {
		if ( ! isset( self::$handlers[ $type ][ $page ] ) ) {
			$handler = Stencil_Cached_Subclass_Factory::create_or_null( $page, sprintf( self::CLASS_FORMAT, $type ) );

			switch ( $type ) {
				case 'Hierarchy':
					break;
				default:
					$handler = array( $handler, 'execute' );
					break;
			}

			self::$handlers[ $type ][ $page ] = $handler;
		}

		return self::$handlers[ $type ][ $page ];
	}
}