EventEspresso\core\libraries\rest_api\controllers\model\Base

Complexity

Total Complexity

6

Size/Duplication

Total Lines	58
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	1
Bugs	1	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	set_requested_version()	0	4	1
A	get_model_version_info()	0	13	2
A	is_subclass_of_one()	0	8	3

<?php
namespace EventEspresso\core\libraries\rest_api\controllers\model;
use EventEspresso\core\libraries\rest_api\controllers\Base as Controller_Base;
use EventEspresso\core\libraries\rest_api\Model_Version_Info;

if ( !defined( 'EVENT_ESPRESSO_VERSION' ) ) {
	exit( 'No direct script access allowed' );
}

/**
 *
 * Base
 *
 * Base controller which also has something to do with models
 *
 * @package			Event Espresso
 * @subpackage
 * @author				Mike Nelson
 *
 */
class Base extends Controller_Base {
	/**
	 * Holds reference to the model version info, which knows the requested version
	 * @var Model_Version_Info
	 */
	protected $_model_version_info;

/**
	 * Sets the version the user requested
	 * @param string $version eg '4.8'
	 */
	public function set_requested_version( $version ) {
		parent::set_requested_version( $version );
		$this->_model_version_info = new Model_Version_Info( $version );
	}



	/**
	 * Gets the object that should be used for getting any info from the models,
	 * because it's takes the requested and current core version into account
	 *
	 * @return \EventEspresso\core\libraries\rest_api\Model_Version_Info
	 * @throws \EE_Error
	 */
	public function get_model_version_info(){
		if( ! $this->_model_version_info ) {
			throw new \EE_Error(
				sprintf(
					__(
						'Cannot use model version info before setting the requested version in the controller',
						'event_espresso'
					)
				)
			);
		}
		return $this->_model_version_info;
	}

	/**
	 * Determines if $object is of one of the classes of $classes. Similar to
	 * in_array(), except this checks if $object is a subclass of the classnames provided
	 * in $classnames
	 *
	 * @param object $object
	 * @param array $classnames
	 * @return boolean
	 */
	public function is_subclass_of_one( $object, $classnames ) {
		foreach( $classnames as $classname ) {
			if( is_a( $object, $classname ) ) {
				return true;
			}
		}
		return false;
	}

}

// End of file Base.php