Module_Util::exec_module() - Code Metrics - Inspection of "Ajout submodule en interne pour téléchargement" - Eoxia/wpshop - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( eef885...465d0c )

unknown

created 2017-07-24 09:26 UTC

Module_Util::exec_module() B

↳ Parent: Module_Util

Complexity

Conditions	5
Paths	5

Size

Total Lines	16
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	5
eloc	9
nc	5
nop	2
dl	0
loc	16
rs	8.8571
c	0
b	0
f	0

<?php
/**
 * Gestion des modules
 *
 * @package Evarisk\Plugin
 */

namespace eoxia;

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

if ( ! class_exists( '\eoxia\Module_Util' ) ) {
	/**
	 * Gestion des modules
	 *
	 * @author Jimmy Latour <[email protected]>
	 * @version 1.1.0.0
	 */
	class Module_Util extends \eoxia\Singleton_Util {
		/**
		 * Le constructeur obligatoirement pour utiliser la classe \eoxia\Singleton_Util
		 *
		 * @return void nothing
		 */
		protected function construct() {}

		/**
		 * Parcours le fichier digirisk.config.json pour récupérer les chemins vers tous les modules.
		 * Initialise ensuite un par un, tous ses modules.
		 *
		 * @return mixed WP_Error si les configs de DigiRisk ne sont pas initialisés, ou si aucun module n'est présent.
		 */
		public function exec_module( $path, $plugin_slug ) {
			if ( empty( \eoxia\Config_Util::$init[ $plugin_slug ] ) ) {
				return new \WP_Error( 'broke', sptrinf( __( 'Les configurations de base de %s ne sont pas initialisées', $plugin_slug ), $plugin_slug ) );
			}

			if ( empty( \eoxia\Config_Util::$init[ $plugin_slug ]->modules ) ) {
				return new \WP_Error( 'broke', __( 'Aucun module a charger', $plugin_slug ) );
			}

			if ( ! empty( \eoxia\Config_Util::$init[ $plugin_slug ]->modules ) ) {
				foreach ( \eoxia\Config_Util::$init[ $plugin_slug ]->modules as $module_json_path ) {
					self::inc_config_module( $plugin_slug, $path . $module_json_path );
					self::inc_module( $plugin_slug, $path . $module_json_path );
				}
			}
		}

		/**
		 * Appelle la méthode init_config de \eoxia\Config_Util pour initialiser les configs du module
		 *
		 * @param  string $module_json_path Le chemin vers le dossier du module.
		 * @return void                   	nothing
		 */
		public function inc_config_module( $plugin_slug, $module_json_path ) {
			\eoxia\Config_Util::g()->init_config( $module_json_path, $plugin_slug );
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
		}

		/**
		 * Inclus les dépendences du module (qui sont défini dans le config.json du module en question)
		 *
		 * @param  string $module_json_path Le chemin vers le module.
		 * @return void                   	nothing
		 */
		public function inc_module( $plugin_slug, $module_json_path ) {
			$module_name = basename( $module_json_path, '.config.json' );
			$module_path = dirname( $module_json_path );

			if ( ! isset( \eoxia\Config_Util::$init[ $plugin_slug ]->$module_name->state ) || ( isset( \eoxia\Config_Util::$init[ $plugin_slug ]->$module_name->state ) && \eoxia\Config_Util::$init[ $plugin_slug ]->$module_name->state ) ) {
				if ( ! empty( \eoxia\Config_Util::$init[ $plugin_slug ]->$module_name->dependencies ) ) {

					foreach ( \eoxia\Config_Util::$init[ $plugin_slug ]->$module_name->dependencies as $dependence_folder => $list_option ) {
						$path_to_module_and_dependence_folder = $module_path . '/' . $dependence_folder . '/';

						if ( ! empty( $list_option->priority ) ) {
							$this->inc_priority_file( $path_to_module_and_dependence_folder, $dependence_folder, $list_option->priority );
						}

						\eoxia\Include_util::g()->in_folder( $path_to_module_and_dependence_folder );
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
					}
				}
			}
		}

		/**
		 * Inclus les fichiers prioritaires qui se trouvent dans la clé "priority" dans le .config.json du module
		 *
		 * @param  string $path_to_module_and_dependence_folder Le chemin vers le module.
		 * @param  string $dependence_folder                    le chemin vers le dossier à inclure.
		 * @param  array  $list_priority_file                    La liste des chemins des fichiers à inclure en priorité.
		 * @return void                                       	nothing
		 */
		public function inc_priority_file( $path_to_module_and_dependence_folder, $dependence_folder, $list_priority_file ) {

			if ( ! empty( $list_priority_file ) ) {
				foreach ( $list_priority_file as $file_name ) {
					$path_file = realpath( $path_to_module_and_dependence_folder . $file_name . '.' . $dependence_folder . '.php' );

					require_once( $path_file );
				}
			}
		}
	}
} // End if().



1		<?php
2		/**
3		* Gestion des modules
4		*
5		* @package Evarisk\Plugin
6		*/
7
8		namespace eoxia;
9
10		if ( ! defined( 'ABSPATH' ) ) {
11		exit;
12		}
13
14		if ( ! class_exists( '\eoxia\Module_Util' ) ) {
15		/**
16		* Gestion des modules
17		*
18		* @author Jimmy Latour <[email protected]>
19		* @version 1.1.0.0
20		*/
21		class Module_Util extends \eoxia\Singleton_Util {
22		/**
23		* Le constructeur obligatoirement pour utiliser la classe \eoxia\Singleton_Util
24		*
25		* @return void nothing
26		*/
27		protected function construct() {}
28
29		/**
30		* Parcours le fichier digirisk.config.json pour récupérer les chemins vers tous les modules.
31		* Initialise ensuite un par un, tous ses modules.
32		*
33		* @return mixed WP_Error si les configs de DigiRisk ne sont pas initialisés, ou si aucun module n'est présent.
34		*/
35		public function exec_module( $path, $plugin_slug ) {
36		if ( empty( \eoxia\Config_Util::$init[ $plugin_slug ] ) ) {
37		return new \WP_Error( 'broke', sptrinf( __( 'Les configurations de base de %s ne sont pas initialisées', $plugin_slug ), $plugin_slug ) );
38		}
39
40		if ( empty( \eoxia\Config_Util::$init[ $plugin_slug ]->modules ) ) {
41		return new \WP_Error( 'broke', __( 'Aucun module a charger', $plugin_slug ) );
42		}
43
44		if ( ! empty( \eoxia\Config_Util::$init[ $plugin_slug ]->modules ) ) {
45		foreach ( \eoxia\Config_Util::$init[ $plugin_slug ]->modules as $module_json_path ) {
46		self::inc_config_module( $plugin_slug, $path . $module_json_path );
47		self::inc_module( $plugin_slug, $path . $module_json_path );
48		}
49		}
50		}
51
52		/**
53		* Appelle la méthode init_config de \eoxia\Config_Util pour initialiser les configs du module
54		*
55		* @param string $module_json_path Le chemin vers le dossier du module.
56		* @return void nothing
57		*/
58		public function inc_config_module( $plugin_slug, $module_json_path ) {
59		\eoxia\Config_Util::g()->init_config( $module_json_path, $plugin_slug );
		0 ignored issues – show Bug introduced 2017-07-24 09:55 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `eoxia\Singleton_Util` as the method `init_config()` does only exist in the following sub-classes of `eoxia\Singleton_Util`: `eoxia\Config_Util`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
60		}
61
62		/**
63		* Inclus les dépendences du module (qui sont défini dans le config.json du module en question)
64		*
65		* @param string $module_json_path Le chemin vers le module.
66		* @return void nothing
67		*/
68		public function inc_module( $plugin_slug, $module_json_path ) {
69		$module_name = basename( $module_json_path, '.config.json' );
70		$module_path = dirname( $module_json_path );
71
72		if ( ! isset( \eoxia\Config_Util::$init[ $plugin_slug ]->$module_name->state ) \|\| ( isset( \eoxia\Config_Util::$init[ $plugin_slug ]->$module_name->state ) && \eoxia\Config_Util::$init[ $plugin_slug ]->$module_name->state ) ) {
73	View Code Duplication	if ( ! empty( \eoxia\Config_Util::$init[ $plugin_slug ]->$module_name->dependencies ) ) {
		0 ignored issues – show Duplication introduced 2017-07-24 09:55 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
74		foreach ( \eoxia\Config_Util::$init[ $plugin_slug ]->$module_name->dependencies as $dependence_folder => $list_option ) {
75		$path_to_module_and_dependence_folder = $module_path . '/' . $dependence_folder . '/';
76
77		if ( ! empty( $list_option->priority ) ) {
78		$this->inc_priority_file( $path_to_module_and_dependence_folder, $dependence_folder, $list_option->priority );
79		}
80
81		\eoxia\Include_util::g()->in_folder( $path_to_module_and_dependence_folder );
		0 ignored issues – show Bug introduced 2017-07-24 09:55 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `eoxia\Singleton_Util` as the method `in_folder()` does only exist in the following sub-classes of `eoxia\Singleton_Util`: `eoxia\Include_Util`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
82		}
83		}
84		}
85		}
86
87		/**
88		* Inclus les fichiers prioritaires qui se trouvent dans la clé "priority" dans le .config.json du module
89		*
90		* @param string $path_to_module_and_dependence_folder Le chemin vers le module.
91		* @param string $dependence_folder le chemin vers le dossier à inclure.
92		* @param array $list_priority_file La liste des chemins des fichiers à inclure en priorité.
93		* @return void nothing
94		*/
95	View Code Duplication	public function inc_priority_file( $path_to_module_and_dependence_folder, $dependence_folder, $list_priority_file ) {
		0 ignored issues – show Duplication introduced 2017-07-24 09:55 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...
96		if ( ! empty( $list_priority_file ) ) {
97		foreach ( $list_priority_file as $file_name ) {
98		$path_file = realpath( $path_to_module_and_dependence_folder . $file_name . '.' . $dependence_folder . '.php' );
99
100		require_once( $path_file );
101		}
102		}
103		}
104		}
105		} // End if().
		0 ignored issues – show Unused Code Comprehensibility introduced 2017-07-24 09:55 UTC by Report Bug Copy Issue Report `43%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
106

Eoxia / wpshop

Push — master ( eef885...465d0c )

Module_Util::exec_module() B

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like