Give::setup_constants() - Code Metrics - Inspection of "Fix: do not cache _give_payment_meta value in back..." - ravinderk/Give - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — issues/1132 ( fe09c7...79489e )

by Ravinder

created 2017-06-26 05:43 UTC

Give::setup_constants() D

↳ Parent: Give

Complexity

Conditions	8
Paths	128

Size

Total Lines	37
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
eloc	15
nc	128
nop	0
dl	0
loc	37
rs	4.6666
c	0
b	0
f	0

<?php

/**
 * Plugin Name: Give - Donation Plugin
 * Plugin URI: https://givewp.com
 * Description: The most robust, flexible, and intuitive way to accept donations on WordPress.
 * Author: WordImpress
 * Author URI: https://wordimpress.com
 * Version: 2.0.0
 * Text Domain: give
 * Domain Path: /languages
 * GitHub Plugin URI: https://github.com/WordImpress/Give
 *
 * Give is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * any later version.
 *
 * Give is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Give. If not, see <https://www.gnu.org/licenses/>.
 *
 * A Tribute to Open Source:
 *
 * "Open source software is software that can be freely used, changed, and shared (in modified or unmodified form) by anyone. Open
 * source software is made by many people, and distributed under licenses that comply with the Open Source Definition."
 *
 * -- The Open Source Initiative
 *
 * Give is a tribute to the spirit and philosophy of Open Source. We at WordImpress gladly embrace the Open Source philosophy both
 * in how Give itself was developed, and how we hope to see others build more from our code base.
 *
 * Give would not have been possible without the tireless efforts of WordPress and the surrounding Open Source projects and their talented developers. Thank you all for your contribution to WordPress.
 *
 * - The WordImpress Team
 */

// Exit if accessed directly.
if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

if ( ! class_exists( 'Give' ) ) :

	/**
	 * Main Give Class
	 *
	 * @since 1.0
	 */
	final class Give {

		/** Singleton *************************************************************/

		/**
		 * Give Instance
		 *
		 * @since  1.0
		 * @access private
		 *
		 * @var    Give() The one true Give
		 */
		protected static $_instance;

		/**
		 * Give Roles Object
		 *
		 * @since  1.0
		 * @access public
		 *
		 * @var    Give_Roles object
		 */
		public $roles;

		/**
		 * Give Settings Object
		 *
		 * @since  1.0
		 * @access public
		 *
		 * @var    Give_Plugin_Settings object
		 */
		public $give_settings;

		/**
		 * Give Session Object
		 *
		 * This holds donation data for user's session.
		 *
		 * @since  1.0
		 * @access public
		 *
		 * @var    Give_Session object
		 */
		public $session;

		/**
		 * Give HTML Element Helper Object
		 *
		 * @since  1.0
		 * @access public
		 *
		 * @var    Give_HTML_Elements object
		 */
		public $html;

		/**
		 * Give Emails Object
		 *
		 * @since  1.0
		 * @access public
		 *
		 * @var    Give_Emails object
		 */
		public $emails;

		/**
		 * Give Email Template Tags Object
		 *
		 * @since  1.0
		 * @access public
		 *
		 * @var    Give_Email_Template_Tags object
		 */
		public $email_tags;

		/**
		 * Give Donors DB Object
		 *
		 * @since  1.0
		 * @access public
		 *
		 * @var    Give_DB_Donors object
		 */
		public $donors;

		/**
		 * Give Donor meta DB Object
		 *
		 * @since  1.6
		 * @access public
		 *
		 * @var    Give_DB_Donor_Meta object
		 */
		public $donor_meta;

		/**
		 * Give API Object
		 *
		 * @since  1.0
		 * @access public
		 *
		 * @var    Give_API object
		 */
		public $api;

		/**
		 * Give Template Loader Object
		 *
		 * @since  1.0
		 * @access public
		 *
		 * @var    Give_Template_Loader object
		 */
		public $template_loader;

		/**
		 * Give No Login Object
		 *
		 * @since  1.0
		 * @access public
		 *
		 * @var    Give_Email_Access object
		 */
		public $email_access;

		/**
		 * Give_tooltips Object
		 *
		 * @since  2.0
		 * @access public
		 *
		 * @var    Give_Tooltips object
		 */
		public $tooltips;

		/**
		 * Give notices Object
		 *
		 * @var    Give_Notices $notices
		 */
		public $notices;

		/**
		 * Main Give Instance
		 *
		 * Ensures that only one instance of Give exists in memory at any one
		 * time. Also prevents needing to define globals all over the place.
		 *
		 * @since     1.0
		 * @access    public
		 *
		 * @static
		 * @see       Give()
		 *
		 * @return    Give
		 */
		public static function instance() {
			if ( is_null( self::$_instance ) ) {
				self::$_instance = new self();
			}

			return self::$_instance;
		}

		/**
		 * Give Constructor.
		 */
		public function __construct() {
			$this->setup_constants();
			$this->includes();
			$this->init_hooks();

			do_action( 'give_loaded' );
		}

		/**
		 * Hook into actions and filters.
		 *
		 * @since  1.8.9
		 */
		private function init_hooks() {
			register_activation_hook( __FILE__, 'give_install' );
			add_action( 'plugins_loaded', array( $this, 'init' ), 0 );
		}

		/**
		 * Init Give when WordPress Initializes.
		 *
		 * @since 1.8.9
		 */
		public function init() {

			/**
			 * Fires before the Give core is initialized.
			 *
			 * @since 1.8.9
			 */
			do_action( 'before_give_init' );

			// Set up localization.
			$this->load_textdomain();

			$this->roles           = new Give_Roles();
			$this->api             = new Give_API();
			$this->give_settings   = new Give_Admin_Settings();
			$this->session         = new Give_Session();
			$this->html            = new Give_HTML_Elements();
			$this->emails          = new Give_Emails();
			$this->email_tags      = new Give_Email_Template_Tags();
			$this->donors          = new Give_DB_Donors();
			$this->donor_meta      = new Give_DB_Donor_Meta();
			$this->template_loader = new Give_Template_Loader();
			$this->email_access    = new Give_Email_Access();
			$this->tooltips        = new Give_Tooltips();
			$this->notices         = new Give_Notices();

			/**
			 * Fire the action after Give core loads.
			 *
			 * @param class Give class instance.
			 *
			 * @since 1.8.7
			 */
			do_action( 'give_init', $this );

		}

		/**
		 * Throw error on object clone
		 *
		 * The whole idea of the singleton design pattern is that there is a single
		 * object, therefore we don't want the object to be cloned.
		 *
		 * @since  1.0
		 * @access protected
		 *
		 * @return void
		 */
		public function __clone() {
			// Cloning instances of the class is forbidden.
			_doing_it_wrong( __FUNCTION__, __( 'Cheatin&#8217; huh?', 'give' ), '1.0' );
		}

		/**
		 * Disable unserializing of the class
		 *
		 * @since  1.0
		 * @access protected
		 *
		 * @return void
		 */
		public function __wakeup() {
			// Unserializing instances of the class is forbidden.
			_doing_it_wrong( __FUNCTION__, __( 'Cheatin&#8217; huh?', 'give' ), '1.0' );
		}

		/**
		 * Setup plugin constants
		 *
		 * @since  1.0
		 * @access private
		 *
		 * @return void
		 */
		private function setup_constants() {

			// Plugin version
			if ( ! defined( 'GIVE_VERSION' ) ) {
				define( 'GIVE_VERSION', '2.0.0' );
			}

			// Plugin Folder Path
			if ( ! defined( 'GIVE_PLUGIN_DIR' ) ) {
				define( 'GIVE_PLUGIN_DIR', plugin_dir_path( __FILE__ ) );
			}

			// Plugin Folder URL
			if ( ! defined( 'GIVE_PLUGIN_URL' ) ) {
				define( 'GIVE_PLUGIN_URL', plugin_dir_url( __FILE__ ) );
			}

			// Plugin Basename aka: "give/give.php"
			if ( ! defined( 'GIVE_PLUGIN_BASENAME' ) ) {
				define( 'GIVE_PLUGIN_BASENAME', plugin_basename( __FILE__ ) );
			}

			// Plugin Root File
			if ( ! defined( 'GIVE_PLUGIN_FILE' ) ) {
				define( 'GIVE_PLUGIN_FILE', __FILE__ );
			}

			// Make sure CAL_GREGORIAN is defined
			if ( ! defined( 'CAL_GREGORIAN' ) ) {
				define( 'CAL_GREGORIAN', 1 );
			}

			// PHP version
			if ( ! defined( 'GIVE_REQUIRED_PHP_VERSION' ) ) {
				define( 'GIVE_REQUIRED_PHP_VERSION', '5.3' );
			}
		}

		/**
		 * Include required files
		 *
		 * @since  1.0
		 * @access private
		 *
		 * @return void
		 */
		private function includes() {
			global $give_options;
function myFunction($a, $b) {
    // Do something
}

			require_once GIVE_PLUGIN_DIR . 'includes/admin/class-admin-settings.php';
			require_once GIVE_PLUGIN_DIR . 'includes/admin/class-give-settings.php';
			$give_options = give_get_settings();

			require_once GIVE_PLUGIN_DIR . 'includes/admin/give-metabox-functions.php';
			require_once GIVE_PLUGIN_DIR . 'includes/class-give-cache.php';
			require_once GIVE_PLUGIN_DIR . 'includes/post-types.php';
			require_once GIVE_PLUGIN_DIR . 'includes/scripts.php';
			require_once GIVE_PLUGIN_DIR . 'includes/ajax-functions.php';
			require_once GIVE_PLUGIN_DIR . 'includes/actions.php';
			require_once GIVE_PLUGIN_DIR . 'includes/filters.php';
			require_once GIVE_PLUGIN_DIR . 'includes/api/class-give-api.php';
			require_once GIVE_PLUGIN_DIR . 'includes/class-give-tooltips.php';
			require_once GIVE_PLUGIN_DIR . 'includes/class-notices.php';

			require_once GIVE_PLUGIN_DIR . 'includes/class-give-roles.php';
			require_once GIVE_PLUGIN_DIR . 'includes/class-give-template-loader.php';
			require_once GIVE_PLUGIN_DIR . 'includes/class-give-donate-form.php';
			require_once GIVE_PLUGIN_DIR . 'includes/class-give-db.php';
			require_once GIVE_PLUGIN_DIR . 'includes/class-give-db-donors.php';
			require_once GIVE_PLUGIN_DIR . 'includes/class-give-db-donor-meta.php';
			require_once GIVE_PLUGIN_DIR . 'includes/class-give-donor.php';
			require_once GIVE_PLUGIN_DIR . 'includes/class-give-stats.php';
			require_once GIVE_PLUGIN_DIR . 'includes/class-give-session.php';
			require_once GIVE_PLUGIN_DIR . 'includes/class-give-html-elements.php';
			require_once GIVE_PLUGIN_DIR . 'includes/class-give-logging.php';
			require_once GIVE_PLUGIN_DIR . 'includes/class-give-license-handler.php';
			require_once GIVE_PLUGIN_DIR . 'includes/class-give-cron.php';
			require_once GIVE_PLUGIN_DIR . 'includes/class-give-email-access.php';

			require_once GIVE_PLUGIN_DIR . 'includes/country-functions.php';
			require_once GIVE_PLUGIN_DIR . 'includes/template-functions.php';
			require_once GIVE_PLUGIN_DIR . 'includes/misc-functions.php';
			require_once GIVE_PLUGIN_DIR . 'includes/forms/functions.php';
			require_once GIVE_PLUGIN_DIR . 'includes/forms/template.php';
			require_once GIVE_PLUGIN_DIR . 'includes/forms/widget.php';
			require_once GIVE_PLUGIN_DIR . 'includes/shortcodes.php';
			require_once GIVE_PLUGIN_DIR . 'includes/formatting.php';
			require_once GIVE_PLUGIN_DIR . 'includes/price-functions.php';
			require_once GIVE_PLUGIN_DIR . 'includes/error-tracking.php';
			require_once GIVE_PLUGIN_DIR . 'includes/process-donation.php';
			require_once GIVE_PLUGIN_DIR . 'includes/login-register.php';
			require_once GIVE_PLUGIN_DIR . 'includes/user-functions.php';
			require_once GIVE_PLUGIN_DIR . 'includes/plugin-compatibility.php';
			require_once GIVE_PLUGIN_DIR . 'includes/deprecated/deprecated-classes.php';
			require_once GIVE_PLUGIN_DIR . 'includes/deprecated/deprecated-functions.php';
			require_once GIVE_PLUGIN_DIR . 'includes/deprecated/deprecated-actions.php';
			require_once GIVE_PLUGIN_DIR . 'includes/deprecated/deprecated-filters.php';

			require_once GIVE_PLUGIN_DIR . 'includes/payments/backward-compatibility.php';
			require_once GIVE_PLUGIN_DIR . 'includes/payments/functions.php';
			require_once GIVE_PLUGIN_DIR . 'includes/payments/actions.php';
			require_once GIVE_PLUGIN_DIR . 'includes/payments/class-payment-stats.php';
			require_once GIVE_PLUGIN_DIR . 'includes/payments/class-payments-query.php';
			require_once GIVE_PLUGIN_DIR . 'includes/payments/class-give-payment.php';

			require_once GIVE_PLUGIN_DIR . 'includes/gateways/functions.php';
			require_once GIVE_PLUGIN_DIR . 'includes/gateways/actions.php';
			require_once GIVE_PLUGIN_DIR . 'includes/gateways/paypal-standard.php';
			require_once GIVE_PLUGIN_DIR . 'includes/gateways/offline-donations.php';
			require_once GIVE_PLUGIN_DIR . 'includes/gateways/manual.php';

			require_once GIVE_PLUGIN_DIR . 'includes/emails/class-give-emails.php';
			require_once GIVE_PLUGIN_DIR . 'includes/emails/class-give-email-tags.php';
			require_once GIVE_PLUGIN_DIR . 'includes/admin/emails/class-email-notifications.php';
			require_once GIVE_PLUGIN_DIR . 'includes/emails/functions.php';
			require_once GIVE_PLUGIN_DIR . 'includes/emails/template.php';
			require_once GIVE_PLUGIN_DIR . 'includes/emails/actions.php';

			if ( defined( 'WP_CLI' ) && WP_CLI ) {
				require_once GIVE_PLUGIN_DIR . 'includes/class-give-cli-commands.php';
			}

			if ( is_admin() || ( defined( 'WP_CLI' ) && WP_CLI ) ) {

				require_once GIVE_PLUGIN_DIR . 'includes/admin/admin-footer.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/welcome.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/admin-pages.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/class-api-keys-table.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/class-i18n-module.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/admin-actions.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/admin-filters.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/system-info.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/add-ons.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/plugins.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/dashboard-widgets.php';

				require_once GIVE_PLUGIN_DIR . 'includes/admin/payments/actions.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/payments/payments-history.php';

				require_once GIVE_PLUGIN_DIR . 'includes/admin/donors/donors.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/donors/donor-functions.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/donors/donor-actions.php';

				require_once GIVE_PLUGIN_DIR . 'includes/admin/forms/metabox.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/forms/class-metabox-form-data.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/forms/dashboard-columns.php';

				require_once GIVE_PLUGIN_DIR . 'includes/admin/tools/export/export-functions.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/tools/export/class-export.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/tools/export/export-actions.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/tools/export/pdf-reports.php';

				require_once GIVE_PLUGIN_DIR . 'includes/admin/reporting/reports.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/reporting/class-give-graph.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/reporting/graphing.php';

				require_once GIVE_PLUGIN_DIR . 'includes/admin/tools/data/tools-actions.php';

				require_once GIVE_PLUGIN_DIR . 'includes/admin/shortcodes/abstract-shortcode-generator.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/shortcodes/class-shortcode-button.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/shortcodes/shortcode-give-form.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/shortcodes/shortcode-give-goal.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/shortcodes/shortcode-give-login.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/shortcodes/shortcode-give-register.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/shortcodes/shortcode-give-profile-editor.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/shortcodes/shortcode-give-donation-history.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/shortcodes/shortcode-give-receipt.php';

				require_once GIVE_PLUGIN_DIR . 'includes/admin/upgrades/upgrade-functions.php';
				require_once GIVE_PLUGIN_DIR . 'includes/admin/upgrades/upgrades.php';

			}// End if().


			require_once GIVE_PLUGIN_DIR . 'includes/install.php';

		}

		/**
		 * Loads the plugin language files.
		 *
		 * @since  1.0
		 * @access public
		 *
		 * @return void
		 */
		public function load_textdomain() {

			// Set filter for Give's languages directory
			$give_lang_dir = dirname( plugin_basename( GIVE_PLUGIN_FILE ) ) . '/languages/';
			$give_lang_dir = apply_filters( 'give_languages_directory', $give_lang_dir );

			// Traditional WordPress plugin locale filter.
			$locale = is_admin() && function_exists( 'get_user_locale' ) ? get_user_locale() : get_locale();
			$locale = apply_filters( 'plugin_locale', $locale, 'give' );

			unload_textdomain( 'give' );
			load_textdomain( 'give', WP_LANG_DIR . '/give/give-' . $locale . '.mo' );
			load_plugin_textdomain( 'give', false, $give_lang_dir );

		}

	}

endif; // End if class_exists check


/**
 * Start Give
 *
 * The main function responsible for returning the one true Give instance to functions everywhere.
 *
 * Use this function like you would a global variable, except without needing
 * to declare the global.
 *
 * Example: <?php $give = Give(); ?>
 *
 * @since 1.0
 * @return object|Give
 */
function Give() {
	return Give::instance();
}

Give();


Push — issues/1132 ( fe09c7...79489e )

Give::setup_constants() D

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-12-08 11:11 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 53 and the first side effect is on line 43. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2			/**
3			* Plugin Name: Give - Donation Plugin
4			* Plugin URI: https://givewp.com
5			* Description: The most robust, flexible, and intuitive way to accept donations on WordPress.
6			* Author: WordImpress
7			* Author URI: https://wordimpress.com
8			* Version: 2.0.0
9			* Text Domain: give
10			* Domain Path: /languages
11			* GitHub Plugin URI: https://github.com/WordImpress/Give
12			*
13			* Give is free software: you can redistribute it and/or modify
14			* it under the terms of the GNU General Public License as published by
15			* the Free Software Foundation, either version 3 of the License, or
16			* any later version.
17			*
18			* Give is distributed in the hope that it will be useful,
19			* but WITHOUT ANY WARRANTY; without even the implied warranty of
20			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21			* GNU General Public License for more details.
22			*
23			* You should have received a copy of the GNU General Public License
24			* along with Give. If not, see <https://www.gnu.org/licenses/>.
25			*
26			* A Tribute to Open Source:
27			*
28			* "Open source software is software that can be freely used, changed, and shared (in modified or unmodified form) by anyone. Open
29			* source software is made by many people, and distributed under licenses that comply with the Open Source Definition."
30			*
31			* -- The Open Source Initiative
32			*
33			* Give is a tribute to the spirit and philosophy of Open Source. We at WordImpress gladly embrace the Open Source philosophy both
34			* in how Give itself was developed, and how we hope to see others build more from our code base.
35			*
36			* Give would not have been possible without the tireless efforts of WordPress and the surrounding Open Source projects and their talented developers. Thank you all for your contribution to WordPress.
37			*
38			* - The WordImpress Team
39			*/
40
41			// Exit if accessed directly.
42			if ( ! defined( 'ABSPATH' ) ) {
43			exit;
44			}
45
46			if ( ! class_exists( 'Give' ) ) :
47
48			/**
49			* Main Give Class
50			*
51			* @since 1.0
52			*/
53			final class Give {
54
55			/ Singleton ***********************************************************/
56
57			/**
58			* Give Instance
59			*
60			* @since 1.0
61			* @access private
62			*
63			* @var Give() The one true Give
64			*/
65			protected static $_instance;
66
67			/**
68			* Give Roles Object
69			*
70			* @since 1.0
71			* @access public
72			*
73			* @var Give_Roles object
74			*/
75			public $roles;
76
77			/**
78			* Give Settings Object
79			*
80			* @since 1.0
81			* @access public
82			*
83			* @var Give_Plugin_Settings object
84			*/
85			public $give_settings;
86
87			/**
88			* Give Session Object
89			*
90			* This holds donation data for user's session.
91			*
92			* @since 1.0
93			* @access public
94			*
95			* @var Give_Session object
96			*/
97			public $session;
98
99			/**
100			* Give HTML Element Helper Object
101			*
102			* @since 1.0
103			* @access public
104			*
105			* @var Give_HTML_Elements object
106			*/
107			public $html;
108
109			/**
110			* Give Emails Object
111			*
112			* @since 1.0
113			* @access public
114			*
115			* @var Give_Emails object
116			*/
117			public $emails;
118
119			/**
120			* Give Email Template Tags Object
121			*
122			* @since 1.0
123			* @access public
124			*
125			* @var Give_Email_Template_Tags object
126			*/
127			public $email_tags;
128
129			/**
130			* Give Donors DB Object
131			*
132			* @since 1.0
133			* @access public
134			*
135			* @var Give_DB_Donors object
136			*/
137			public $donors;
138
139			/**
140			* Give Donor meta DB Object
141			*
142			* @since 1.6
143			* @access public
144			*
145			* @var Give_DB_Donor_Meta object
146			*/
147			public $donor_meta;
148
149			/**
150			* Give API Object
151			*
152			* @since 1.0
153			* @access public
154			*
155			* @var Give_API object
156			*/
157			public $api;
158
159			/**
160			* Give Template Loader Object
161			*
162			* @since 1.0
163			* @access public
164			*
165			* @var Give_Template_Loader object
166			*/
167			public $template_loader;
168
169			/**
170			* Give No Login Object
171			*
172			* @since 1.0
173			* @access public
174			*
175			* @var Give_Email_Access object
176			*/
177			public $email_access;
178
179			/**
180			* Give_tooltips Object
181			*
182			* @since 2.0
183			* @access public
184			*
185			* @var Give_Tooltips object
186			*/
187			public $tooltips;
188
189			/**
190			* Give notices Object
191			*
192			* @var Give_Notices $notices
193			*/
194			public $notices;
195
196			/**
197			* Main Give Instance
198			*
199			* Ensures that only one instance of Give exists in memory at any one
200			* time. Also prevents needing to define globals all over the place.
201			*
202			* @since 1.0
203			* @access public
204			*
205			* @static
206			* @see Give()
207			*
208			* @return Give
209			*/
210			public static function instance() {
211			if ( is_null( self::$_instance ) ) {
212			self::$_instance = new self();
213			}
214
215			return self::$_instance;
216			}
217
218			/**
219			* Give Constructor.
220			*/
221			public function __construct() {
222			$this->setup_constants();
223			$this->includes();
224			$this->init_hooks();
225
226			do_action( 'give_loaded' );
227			}
228
229			/**
230			* Hook into actions and filters.
231			*
232			* @since 1.8.9
233			*/
234			private function init_hooks() {
235			register_activation_hook( __FILE__, 'give_install' );
236			add_action( 'plugins_loaded', array( $this, 'init' ), 0 );
237			}
238
239			/**
240			* Init Give when WordPress Initializes.
241			*
242			* @since 1.8.9
243			*/
244			public function init() {
245
246			/**
247			* Fires before the Give core is initialized.
248			*
249			* @since 1.8.9
250			*/
251			do_action( 'before_give_init' );
252
253			// Set up localization.
254			$this->load_textdomain();
255
256			$this->roles = new Give_Roles();
257			$this->api = new Give_API();
258			$this->give_settings = new Give_Admin_Settings();
259			$this->session = new Give_Session();
260			$this->html = new Give_HTML_Elements();
261			$this->emails = new Give_Emails();
262			$this->email_tags = new Give_Email_Template_Tags();
263			$this->donors = new Give_DB_Donors();
264			$this->donor_meta = new Give_DB_Donor_Meta();
265			$this->template_loader = new Give_Template_Loader();
266			$this->email_access = new Give_Email_Access();
267			$this->tooltips = new Give_Tooltips();
268			$this->notices = new Give_Notices();
269
270			/**
271			* Fire the action after Give core loads.
272			*
273			* @param class Give class instance.
274			*
275			* @since 1.8.7
276			*/
277			do_action( 'give_init', $this );
278
279			}
280
281			/**
282			* Throw error on object clone
283			*
284			* The whole idea of the singleton design pattern is that there is a single
285			* object, therefore we don't want the object to be cloned.
286			*
287			* @since 1.0
288			* @access protected
289			*
290			* @return void
291			*/
292			public function __clone() {
293			// Cloning instances of the class is forbidden.
294			_doing_it_wrong( __FUNCTION__, __( 'Cheatin’ huh?', 'give' ), '1.0' );
295			}
296
297			/**
298			* Disable unserializing of the class
299			*
300			* @since 1.0
301			* @access protected
302			*
303			* @return void
304			*/
305			public function __wakeup() {
306			// Unserializing instances of the class is forbidden.
307			_doing_it_wrong( __FUNCTION__, __( 'Cheatin’ huh?', 'give' ), '1.0' );
308			}
309
310			/**
311			* Setup plugin constants
312			*
313			* @since 1.0
314			* @access private
315			*
316			* @return void
317			*/
318			private function setup_constants() {
319
320			// Plugin version
321			if ( ! defined( 'GIVE_VERSION' ) ) {
322			define( 'GIVE_VERSION', '2.0.0' );
323			}
324
325			// Plugin Folder Path
326			if ( ! defined( 'GIVE_PLUGIN_DIR' ) ) {
327			define( 'GIVE_PLUGIN_DIR', plugin_dir_path( __FILE__ ) );
328			}
329
330			// Plugin Folder URL
331			if ( ! defined( 'GIVE_PLUGIN_URL' ) ) {
332			define( 'GIVE_PLUGIN_URL', plugin_dir_url( __FILE__ ) );
333			}
334
335			// Plugin Basename aka: "give/give.php"
336			if ( ! defined( 'GIVE_PLUGIN_BASENAME' ) ) {
337			define( 'GIVE_PLUGIN_BASENAME', plugin_basename( __FILE__ ) );
338			}
339
340			// Plugin Root File
341			if ( ! defined( 'GIVE_PLUGIN_FILE' ) ) {
342			define( 'GIVE_PLUGIN_FILE', __FILE__ );
343			}
344
345			// Make sure CAL_GREGORIAN is defined
346			if ( ! defined( 'CAL_GREGORIAN' ) ) {
347			define( 'CAL_GREGORIAN', 1 );
348			}
349
350			// PHP version
351			if ( ! defined( 'GIVE_REQUIRED_PHP_VERSION' ) ) {
352			define( 'GIVE_REQUIRED_PHP_VERSION', '5.3' );
353			}
354			}
355
356			/**
357			* Include required files
358			*
359			* @since 1.0
360			* @access private
361			*
362			* @return void
363			*/
364			private function includes() {
365			global $give_options;
			0 ignored issues – show Compatibility Best Practice introduced 2016-12-08 11:11 UTC by Report Bug Copy Issue Report Use of `global` functionality is not recommended; it makes your code harder to test, and less reusable. Instead of relying on `global` state, we recommend one of these alternatives: 1. Pass all data via parameters function myFunction($a, $b) { // Do something } 2. Create a class that maintains your state class MyClass { private $a; private $b; public function __construct($a, $b) { $this->a = $a; $this->b = $b; } public function myFunction() { // Do something } } Loading history...
366
367			require_once GIVE_PLUGIN_DIR . 'includes/admin/class-admin-settings.php';
368			require_once GIVE_PLUGIN_DIR . 'includes/admin/class-give-settings.php';
369			$give_options = give_get_settings();
370
371			require_once GIVE_PLUGIN_DIR . 'includes/admin/give-metabox-functions.php';
372			require_once GIVE_PLUGIN_DIR . 'includes/class-give-cache.php';
373			require_once GIVE_PLUGIN_DIR . 'includes/post-types.php';
374			require_once GIVE_PLUGIN_DIR . 'includes/scripts.php';
375			require_once GIVE_PLUGIN_DIR . 'includes/ajax-functions.php';
376			require_once GIVE_PLUGIN_DIR . 'includes/actions.php';
377			require_once GIVE_PLUGIN_DIR . 'includes/filters.php';
378			require_once GIVE_PLUGIN_DIR . 'includes/api/class-give-api.php';
379			require_once GIVE_PLUGIN_DIR . 'includes/class-give-tooltips.php';
380			require_once GIVE_PLUGIN_DIR . 'includes/class-notices.php';
381
382			require_once GIVE_PLUGIN_DIR . 'includes/class-give-roles.php';
383			require_once GIVE_PLUGIN_DIR . 'includes/class-give-template-loader.php';
384			require_once GIVE_PLUGIN_DIR . 'includes/class-give-donate-form.php';
385			require_once GIVE_PLUGIN_DIR . 'includes/class-give-db.php';
386			require_once GIVE_PLUGIN_DIR . 'includes/class-give-db-donors.php';
387			require_once GIVE_PLUGIN_DIR . 'includes/class-give-db-donor-meta.php';
388			require_once GIVE_PLUGIN_DIR . 'includes/class-give-donor.php';
389			require_once GIVE_PLUGIN_DIR . 'includes/class-give-stats.php';
390			require_once GIVE_PLUGIN_DIR . 'includes/class-give-session.php';
391			require_once GIVE_PLUGIN_DIR . 'includes/class-give-html-elements.php';
392			require_once GIVE_PLUGIN_DIR . 'includes/class-give-logging.php';
393			require_once GIVE_PLUGIN_DIR . 'includes/class-give-license-handler.php';
394			require_once GIVE_PLUGIN_DIR . 'includes/class-give-cron.php';
395			require_once GIVE_PLUGIN_DIR . 'includes/class-give-email-access.php';
396
397			require_once GIVE_PLUGIN_DIR . 'includes/country-functions.php';
398			require_once GIVE_PLUGIN_DIR . 'includes/template-functions.php';
399			require_once GIVE_PLUGIN_DIR . 'includes/misc-functions.php';
400			require_once GIVE_PLUGIN_DIR . 'includes/forms/functions.php';
401			require_once GIVE_PLUGIN_DIR . 'includes/forms/template.php';
402			require_once GIVE_PLUGIN_DIR . 'includes/forms/widget.php';
403			require_once GIVE_PLUGIN_DIR . 'includes/shortcodes.php';
404			require_once GIVE_PLUGIN_DIR . 'includes/formatting.php';
405			require_once GIVE_PLUGIN_DIR . 'includes/price-functions.php';
406			require_once GIVE_PLUGIN_DIR . 'includes/error-tracking.php';
407			require_once GIVE_PLUGIN_DIR . 'includes/process-donation.php';
408			require_once GIVE_PLUGIN_DIR . 'includes/login-register.php';
409			require_once GIVE_PLUGIN_DIR . 'includes/user-functions.php';
410			require_once GIVE_PLUGIN_DIR . 'includes/plugin-compatibility.php';
411			require_once GIVE_PLUGIN_DIR . 'includes/deprecated/deprecated-classes.php';
412			require_once GIVE_PLUGIN_DIR . 'includes/deprecated/deprecated-functions.php';
413			require_once GIVE_PLUGIN_DIR . 'includes/deprecated/deprecated-actions.php';
414			require_once GIVE_PLUGIN_DIR . 'includes/deprecated/deprecated-filters.php';
415
416			require_once GIVE_PLUGIN_DIR . 'includes/payments/backward-compatibility.php';
417			require_once GIVE_PLUGIN_DIR . 'includes/payments/functions.php';
418			require_once GIVE_PLUGIN_DIR . 'includes/payments/actions.php';
419			require_once GIVE_PLUGIN_DIR . 'includes/payments/class-payment-stats.php';
420			require_once GIVE_PLUGIN_DIR . 'includes/payments/class-payments-query.php';
421			require_once GIVE_PLUGIN_DIR . 'includes/payments/class-give-payment.php';
422
423			require_once GIVE_PLUGIN_DIR . 'includes/gateways/functions.php';
424			require_once GIVE_PLUGIN_DIR . 'includes/gateways/actions.php';
425			require_once GIVE_PLUGIN_DIR . 'includes/gateways/paypal-standard.php';
426			require_once GIVE_PLUGIN_DIR . 'includes/gateways/offline-donations.php';
427			require_once GIVE_PLUGIN_DIR . 'includes/gateways/manual.php';
428
429			require_once GIVE_PLUGIN_DIR . 'includes/emails/class-give-emails.php';
430			require_once GIVE_PLUGIN_DIR . 'includes/emails/class-give-email-tags.php';
431			require_once GIVE_PLUGIN_DIR . 'includes/admin/emails/class-email-notifications.php';
432			require_once GIVE_PLUGIN_DIR . 'includes/emails/functions.php';
433			require_once GIVE_PLUGIN_DIR . 'includes/emails/template.php';
434			require_once GIVE_PLUGIN_DIR . 'includes/emails/actions.php';
435
436			if ( defined( 'WP_CLI' ) && WP_CLI ) {
437			require_once GIVE_PLUGIN_DIR . 'includes/class-give-cli-commands.php';
438			}
439
440			if ( is_admin() \|\| ( defined( 'WP_CLI' ) && WP_CLI ) ) {
441
442			require_once GIVE_PLUGIN_DIR . 'includes/admin/admin-footer.php';
443			require_once GIVE_PLUGIN_DIR . 'includes/admin/welcome.php';
444			require_once GIVE_PLUGIN_DIR . 'includes/admin/admin-pages.php';
445			require_once GIVE_PLUGIN_DIR . 'includes/admin/class-api-keys-table.php';
446			require_once GIVE_PLUGIN_DIR . 'includes/admin/class-i18n-module.php';
447			require_once GIVE_PLUGIN_DIR . 'includes/admin/admin-actions.php';
448			require_once GIVE_PLUGIN_DIR . 'includes/admin/admin-filters.php';
449			require_once GIVE_PLUGIN_DIR . 'includes/admin/system-info.php';
450			require_once GIVE_PLUGIN_DIR . 'includes/admin/add-ons.php';
451			require_once GIVE_PLUGIN_DIR . 'includes/admin/plugins.php';
452			require_once GIVE_PLUGIN_DIR . 'includes/admin/dashboard-widgets.php';
453
454			require_once GIVE_PLUGIN_DIR . 'includes/admin/payments/actions.php';
455			require_once GIVE_PLUGIN_DIR . 'includes/admin/payments/payments-history.php';
456
457			require_once GIVE_PLUGIN_DIR . 'includes/admin/donors/donors.php';
458			require_once GIVE_PLUGIN_DIR . 'includes/admin/donors/donor-functions.php';
459			require_once GIVE_PLUGIN_DIR . 'includes/admin/donors/donor-actions.php';
460
461			require_once GIVE_PLUGIN_DIR . 'includes/admin/forms/metabox.php';
462			require_once GIVE_PLUGIN_DIR . 'includes/admin/forms/class-metabox-form-data.php';
463			require_once GIVE_PLUGIN_DIR . 'includes/admin/forms/dashboard-columns.php';
464
465			require_once GIVE_PLUGIN_DIR . 'includes/admin/tools/export/export-functions.php';
466			require_once GIVE_PLUGIN_DIR . 'includes/admin/tools/export/class-export.php';
467			require_once GIVE_PLUGIN_DIR . 'includes/admin/tools/export/export-actions.php';
468			require_once GIVE_PLUGIN_DIR . 'includes/admin/tools/export/pdf-reports.php';
469
470			require_once GIVE_PLUGIN_DIR . 'includes/admin/reporting/reports.php';
471			require_once GIVE_PLUGIN_DIR . 'includes/admin/reporting/class-give-graph.php';
472			require_once GIVE_PLUGIN_DIR . 'includes/admin/reporting/graphing.php';
473
474			require_once GIVE_PLUGIN_DIR . 'includes/admin/tools/data/tools-actions.php';
475
476			require_once GIVE_PLUGIN_DIR . 'includes/admin/shortcodes/abstract-shortcode-generator.php';
477			require_once GIVE_PLUGIN_DIR . 'includes/admin/shortcodes/class-shortcode-button.php';
478			require_once GIVE_PLUGIN_DIR . 'includes/admin/shortcodes/shortcode-give-form.php';
479			require_once GIVE_PLUGIN_DIR . 'includes/admin/shortcodes/shortcode-give-goal.php';
480			require_once GIVE_PLUGIN_DIR . 'includes/admin/shortcodes/shortcode-give-login.php';
481			require_once GIVE_PLUGIN_DIR . 'includes/admin/shortcodes/shortcode-give-register.php';
482			require_once GIVE_PLUGIN_DIR . 'includes/admin/shortcodes/shortcode-give-profile-editor.php';
483			require_once GIVE_PLUGIN_DIR . 'includes/admin/shortcodes/shortcode-give-donation-history.php';
484			require_once GIVE_PLUGIN_DIR . 'includes/admin/shortcodes/shortcode-give-receipt.php';
485
486			require_once GIVE_PLUGIN_DIR . 'includes/admin/upgrades/upgrade-functions.php';
487			require_once GIVE_PLUGIN_DIR . 'includes/admin/upgrades/upgrades.php';
488
489			}// End if().
			0 ignored issues – show Unused Code Comprehensibility introduced 2017-06-19 03:57 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...
490
491			require_once GIVE_PLUGIN_DIR . 'includes/install.php';
492
493			}
494
495			/**
496			* Loads the plugin language files.
497			*
498			* @since 1.0
499			* @access public
500			*
501			* @return void
502			*/
503			public function load_textdomain() {
504
505			// Set filter for Give's languages directory
506			$give_lang_dir = dirname( plugin_basename( GIVE_PLUGIN_FILE ) ) . '/languages/';
507			$give_lang_dir = apply_filters( 'give_languages_directory', $give_lang_dir );
508
509			// Traditional WordPress plugin locale filter.
510			$locale = is_admin() && function_exists( 'get_user_locale' ) ? get_user_locale() : get_locale();
511			$locale = apply_filters( 'plugin_locale', $locale, 'give' );
512
513			unload_textdomain( 'give' );
514			load_textdomain( 'give', WP_LANG_DIR . '/give/give-' . $locale . '.mo' );
515			load_plugin_textdomain( 'give', false, $give_lang_dir );
516
517			}
518
519			}
520
521			endif; // End if class_exists check
522
523
524			/**
525			* Start Give
526			*
527			* The main function responsible for returning the one true Give instance to functions everywhere.
528			*
529			* Use this function like you would a global variable, except without needing
530			* to declare the global.
531			*
532			* Example: <?php $give = Give(); ?>
533			*
534			* @since 1.0
535			* @return object\|Give
536			*/
537			function Give() {
538			return Give::instance();
539			}
540
541			Give();
542

ravinderk / Give

Push — issues/1132 ( fe09c7...79489e )

Give::setup_constants() D

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like