FooGallery_Cache::fetch_gallery_html_from_cache() - Code Metrics - Inspection of "updated readme files" - fooplugins/foogallery - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( d725c4...efa1d2 )

by Brad

created 2017-11-09 13:39 UTC

FooGallery_Cache::fetch_gallery_html_from_cache() B

↳ Parent: FooGallery_Cache

Complexity

Conditions	6
Paths	5

Size

Total Lines	29
Code Lines	15

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	6
eloc	15
nc	5
nop	3
dl	0
loc	29
rs	8.439
c	0
b	0
f	0

<?php
/**
 * Class used to cache gallery HTML output to save requests to the database
 * Date: 20/03/2017
 */
if ( ! class_exists( 'FooGallery_Cache' ) ) {

	class FooGallery_Cache {
namespace YourVendor;

class YourClass { }

		function __construct() {

			if ( is_admin() ) {
				//intercept the gallery save and save the html output to post meta
				add_action( 'foogallery_after_save_gallery', array( $this, 'cache_gallery_html_output_after_save' ), 10, 2 );

				//add some settings to allow the clearing and disabling of the cache
				add_filter( 'foogallery_admin_settings_override', array( $this, 'add_cache_settings' ) );

				//render the clear HTML cache button
				add_action( 'foogallery_admin_settings_custom_type_render_setting', array( $this, 'render_settings' ) );

				// Ajax call for clearing HTML cache
				add_action( 'wp_ajax_foogallery_clear_html_cache', array( $this, 'ajax_clear_all_caches' ) );

				add_action( 'foogallery_admin_new_version_detected', array( $this, 'clear_cache_on_update' ) );

				//clear the gallery caches when settings are updated or reset
				add_action( 'foogallery_settings_updated', array( $this, 'clear_all_gallery_caches' ) );
				add_action( 'foogallery_settings_reset', array( $this, 'clear_all_gallery_caches' ) );
			}

			add_filter( 'foogallery_load_gallery_template', array( $this, 'fetch_gallery_html_from_cache' ), 10, 3 );

			add_filter( 'foogallery_html_cache_disabled', array( $this, 'disable_html_cache' ), 10, 3 );
		}

		/**
		 * Override if the gallery html cache is disabled
		 *
		 * @param $disabled bool
		 * @param $gallery FooGallery
		 * @return bool
		 */
		function disable_html_cache( $disabled, $gallery ) {


			//check if the gallery sorting is random
			if ( 'rand' === $gallery->sorting ) {
				$disabled = true;
			}

			return $disabled;
		}

		/**
		 * Save the HTML output of the gallery after the gallery has been saved
		 *
		 * @param $post_id
		 * @param $form_post
		 */
		function cache_gallery_html_output_after_save( $post_id, $form_post ) {

			$this->cache_gallery_html_output( $post_id );
		}

		/**
		 * Save the HTML output of the gallery to post meta so that it can be used in future requests
		 *
		 * @param $foogallery_id
		 */
		function cache_gallery_html_output( $foogallery_id ) {

			$caching_enabled = $this->is_caching_enabled();

			//check if caching is disabled and quit early
			if ( !$caching_enabled ) {
				return;
			}

			//we need a way to force the gallery to render it's output every time it is saved
			global $foogallery_force_gallery_cache;
function myFunction($a, $b) {
    // Do something
}
			$foogallery_force_gallery_cache = true;

			//capture the html output
			ob_start();
			foogallery_render_gallery( $foogallery_id );
			$gallery_html = ob_get_contents();
			ob_end_clean();

			if ( $caching_enabled ) {
				//save the output to post meta for later use
				update_post_meta( $foogallery_id, FOOGALLERY_META_CACHE, $gallery_html );
			}

			$foogallery_force_gallery_cache = false;
		}

		function is_caching_enabled() {

            global $current_foogallery_arguments;

			//do some checks if we are using arguments
			if ( isset( $current_foogallery_arguments ) ) {

                //never cache if showing a preview
                if ( array_key_exists( 'preview', $current_foogallery_arguments ) &&
                    true === $current_foogallery_arguments['preview'] ) {
                    return false;
                }

                //never cache if we are passing in extra arguments via the shortcode
                $array_keys = array_keys( $current_foogallery_arguments );
			    if ( $array_keys != array( 'id', 'gallery' ) ) {
                    return false;
                }
            }

			//next, check the settings
			if ( 'on' === foogallery_get_setting( 'enable_html_cache' ) ) {
				return true;
			}

			return false;
		}

		/**
		 * Override the template output
		 *
		 * @param $override
		 * @param $gallery
		 * @param $template_location
		 *
		 * @return bool
		 */
		function fetch_gallery_html_from_cache( $override, $gallery, $template_location ) {

			global $foogallery_force_gallery_cache;
function myFunction($a, $b) {
    // Do something
}
			if ( $foogallery_force_gallery_cache ) {
				return false;
			}

			//check if caching is disabled and quit early
			if ( !$this->is_caching_enabled() ) {
				return false;
			}

			//allow extensions of others disable the html cache
			if ( apply_filters( 'foogallery_html_cache_disabled', false, $gallery ) ) {
				return false;
			}

			$gallery_cache = get_post_meta( $gallery->ID, FOOGALLERY_META_CACHE, true );

			if ( !empty( $gallery_cache ) && is_string( $gallery_cache ) ) {
				//output the cached gallery html
				echo $gallery_cache;
				return true; //return that we will override
			} else {
				//we should cache the result for next time
				$this->cache_gallery_html_output( $gallery->ID );
			}

			return false;
		}

		/**
		 * Add some caching settings
		 * @param $settings
		 *
		 * @return array
		 */
		function add_cache_settings( $settings ) {


			$cache_settings[] = array(
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
				'id'      => 'enable_html_cache',
				'title'   => __( 'Enable HTML Cache', 'foogallery' ),
				'desc'    => __( 'The gallery HTML that is generated can be cached. This can reduce the number of calls to the database when displaying a gallery and can increase site performance.', 'foogallery' ),
				'type'    => 'checkbox',
				'tab'     => 'general',
				'section' => __( 'Cache', 'foogallery' )
			);

			$cache_settings[] = array(
				'id'      => 'clear_html_cache',
				'title'   => __( 'Clear HTML Cache', 'foogallery' ),
				'desc'    => __( 'If you enable the HTML cache, then you can use this button to clear the gallery HTML that has been cached for all galleries.', 'foogallery' ),
				'type'    => 'clear_gallery_cache_button',
				'tab'     => 'general',
				'section' => __( 'Cache', 'foogallery' )
			);

			$new_settings = array_merge( $cache_settings, $settings['settings'] );

			$settings['settings'] = $new_settings;

			return $settings;
		}

		/**
		 * Render any custom setting types to the settings page
		 */
		function render_settings( $args ) {

			if ('clear_gallery_cache_button' === $args['type'] ) { ?>
				<div id="foogallery_clear_html_cache_container">
					<input type="button" data-nonce="<?php echo esc_attr( wp_create_nonce( 'foogallery_clear_html_cache' ) ); ?>" class="button-primary foogallery_clear_html_cache" value="<?php _e( 'Clear Gallery HTML Cache', 'foogallery' ); ?>">
					<span id="foogallery_clear_html_cache_spinner" style="position: absolute" class="spinner"></span>
				</div>
			<?php }
		}

		/**
		 * AJAX endpoint for clearing all gallery caches
		 */
		function ajax_clear_all_caches() {

			if ( check_admin_referer( 'foogallery_clear_html_cache' ) ) {

				$this->clear_all_gallery_caches();

				_e('The cache for all galleries has been cleared!', 'foogallery' );
				die();
			}
		}

		/**
		 * Clears all caches for all galleries
		 */
		function clear_all_gallery_caches() {

			delete_post_meta_by_key( FOOGALLERY_META_CACHE );
		}

		/**
		 * Clear all caches when the plugin has been updated. This is to account for changes in the HTML when a new version is released.
		 */
		function clear_cache_on_update() {

			$this->clear_all_gallery_caches();
		}
	}
}

GitHub Access Token became invalid

Push — develop ( d725c4...efa1d2 )

FooGallery_Cache::fetch_gallery_html_from_cache() B

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

1			<?php
2			/**
3			* Class used to cache gallery HTML output to save requests to the database
4			* Date: 20/03/2017
5			*/
6			if ( ! class_exists( 'FooGallery_Cache' ) ) {
7
8			class FooGallery_Cache {
			0 ignored issues – show Coding Style Compatibility introduced 2017-07-19 21:13 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
9
10			function __construct() {
			0 ignored issues – show Best Practice introduced 2017-03-21 17:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
11			if ( is_admin() ) {
12			//intercept the gallery save and save the html output to post meta
13			add_action( 'foogallery_after_save_gallery', array( $this, 'cache_gallery_html_output_after_save' ), 10, 2 );
14
15			//add some settings to allow the clearing and disabling of the cache
16			add_filter( 'foogallery_admin_settings_override', array( $this, 'add_cache_settings' ) );
17
18			//render the clear HTML cache button
19			add_action( 'foogallery_admin_settings_custom_type_render_setting', array( $this, 'render_settings' ) );
20
21			// Ajax call for clearing HTML cache
22			add_action( 'wp_ajax_foogallery_clear_html_cache', array( $this, 'ajax_clear_all_caches' ) );
23
24			add_action( 'foogallery_admin_new_version_detected', array( $this, 'clear_cache_on_update' ) );
25
26			//clear the gallery caches when settings are updated or reset
27			add_action( 'foogallery_settings_updated', array( $this, 'clear_all_gallery_caches' ) );
28			add_action( 'foogallery_settings_reset', array( $this, 'clear_all_gallery_caches' ) );
29			}
30
31			add_filter( 'foogallery_load_gallery_template', array( $this, 'fetch_gallery_html_from_cache' ), 10, 3 );
32
33			add_filter( 'foogallery_html_cache_disabled', array( $this, 'disable_html_cache' ), 10, 3 );
34			}
35
36			/**
37			* Override if the gallery html cache is disabled
38			*
39			* @param $disabled bool
40			* @param $gallery FooGallery
41			* @return bool
42			*/
43			function disable_html_cache( $disabled, $gallery ) {
			0 ignored issues – show Best Practice introduced 2017-07-04 19:23 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
44
45			//check if the gallery sorting is random
46			if ( 'rand' === $gallery->sorting ) {
47			$disabled = true;
48			}
49
50			return $disabled;
51			}
52
53			/**
54			* Save the HTML output of the gallery after the gallery has been saved
55			*
56			* @param $post_id
57			* @param $form_post
58			*/
59			function cache_gallery_html_output_after_save( $post_id, $form_post ) {
			0 ignored issues – show Unused Code introduced 2017-03-21 17:22 UTC by Report Bug Copy Issue Report The parameter `$form_post` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Best Practice introduced 2017-03-21 17:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
60			$this->cache_gallery_html_output( $post_id );
61			}
62
63			/**
64			* Save the HTML output of the gallery to post meta so that it can be used in future requests
65			*
66			* @param $foogallery_id
67			*/
68			function cache_gallery_html_output( $foogallery_id ) {
			0 ignored issues – show Best Practice introduced 2017-03-21 17:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
69			$caching_enabled = $this->is_caching_enabled();
70
71			//check if caching is disabled and quit early
72			if ( !$caching_enabled ) {
73			return;
74			}
75
76			//we need a way to force the gallery to render it's output every time it is saved
77			global $foogallery_force_gallery_cache;
			0 ignored issues – show Compatibility Best Practice introduced 2017-03-21 17:22 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...
78			$foogallery_force_gallery_cache = true;
79
80			//capture the html output
81			ob_start();
82			foogallery_render_gallery( $foogallery_id );
83			$gallery_html = ob_get_contents();
84			ob_end_clean();
85
86			if ( $caching_enabled ) {
87			//save the output to post meta for later use
88			update_post_meta( $foogallery_id, FOOGALLERY_META_CACHE, $gallery_html );
89			}
90
91			$foogallery_force_gallery_cache = false;
92			}
93
94			function is_caching_enabled() {
			0 ignored issues – show Best Practice introduced 2017-10-01 05:46 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
95			global $current_foogallery_arguments;
96
97			//do some checks if we are using arguments
98			if ( isset( $current_foogallery_arguments ) ) {
99
100			//never cache if showing a preview
101			if ( array_key_exists( 'preview', $current_foogallery_arguments ) &&
102			true === $current_foogallery_arguments['preview'] ) {
103			return false;
104			}
105
106			//never cache if we are passing in extra arguments via the shortcode
107			$array_keys = array_keys( $current_foogallery_arguments );
108			if ( $array_keys != array( 'id', 'gallery' ) ) {
109			return false;
110			}
111			}
112
113			//next, check the settings
114			if ( 'on' === foogallery_get_setting( 'enable_html_cache' ) ) {
115			return true;
116			}
117
118			return false;
119			}
120
121			/**
122			* Override the template output
123			*
124			* @param $override
125			* @param $gallery
126			* @param $template_location
127			*
128			* @return bool
129			*/
130			function fetch_gallery_html_from_cache( $override, $gallery, $template_location ) {
			0 ignored issues – show Unused Code introduced 2017-03-21 17:22 UTC by Report Bug Copy Issue Report The parameter `$template_location` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Best Practice introduced 2017-03-21 17:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
131			global $foogallery_force_gallery_cache;
			0 ignored issues – show Compatibility Best Practice introduced 2017-03-21 17:22 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...
132			if ( $foogallery_force_gallery_cache ) {
133			return false;
134			}
135
136			//check if caching is disabled and quit early
137			if ( !$this->is_caching_enabled() ) {
138			return false;
139			}
140
141			//allow extensions of others disable the html cache
142			if ( apply_filters( 'foogallery_html_cache_disabled', false, $gallery ) ) {
143			return false;
144			}
145
146			$gallery_cache = get_post_meta( $gallery->ID, FOOGALLERY_META_CACHE, true );
147
148			if ( !empty( $gallery_cache ) && is_string( $gallery_cache ) ) {
149			//output the cached gallery html
150			echo $gallery_cache;
151			return true; //return that we will override
152			} else {
153			//we should cache the result for next time
154			$this->cache_gallery_html_output( $gallery->ID );
155			}
156
157			return false;
158			}
159
160			/**
161			* Add some caching settings
162			* @param $settings
163			*
164			* @return array
165			*/
166			function add_cache_settings( $settings ) {
			0 ignored issues – show Best Practice introduced 2017-03-21 17:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
167
168			$cache_settings[] = array(
			0 ignored issues – show Coding Style Comprehensibility introduced 2017-03-21 17:22 UTC by Report Bug Copy Issue Report `$cache_settings` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$cache_settings = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
169			'id' => 'enable_html_cache',
170			'title' => __( 'Enable HTML Cache', 'foogallery' ),
171			'desc' => __( 'The gallery HTML that is generated can be cached. This can reduce the number of calls to the database when displaying a gallery and can increase site performance.', 'foogallery' ),
172			'type' => 'checkbox',
173			'tab' => 'general',
174			'section' => __( 'Cache', 'foogallery' )
175			);
176
177			$cache_settings[] = array(
178			'id' => 'clear_html_cache',
179			'title' => __( 'Clear HTML Cache', 'foogallery' ),
180			'desc' => __( 'If you enable the HTML cache, then you can use this button to clear the gallery HTML that has been cached for all galleries.', 'foogallery' ),
181			'type' => 'clear_gallery_cache_button',
182			'tab' => 'general',
183			'section' => __( 'Cache', 'foogallery' )
184			);
185
186			$new_settings = array_merge( $cache_settings, $settings['settings'] );
187
188			$settings['settings'] = $new_settings;
189
190			return $settings;
191			}
192
193			/**
194			* Render any custom setting types to the settings page
195			*/
196			function render_settings( $args ) {
			0 ignored issues – show Best Practice introduced 2017-03-21 17:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
197			if ('clear_gallery_cache_button' === $args['type'] ) { ?>
198			<div id="foogallery_clear_html_cache_container">
199			<input type="button" data-nonce="<?php echo esc_attr( wp_create_nonce( 'foogallery_clear_html_cache' ) ); ?>" class="button-primary foogallery_clear_html_cache" value="<?php _e( 'Clear Gallery HTML Cache', 'foogallery' ); ?>">
200			<span id="foogallery_clear_html_cache_spinner" style="position: absolute" class="spinner"></span>
201			</div>
202			<?php }
203			}
204
205			/**
206			* AJAX endpoint for clearing all gallery caches
207			*/
208			function ajax_clear_all_caches() {
			0 ignored issues – show Best Practice introduced 2017-03-21 17:22 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
209			if ( check_admin_referer( 'foogallery_clear_html_cache' ) ) {
210
211			$this->clear_all_gallery_caches();
212
213			_e('The cache for all galleries has been cleared!', 'foogallery' );
214			die();
215			}
216			}
217
218			/**
219			* Clears all caches for all galleries
220			*/
221			function clear_all_gallery_caches() {
			0 ignored issues – show Best Practice introduced 2017-05-05 09:13 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
222			delete_post_meta_by_key( FOOGALLERY_META_CACHE );
223			}
224
225			/**
226			* Clear all caches when the plugin has been updated. This is to account for changes in the HTML when a new version is released.
227			*/
228			function clear_cache_on_update() {
			0 ignored issues – show Best Practice introduced 2017-05-05 09:13 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history...
229			$this->clear_all_gallery_caches();
230			}
231			}
232			}

fooplugins / foogallery

GitHub Access Token became invalid

Push — develop ( d725c4...efa1d2 )

FooGallery_Cache::fetch_gallery_html_from_cache() B

Complexity

Size

Duplication

Importance

1. Pass all data via parameters

2. Create a class that maintains your state

1. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like