Services::get_available_services() - Code Metrics - Inspection of "Add the beginnings of a dedicated page for extensi..." - humanmade/backupwordpress - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#909)

by Tom

created 2016-01-26 12:05 UTC

Services::get_available_services() A

↳ Parent: Services

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	3
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php

namespace HM\BackUpWordPress;

/**
 * A singleton to handle the registering, de-registering
 * and storage of services
 */
class Services {

	/**
	 * Store the current instance
	 *
	 * @access private
	 * @var object Services
	 * @static
	 */
	private static $instance;

	/**
	 * The array of services
	 *
	 * Should be of the format array( __FILE__ => __CLASS__ );
	 *
	 * @access private
	 * @var  array
	 * @static
	 */
	private $services = array();


	/**
	 * The current schedule object
	 *
	 * @access private
	 * @var object Scheduled_Backup
	 */
	private $schedule;


	/**
	 * Get the current instance
	 *
	 * @static
	 */
	public static function instance() {

		if ( ! isset( self::$instance ) )
			self::$instance = new Services;

		return self::$instance;

	}

	/**
	 * Get the array of registered services
	 *
	 * @param Scheduled_Backup $schedule

	 * @return Service[]
	 */
	public static function get_services( Scheduled_Backup $schedule = null ) {

		if ( is_null( $schedule ) ) {
			return self::instance()->services;
		}

		self::instance()->schedule = $schedule;

		return array_map( array( self::instance(), 'instantiate' ), self::instance()->services );

	}

	public function get_available_services() {
		return $this->get_services();
	}

	/**
	 * Register a new service
	 *
	 * @param $filepath
	 * @param $classname
	 * @return bool|WP_Error

	 */
	public static function register( $filepath, $classname ) {

		if ( ! file_exists( $filepath ) ) {
			return new \WP_Error( 'hmbkp_invalid_path_error', sprintf( __( 'Argument 1 for %s must be a valid filepath', 'backupwordpress' ), __METHOD__ ) );
		}

		self::instance()->services[ $filepath ] = $classname;

		return true;
	}

	/**
	 * De-register an existing service
	 * @param string $filepath
	 * @return bool|WP_Error

	 */
	public static function unregister( $filepath ) {


		if ( ! isset( self::instance()->services[ $filepath ] ) ) {
			return new \WP_Error( 'hmbkp_unrecognized_service_error', sprintf( __( 'Argument 1 for %s must be a registered service', 'backupwordpress' ), __METHOD__ ) );
		}

		unset( self::instance()->services[ $filepath ] );

		return true;
	}

	/**
	 * Instantiate the individual service classes
	 *
	 * @param string $classname
	 *
	 * @return array An array of instantiated classes

	 */
	private static function instantiate( $classname ) {


		if ( ! class_exists( $classname ) ) {
			return new \WP_Error( 'hmbkp_invalid_type_error', sprintf( __( 'Argument 1 for %s must be a valid class', 'backupwordpress' ), __METHOD__ ) );
		}

		/**
		 * @var Service
		 */
		$class = new $classname( self::instance()->schedule );

		return $class;

	}

}


1		<?php
2
3		namespace HM\BackUpWordPress;
4
5		/**
6		* A singleton to handle the registering, de-registering
7		* and storage of services
8		*/
9		class Services {
10
11		/**
12		* Store the current instance
13		*
14		* @access private
15		* @var object Services
16		* @static
17		*/
18		private static $instance;
19
20		/**
21		* The array of services
22		*
23		* Should be of the format array( __FILE__ => __CLASS__ );
24		*
25		* @access private
26		* @var array
27		* @static
28		*/
29		private $services = array();
		0 ignored issues – show Unused Code introduced 2015-11-21 01:52 UTC by Report Bug Copy Issue Report The property `$services` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
30
31		/**
32		* The current schedule object
33		*
34		* @access private
35		* @var object Scheduled_Backup
36		*/
37		private $schedule;
		0 ignored issues – show Unused Code introduced 2015-11-21 01:52 UTC by Report Bug Copy Issue Report The property `$schedule` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
38
39		/**
40		* Get the current instance
41		*
42		* @static
43		*/
44		public static function instance() {
45
46		if ( ! isset( self::$instance ) )
47		self::$instance = new Services;
48
49		return self::$instance;
50
51		}
52
53		/**
54		* Get the array of registered services
55		*
56		* @param Scheduled_Backup $schedule
		0 ignored issues – show Documentation introduced 2015-11-21 01:52 UTC by Report Bug Copy Issue Report Should the type for parameter `$schedule` not be `null\|Scheduled_Backup`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
57		* @return Service[]
58		*/
59		public static function get_services( Scheduled_Backup $schedule = null ) {
60
61		if ( is_null( $schedule ) ) {
62		return self::instance()->services;
63		}
64
65		self::instance()->schedule = $schedule;
66
67		return array_map( array( self::instance(), 'instantiate' ), self::instance()->services );
68
69		}
70
71		public function get_available_services() {
72		return $this->get_services();
73		}
74
75		/**
76		* Register a new service
77		*
78		* @param $filepath
79		* @param $classname
80		* @return bool\|WP_Error
		0 ignored issues – show Documentation introduced 2016-01-26 12:12 UTC by Report Bug Copy Issue Report Should the return type not be `\WP_Error\|boolean`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
81		*/
82	View Code Duplication	public static function register( $filepath, $classname ) {
		1 ignored issue – show Duplication introduced 2015-11-21 01:52 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
83		if ( ! file_exists( $filepath ) ) {
84		return new \WP_Error( 'hmbkp_invalid_path_error', sprintf( __( 'Argument 1 for %s must be a valid filepath', 'backupwordpress' ), __METHOD__ ) );
85		}
86
87		self::instance()->services[ $filepath ] = $classname;
88
89		return true;
90		}
91
92		/**
93		* De-register an existing service
94		* @param string $filepath
95		* @return bool\|WP_Error
		0 ignored issues – show Documentation introduced 2016-01-26 12:12 UTC by Report Bug Copy Issue Report Should the return type not be `\WP_Error\|boolean`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
96		*/
97	View Code Duplication	public static function unregister( $filepath ) {
		1 ignored issue – show Duplication introduced 2015-11-21 01:52 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
98
99		if ( ! isset( self::instance()->services[ $filepath ] ) ) {
100		return new \WP_Error( 'hmbkp_unrecognized_service_error', sprintf( __( 'Argument 1 for %s must be a registered service', 'backupwordpress' ), __METHOD__ ) );
101		}
102
103		unset( self::instance()->services[ $filepath ] );
104
105		return true;
106		}
107
108		/**
109		* Instantiate the individual service classes
110		*
111		* @param string $classname
112		*
113		* @return array An array of instantiated classes
		0 ignored issues – show Documentation introduced 2015-11-21 01:52 UTC by Report Bug Copy Issue Report Should the return type not be `object`? This check compares the return type specified in the `@return` annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch. Loading history...
114		*/
115	View Code Duplication	private static function instantiate( $classname ) {
		1 ignored issue – show Unused Code introduced 2015-11-21 01:52 UTC by Report Bug Copy Issue Report This method is not used, and could be removed. Loading history... Duplication introduced 2015-11-21 01:52 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
116
117		if ( ! class_exists( $classname ) ) {
118		return new \WP_Error( 'hmbkp_invalid_type_error', sprintf( __( 'Argument 1 for %s must be a valid class', 'backupwordpress' ), __METHOD__ ) );
119		}
120
121		/**
122		* @var Service
123		*/
124		$class = new $classname( self::instance()->schedule );
125
126		return $class;
127
128		}
129
130		}
131

humanmade / backupwordpress

GitHub Access Token became invalid

Pull Request — master (#909)

Services::get_available_services() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like