WordPoints_App

Complexity

Total Complexity

20

Size/Duplication

Total Lines	240
Duplicated Lines	4.17 %

Coupling/Cohesion

Components	1
Dependencies	1

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	17	3
A	__isset()	0	3	1
C	__get()	10	66	9
A	__set()	0	12	2
A	__unset()	0	12	2
A	should_do_registry_init()	0	6	2
A	init()	0	14	1

<?php

/**
 * Class for WordPoints apps.
 *
 * @package wordpoints-hooks-api
 * @since   1.0.0
 */

/**
 * An app for WordPoints.
 *
 * Apps are self-contained APIs that can include sub-apps.
 *
 * The sub-apps are not required to be instances of WordPoints_App themselves, they
 * can be any sort of object.
 *
 * @since 1.0.0
 *
 * @property-read WordPoints_Class_Registry_Persistent $sub_apps Child apps registry.
 * @property-read object                               $*        Child app objects.
 */
class WordPoints_App {

	/**
	 * The main app.
	 *
	 * @since 1.0.0
	 *
	 * @var WordPoints_App
	 */
	public static $main;

	/**
	 * The slug of this app.
	 *
	 * @since 1.0.0
	 *
	 * @var string
	 */
	protected $slug;

	/**
	 * The full slug of this app, prefixed with the slug of the parent app.
	 *
	 * @since 1.0.0
	 *
	 * @var string
	 */
	protected $full_slug;

	/**
	 * A registry for child apps.
	 *
	 * @since 1.0.0
	 *
	 * @var WordPoints_Class_Registry_Persistent
	 */
	protected $sub_apps;

	/**
	 * The parent of this app, if this is a sub-app.
	 *
	 * @since 1.0.0
	 *
	 * @var WordPoints_App
	 */
	protected $parent;

	/**
	 * Whether to skip calling an action when each registry is initialized.
	 *
	 * @since 1.0.0
	 *
	 * @var bool
	 */
	protected $silent = false;

	/**
	 * Keeps track of which registries have been initialized.
	 *
	 * @since 1.0.0
	 *
	 * @var bool[]
	 */
	protected $did_init = array();

	/**
	 * Whether properties are allowed to be set.
	 *
	 * @since 1.0.0
	 *
	 * @var bool
	 */
	protected $allow_set = false;

	/**
	 * @since 1.0.0
	 */
	public function __construct( $slug, $parent = null ) {

		$this->slug = $slug;
		$this->full_slug = $slug;

		if ( $parent instanceof WordPoints_App ) {
			$this->parent = $parent;

			if ( 'apps' !== $this->parent->full_slug ) {
				$this->full_slug = $this->parent->full_slug . '-' . $this->full_slug;
			}
		}

		$this->sub_apps = new WordPoints_Class_Registry_Persistent();

		$this->init();
	}

	/**
	 * @since 1.0.0
	 */
	public function __isset( $var ) {
		return $this->sub_apps->is_registered( $var );
	}

	/**
	 * @since 1.0.0
	 */
	public function __get( $var ) {

		if ( 'sub_apps' === $var ) {
			return $this->$var;
		}

		$sub = $this->sub_apps->get( $var, array( $this ) );

		if ( ! $sub ) {
			return null;
		}

		if (
			empty( $this->did_init[ $var ] )
			&& ! self::$main->silent
			&& $this->should_do_registry_init( $sub )
		) {

			$is_protected_property = array_key_exists( $var, get_object_vars( $this ) );

			// When the below action is called it is possible that some hooked code
			// may attempt to access the property that is being initialized. However,
			// the __get() function will not be called recursively, meaning that
			// instead of the true value the code will get null. To solve this, we
			// temporarily set this as a public property. However, we can't do this
			// for properties that the class has declared, because otherwise it would
			// be possible to modify and then unset protected class properties.
			if ( ! $is_protected_property ) {

This code seems to be duplicated across your project.

				$this->allow_set = true;
				$this->$var = $sub;
				$this->allow_set = false;
			}

			/**
			 * Initialization of an app registry.
			 *
			 * The $var is the slug of the registry.
			 *
			 * @since 1.0.0
			 *
			 * @param WordPoints_Class_RegistryI|WordPoints_Class_Registry_ChildrenI
			 *        $registry The registry object.
			 */
			do_action( "wordpoints_init_app_registry-{$this->full_slug}-{$var}", $sub );

			// Because this property was public, it's possible that it might have
			// been modified inadvertently. If this happens we give a warning.
			if ( $sub !== $this->$var ) {
				_doing_it_wrong(
					__METHOD__
					, esc_html( "Do not modify the {$var} property directly." )
					, '1.0.0'
				);
			}

			if ( ! $is_protected_property ) {

This code seems to be duplicated across your project.

				$this->allow_set = true;
				unset( $this->$var );
				$this->allow_set = false;
			}

			$this->did_init[ $var ] = true;
		}

		return $sub;
	}

	/**
	 * @since 1.0.0
	 */
	public function __set( $var, $value ) {

		if ( $this->allow_set ) {
			$this->$var = $value;
		} else {
			_doing_it_wrong(
				__METHOD__
				, 'Sub apps must be registered using $app->sub_apps->register().'
				, '1.0.0'
			);
		}
	}

	/**
	 * @since 1.0.0
	 */
	public function __unset( $var ) {

		if ( $this->allow_set ) {
			unset( $this->$var );
		} else {
			_doing_it_wrong(
				__METHOD__
				, 'Sub apps must be deregistered using $app->sub_apps->deregister().'
				, '1.0.0'
			);
		}
	}

	/**
	 * Check whether to call the init action for a registry sub-app.
	 *
	 * @since 1.0.0
	 *
	 * @param object $registry The sub-app object.
	 *
	 * @return bool Whether to call the init action or not.
	 */
	protected function should_do_registry_init( $registry ) {
		return (
		   $registry instanceof WordPoints_Class_RegistryI
		   || $registry instanceof WordPoints_Class_Registry_ChildrenI
		);
	}

	/**
	 * Initialize this app.
	 *
	 * @since 1.0.0
	 */
	protected function init() {

		/**
		 * WordPoints app initialized.
		 *
		 * The dynamic portion of the action is the slug of the app being
		 * initialized.
		 *
		 * @since 1.0.0
		 *
		 * @param WordPoints_App $app The app object.
		 */
		do_action( "wordpoints_init_app-{$this->full_slug}", $this );
	}
}

// EOF