EmailLog::load() - Code Metrics - Inspection of "Merge branch 'mariadanieldeepak-feature/90-retain-..." - sudar/email-log - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — dev/2.1.0 ( 0893b9...39cfde )

by Sudar

created 2017-09-12 17:49 UTC

EmailLog::load() B

↳ Parent: EmailLog

Complexity

Conditions	3
Paths	3

Size

Total Lines	29
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	11
CRAP Score	3.0052

Importance

Changes

Metric	Value
cc	3
eloc	10
nc	3
nop	0
dl	0
loc	29
ccs	11
cts	12
cp	0.9167
crap	3.0052
rs	8.8571
c	0
b	0
f	0

<?php namespace EmailLog\Core;

use EmailLog\Core\DB\TableManager;
use EmailLog\EmailLogAutoloader;

/**
 * The main plugin class.
 *
 * @since Genesis
 */
class EmailLog {

	/**
	 * Plugin Version number.
	 *
	 * @since Genesis
	 * @var string
	 */
	const VERSION = '2.0.2';

	/**
	 * Email Log Store URL.
	 */
	const STORE_URL = 'https://wpemaillog.com';

	/**
	 * Flag to track if the plugin is loaded.
	 *
	 * @since 2.0
	 * @access private
	 * @var bool
	 */
	private $loaded = false;

	/**
	 * Plugin file path.
	 *
	 * @since 2.0
	 * @access private
	 * @var string
	 */
	private $plugin_file;

	/**
	 * Filesystem directory path where translations are stored.
	 *
	 * @since 2.0
	 * @var string
	 */
	public $translations_path;

	/**
	 * Auto loader.
	 *
	 * @var \EmailLog\EmailLogAutoloader
	 */
	public $loader;

	/**
	 * Database Table Manager.
	 *
	 * @since 2.0
	 * @var \EmailLog\Core\DB\TableManager
	 */
	public $table_manager;

	/**
	 * Add-on Licenser.
	 * For non-admin requests it will not be set.
	 *
	 * @since 2.0
	 * @var \EmailLog\Addon\License\Licenser
	 */
	private $licenser = null;

	/**
	 * List of loadies.
	 *
	 * @var Loadie[]
	 */
	private $loadies = array();

	/**
	 * Initialize the plugin.
	 *
	 * @param string             $file          Plugin file.
	 * @param EmailLogAutoloader $loader        EmailLog Autoloader.
	 * @param TableManager       $table_manager Table Manager.
	 */
	public function __construct( $file, $loader, $table_manager ) {
		$this->plugin_file = $file;
		$this->loader = $loader;
		$this->table_manager = $table_manager;

		$this->add_loadie( $table_manager );

		$this->translations_path = dirname( plugin_basename( $this->plugin_file ) ) . '/languages/' ;
	}

	/**
	 * Set Licenser.
	 *
	 * @param \EmailLog\Addon\License\Licenser $licenser Add-on Licenser.
	 */
	public function set_licenser( $licenser ) {
		if ( $this->add_loadie( $licenser ) ) {
			$this->licenser = $licenser;
		}
	}

	/**
	 * Get Licenser.
	 *
	 * @return null|\EmailLog\Addon\License\Licenser
	 */
	public function get_licenser() {
		return $this->licenser;
	}

	/**
	 * Add an Email Log Loadie.
	 * The `load()` method of the Loadies will be called when Email Log is loaded.
	 *
	 * @param \EmailLog\Core\Loadie $loadie Loadie to be loaded.
	 *
	 * @return bool False if Email Log is already loaded or if $loadie is not of `Loadie` type. True otherwise.
	 */
	public function add_loadie( $loadie ) {
		if ( $this->loaded ) {
			return false;
		}

		if ( ! $loadie instanceof Loadie ) {
			return false;
		}

		$this->loadies[] = $loadie;

		return true;
	}

	/**
	 * Load the plugin.
	 */
	public function load() {
		if ( $this->loaded ) {
			return;
		}

		load_plugin_textdomain( 'email-log', false, $this->translations_path );

		$this->table_manager->load();

		foreach ( $this->loadies as $loadie ) {
			$loadie->load();
		}

		$this->loaded = true;

		/**
		 * Email Log plugin loaded.
		 *
		 * @since 2.0
		 */
		do_action( 'el_loaded' );

		/**
		 * Shows the Email Log only to allowed User roles set in the Plugin's settings page.
		 *
		 * @since 2.1.0
		 */
		add_action( 'admin_init', array( $this, 'remove_email_log_menu_by_user_role' ) );
	}

	/**
	 * Return Email Log version.
	 *
	 * @return string Email Log Version.
	 */
	public function get_version() {
		return self::VERSION;
	}

	/**
	 * Return the Email Log plugin directory path.
	 *
	 * @return string Plugin directory path.
	 */
	public function get_plugin_path() {
		return plugin_dir_path( $this->plugin_file );
	}

	/**
	 * Return the Email Log plugin file.
	 *
	 * @since 2.0.0
	 *
	 * @return string Plugin directory path.
	 */
	public function get_plugin_file() {
		return $this->plugin_file;
	}

	/**
	 * Get Email Log Store URL.
	 *
	 * @since 2.0.0
	 *
	 * @return string Store URL
	 */
	public function get_store_url() {
		return self::STORE_URL;
	}

	/**
	 * Shows the Email Log only to allowed User roles set in the Plugin's settings page.
	 */
	public function remove_email_log_menu_by_user_role() {
		if ( ! \EmailLog\Util\can_current_user_view_email_log() ) {
			remove_menu_page( 'email-log' );
		}
	}
}


1		<?php namespace EmailLog\Core;
2
3		use EmailLog\Core\DB\TableManager;
4		use EmailLog\EmailLogAutoloader;
5
6		/**
7		* The main plugin class.
8		*
9		* @since Genesis
10		*/
11		class EmailLog {
12
13		/**
14		* Plugin Version number.
15		*
16		* @since Genesis
17		* @var string
18		*/
19		const VERSION = '2.0.2';
20
21		/**
22		* Email Log Store URL.
23		*/
24		const STORE_URL = 'https://wpemaillog.com';
25
26		/**
27		* Flag to track if the plugin is loaded.
28		*
29		* @since 2.0
30		* @access private
31		* @var bool
32		*/
33		private $loaded = false;
34
35		/**
36		* Plugin file path.
37		*
38		* @since 2.0
39		* @access private
40		* @var string
41		*/
42		private $plugin_file;
43
44		/**
45		* Filesystem directory path where translations are stored.
46		*
47		* @since 2.0
48		* @var string
49		*/
50		public $translations_path;
51
52		/**
53		* Auto loader.
54		*
55		* @var \EmailLog\EmailLogAutoloader
56		*/
57		public $loader;
58
59		/**
60		* Database Table Manager.
61		*
62		* @since 2.0
63		* @var \EmailLog\Core\DB\TableManager
64		*/
65		public $table_manager;
66
67		/**
68		* Add-on Licenser.
69		* For non-admin requests it will not be set.
70		*
71		* @since 2.0
72		* @var \EmailLog\Addon\License\Licenser
73		*/
74		private $licenser = null;
75
76		/**
77		* List of loadies.
78		*
79		* @var Loadie[]
80		*/
81		private $loadies = array();
82
83		/**
84		* Initialize the plugin.
85		*
86		* @param string $file Plugin file.
87		* @param EmailLogAutoloader $loader EmailLog Autoloader.
88		* @param TableManager $table_manager Table Manager.
89		*/
90	1	public function __construct( $file, $loader, $table_manager ) {
91	1	$this->plugin_file = $file;
92	1	$this->loader = $loader;
93	1	$this->table_manager = $table_manager;
94
95	1	$this->add_loadie( $table_manager );
96
97	1	$this->translations_path = dirname( plugin_basename( $this->plugin_file ) ) . '/languages/' ;
98	1	}
99
100		/**
101		* Set Licenser.
102		*
103		* @param \EmailLog\Addon\License\Licenser $licenser Add-on Licenser.
104		*/
105		public function set_licenser( $licenser ) {
106		if ( $this->add_loadie( $licenser ) ) {
107		$this->licenser = $licenser;
108		}
109		}
110
111		/**
112		* Get Licenser.
113		*
114		* @return null\|\EmailLog\Addon\License\Licenser
115		*/
116		public function get_licenser() {
117		return $this->licenser;
118		}
119
120		/**
121		* Add an Email Log Loadie.
122		* The `load()` method of the Loadies will be called when Email Log is loaded.
123		*
124		* @param \EmailLog\Core\Loadie $loadie Loadie to be loaded.
125		*
126		* @return bool False if Email Log is already loaded or if $loadie is not of `Loadie` type. True otherwise.
127		*/
128	1	public function add_loadie( $loadie ) {
129	1	if ( $this->loaded ) {
130		return false;
131		}
132
133	1	if ( ! $loadie instanceof Loadie ) {
134		return false;
135		}
136
137	1	$this->loadies[] = $loadie;
138
139	1	return true;
140		}
141
142		/**
143		* Load the plugin.
144		*/
145	1	public function load() {
146	1	if ( $this->loaded ) {
147		return;
148		}
149
150	1	load_plugin_textdomain( 'email-log', false, $this->translations_path );
151
152	1	$this->table_manager->load();
153
154	1	foreach ( $this->loadies as $loadie ) {
155	1	$loadie->load();
156	1	}
157
158	1	$this->loaded = true;
159
160		/**
161		* Email Log plugin loaded.
162		*
163		* @since 2.0
164		*/
165	1	do_action( 'el_loaded' );
166
167		/**
168		* Shows the Email Log only to allowed User roles set in the Plugin's settings page.
169		*
170		* @since 2.1.0
171		*/
172	1	add_action( 'admin_init', array( $this, 'remove_email_log_menu_by_user_role' ) );
173	1	}
174
175		/**
176		* Return Email Log version.
177		*
178		* @return string Email Log Version.
179		*/
180		public function get_version() {
181		return self::VERSION;
182		}
183
184		/**
185		* Return the Email Log plugin directory path.
186		*
187		* @return string Plugin directory path.
188		*/
189		public function get_plugin_path() {
190		return plugin_dir_path( $this->plugin_file );
191		}
192
193		/**
194		* Return the Email Log plugin file.
195		*
196		* @since 2.0.0
197		*
198		* @return string Plugin directory path.
199		*/
200		public function get_plugin_file() {
201		return $this->plugin_file;
202		}
203
204		/**
205		* Get Email Log Store URL.
206		*
207		* @since 2.0.0
208		*
209		* @return string Store URL
210		*/
211		public function get_store_url() {
212		return self::STORE_URL;
213		}
214
215		/**
216		* Shows the Email Log only to allowed User roles set in the Plugin's settings page.
217		*/
218		public function remove_email_log_menu_by_user_role() {
219		if ( ! \EmailLog\Util\can_current_user_view_email_log() ) {
220		remove_menu_page( 'email-log' );
221		}
222		}
223		}
224

sudar / email-log

Push — dev/2.1.0 ( 0893b9...39cfde )

EmailLog::load() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like