FooGallery_Masonry_Gallery_Template::add_template() - Code Metrics - Inspection of "field updates to make gallery preview work" - fooplugins/foogallery - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/gallery-template-clien... ( d87348...a56405 )

by Brad

created 2017-08-10 17:23 UTC

FooGallery_Masonry_Gallery_Template::add_template() B

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	105
Code Lines	87

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	87
nc	1
nop	1
dl	0
loc	105
rs	8.2857
c	0
b	0
f	0

How to fix Long Method

<?php

if ( !class_exists( 'FooGallery_Masonry_Gallery_Template' ) ) {

	define('FOOGALLERY_MASONRY_GALLERY_TEMPLATE_URL', plugin_dir_url( __FILE__ ));

	class FooGallery_Masonry_Gallery_Template {
namespace YourVendor;

class YourClass { }
		/**
		 * Wire up everything we need to run the extension
		 */
		function __construct() {

			add_filter( 'foogallery_gallery_templates', array( $this, 'add_template' ) );
			add_filter( 'foogallery_gallery_templates_files', array( $this, 'register_myself' ) );
			add_filter( 'foogallery_located_template-masonry', array( $this, 'enqueue_dependencies' ) );

			add_filter( 'foogallery_template_thumbnail_dimensions-masonry', array( $this, 'get_thumbnail_dimensions' ), 10, 2 );

			//add extra fields to the templates
			add_filter( 'foogallery_override_gallery_template_fields-masonry', array( $this, 'add_common_thumbnail_fields' ), 10, 2 );
		}

		/**
		 * Register myself so that all associated JS and CSS files can be found and automatically included
		 * @param $extensions
		 *
		 * @return array
		 */
		function register_myself( $extensions ) {

			$extensions[] = __FILE__;
			return $extensions;
		}

		/**
		 * Add our gallery template to the list of templates available for every gallery
		 * @param $gallery_templates
		 *
		 * @return array
		 */
		function add_template( $gallery_templates ) {

			$gallery_templates[] = array(
                'slug'        => 'masonry',
                'name'        => __( 'Masonry Image Gallery', 'foogallery' ),
                'lazyload_support' => true,
                'admin_js'	  => FOOGALLERY_MASONRY_GALLERY_TEMPLATE_URL . 'js/admin-gallery-masonry.js',
                'fields'	  => array(
                    array(
                        'id'      => 'thumbnail_width',
                        'title'   => __( 'Thumb Width', 'foogallery' ),
                        'desc'    => __( 'Choose the width of your thumbnails. Thumbnails will be generated on the fly and cached once generated', 'foogallery' ),
                        'section' => __( 'General', 'foogallery' ),
                        'type'    => 'number',
                        'class'   => 'small-text',
                        'default' => 150,
                        'step'    => '1',
                        'min'     => '0',
                    ),
                    array(
                        'id'      => 'layout',
                        'title'   => __( 'Masonry Layout', 'foogallery' ),
                        'desc'    => __( 'Choose a fixed width thumb layout, or responsive columns.', 'foogallery' ),
                        'section' => __( 'General', 'foogallery' ),
                        'type'    => 'radio',
                        'choices' => array(
                            'fixed'  => __( 'Fixed Width', 'foogallery' ),
                            '2col'   => __( '2 Columns', 'foogallery' ),
                            '3col'   => __( '3 Columns', 'foogallery' ),
                            '4col'   => __( '4 Columns', 'foogallery' ),
                            '5col'   => __( '5 Columns', 'foogallery' )
                        ),
                        'default' => 'fixed',
                        'row_data'=> array(
                            'data-foogallery-change-selector' => 'input:radio',
                            'data-foogallery-value-selector' s=> 'input:checked'

                        )
                    ),
                    array(
                        'id'      => 'gutter_width',
                        'title'   => __( 'Gutter Width', 'foogallery' ),
                        'desc'    => __( 'The spacing between your thumbnails. Only applicable when using a fixed layout!', 'foogallery' ),
                        'section' => __( 'General', 'foogallery' ),
                        'type'    => 'number',
                        'class'   => 'small-text',
                        'default' => 10,
                        'step'    => '1',
                        'min'     => '0',
                        'row_data'=> array(
                            'data-foogallery-hidden' => true,
                            'data-foogallery-show-when-field' => 'layout',
                            'data-foogallery-show-when-field-value' => 'fixed'
                        )
                    ),
                    array(
                        'id'      => 'gutter_percent',
                        'title'   => __( 'Gutter Size', 'foogallery' ),
                        'desc'    => __( 'Choose a gutter size when using responsive columns.', 'foogallery' ),
                        'section' => __( 'General', 'foogallery' ),
                        'type'    => 'radio',
                        'choices' => array(
                            'no-gutter'   => __( 'No Gutter', 'foogallery' ),
                            ''  => __( 'Normal Size Gutter', 'foogallery' ),
                            'large-gutter'   => __( 'Larger Gutter', 'foogallery' )
                        ),
                        'default' => '',
                        'row_data'=> array(
                            'data-foogallery-hidden' => true,
                            'data-foogallery-show-when-field' => 'layout',
                            'data-foogallery-show-when-field-operator' => '!==',
                            'data-foogallery-show-when-field-value' => 'fixed'
                        )
                    ),
                    array(
                        'id'      => 'center_align',
                        'title'   => __( 'Alignment', 'foogallery' ),
                        'desc'    => __( 'You can choose to center align your images or leave them at the default (left). Only applicable when using a fixed layout!', 'foogallery' ),
                        'section' => __( 'Look &amp; Feel', 'foogallery' ),
						'type'    => 'radio',
						'spacer'  => '<span class="spacer"></span>',
                        'choices' => array(
                            'default'  => __( 'Left', 'foogallery' ),
                            'center'   => __( 'Center', 'foogallery' ),
                            'right'   => __( 'Right', 'foogallery' )
                        ),
                        'default' => 'default'
                    ),
                    array(
                        'id'      => 'thumbnail_link',
                        'title'   => __( 'Thumb Link', 'foogallery' ),
                        'default' => 'image' ,
                        'type'    => 'thumb_link',
                        'desc'	  => __( 'You can choose to link each thumbnail to the full size image, or to the image\'s attachment page, or you can choose to not link to anything', 'foogallery' ),
                    ),
                    array(
                        'id'      => 'lightbox',
                        'title'   => __( 'Lightbox', 'foogallery' ),
                        'desc'    => __( 'Choose which lightbox you want to display images with. The lightbox will only work if you set the thumbnail link to "Full Size Image"', 'foogallery' ),
                        'type'    => 'lightbox',
                    ),
                ),
			);


			return $gallery_templates;
		}

		/**
		 * Enqueue scripts that the masonry gallery template relies on
		 */
		function enqueue_dependencies() {

			wp_enqueue_script( 'jquery' );
			wp_enqueue_script( 'masonry' );

			//enqueue core files
			foogallery_enqueue_core_gallery_template_style();
			foogallery_enqueue_core_gallery_template_script();

			$css = FOOGALLERY_DEFAULT_TEMPLATES_EXTENSION_URL . 'masonry/css/foogallery.masonry.min.css';
			wp_enqueue_style( 'foogallery-masonry', $css, array( 'foogallery-core' ), FOOGALLERY_VERSION );

			$js = FOOGALLERY_DEFAULT_TEMPLATES_EXTENSION_URL . 'masonry/js/foogallery.masonry.min.js';
			wp_enqueue_script( 'foogallery-masonry', $js, array( 'foogallery-core' ), FOOGALLERY_VERSION );
		}

		/**
		 * Get the thumb dimensions arguments saved for the gallery for this gallery template
		 *
		 * @param array $dimensions
		 * @param FooGallery $foogallery
		 *
		 * @return mixed
		 */
		function get_thumbnail_dimensions( $dimensions, $foogallery ) {

			$width = $foogallery->get_meta( 'masonry_thumbnail_width', false );
			return array(
				'height' => 0,
				'width'  => intval( $width ),
				'crop'   => false
			);
		}

		/**
		 * Add thumbnail fields to the gallery template
		 *
		 * @uses "foogallery_override_gallery_template_fields"
		 * @param $fields
		 * @param $template
		 *
		 * @return array
		 */
		function add_common_thumbnail_fields( $fields, $template ) {

			return apply_filters( 'foogallery_gallery_template_common_thumbnail_fields', $fields );
		}
	}
}

1			<?php
2
3			if ( !class_exists( 'FooGallery_Masonry_Gallery_Template' ) ) {
4
5			define('FOOGALLERY_MASONRY_GALLERY_TEMPLATE_URL', plugin_dir_url( __FILE__ ));
6
7			class FooGallery_Masonry_Gallery_Template {
			0 ignored issues – show Coding Style Compatibility introduced 2016-03-01 17:41 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...
8			/**
9			* Wire up everything we need to run the extension
10			*/
11			function __construct() {
			0 ignored issues – show Best Practice introduced 2016-03-01 17:41 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...
12			add_filter( 'foogallery_gallery_templates', array( $this, 'add_template' ) );
13			add_filter( 'foogallery_gallery_templates_files', array( $this, 'register_myself' ) );
14			add_filter( 'foogallery_located_template-masonry', array( $this, 'enqueue_dependencies' ) );
15
16			add_filter( 'foogallery_template_thumbnail_dimensions-masonry', array( $this, 'get_thumbnail_dimensions' ), 10, 2 );
17
18			//add extra fields to the templates
19			add_filter( 'foogallery_override_gallery_template_fields-masonry', array( $this, 'add_common_thumbnail_fields' ), 10, 2 );
20			}
21
22			/**
23			* Register myself so that all associated JS and CSS files can be found and automatically included
24			* @param $extensions
25			*
26			* @return array
27			*/
28			function register_myself( $extensions ) {
			0 ignored issues – show Best Practice introduced 2016-03-01 17:41 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...
29			$extensions[] = __FILE__;
30			return $extensions;
31			}
32
33			/**
34			* Add our gallery template to the list of templates available for every gallery
35			* @param $gallery_templates
36			*
37			* @return array
38			*/
39			function add_template( $gallery_templates ) {
			0 ignored issues – show Best Practice introduced 2016-03-01 17:41 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...
40			$gallery_templates[] = array(
41			'slug' => 'masonry',
42			'name' => __( 'Masonry Image Gallery', 'foogallery' ),
43			'lazyload_support' => true,
44			'admin_js' => FOOGALLERY_MASONRY_GALLERY_TEMPLATE_URL . 'js/admin-gallery-masonry.js',
45			'fields' => array(
46			array(
47			'id' => 'thumbnail_width',
48			'title' => __( 'Thumb Width', 'foogallery' ),
49			'desc' => __( 'Choose the width of your thumbnails. Thumbnails will be generated on the fly and cached once generated', 'foogallery' ),
50			'section' => __( 'General', 'foogallery' ),
51			'type' => 'number',
52			'class' => 'small-text',
53			'default' => 150,
54			'step' => '1',
55			'min' => '0',
56			),
57			array(
58			'id' => 'layout',
59			'title' => __( 'Masonry Layout', 'foogallery' ),
60			'desc' => __( 'Choose a fixed width thumb layout, or responsive columns.', 'foogallery' ),
61			'section' => __( 'General', 'foogallery' ),
62			'type' => 'radio',
63			'choices' => array(
64			'fixed' => __( 'Fixed Width', 'foogallery' ),
65			'2col' => __( '2 Columns', 'foogallery' ),
66			'3col' => __( '3 Columns', 'foogallery' ),
67			'4col' => __( '4 Columns', 'foogallery' ),
68			'5col' => __( '5 Columns', 'foogallery' )
69			),
70			'default' => 'fixed',
71			'row_data'=> array(
72			'data-foogallery-change-selector' => 'input:radio',
73			'data-foogallery-value-selector' s=> 'input:checked'
			0 ignored issues – show Bug introduced 2017-08-10 17:26 UTC by Report Bug Copy Issue Report This code did not parse for me. Apparently, there is an error somewhere around this line: Syntax error, unexpected T_STRING, expecting ')' Loading history...
74			)
75			),
76			array(
77			'id' => 'gutter_width',
78			'title' => __( 'Gutter Width', 'foogallery' ),
79			'desc' => __( 'The spacing between your thumbnails. Only applicable when using a fixed layout!', 'foogallery' ),
80			'section' => __( 'General', 'foogallery' ),
81			'type' => 'number',
82			'class' => 'small-text',
83			'default' => 10,
84			'step' => '1',
85			'min' => '0',
86			'row_data'=> array(
87			'data-foogallery-hidden' => true,
88			'data-foogallery-show-when-field' => 'layout',
89			'data-foogallery-show-when-field-value' => 'fixed'
90			)
91			),
92			array(
93			'id' => 'gutter_percent',
94			'title' => __( 'Gutter Size', 'foogallery' ),
95			'desc' => __( 'Choose a gutter size when using responsive columns.', 'foogallery' ),
96			'section' => __( 'General', 'foogallery' ),
97			'type' => 'radio',
98			'choices' => array(
99			'no-gutter' => __( 'No Gutter', 'foogallery' ),
100			'' => __( 'Normal Size Gutter', 'foogallery' ),
101			'large-gutter' => __( 'Larger Gutter', 'foogallery' )
102			),
103			'default' => '',
104			'row_data'=> array(
105			'data-foogallery-hidden' => true,
106			'data-foogallery-show-when-field' => 'layout',
107			'data-foogallery-show-when-field-operator' => '!==',
108			'data-foogallery-show-when-field-value' => 'fixed'
109			)
110			),
111			array(
112			'id' => 'center_align',
113			'title' => __( 'Alignment', 'foogallery' ),
114			'desc' => __( 'You can choose to center align your images or leave them at the default (left). Only applicable when using a fixed layout!', 'foogallery' ),
115			'section' => __( 'Look & Feel', 'foogallery' ),
116			'type' => 'radio',
117			'spacer' => '<span class="spacer"></span>',
118			'choices' => array(
119			'default' => __( 'Left', 'foogallery' ),
120			'center' => __( 'Center', 'foogallery' ),
121			'right' => __( 'Right', 'foogallery' )
122			),
123			'default' => 'default'
124			),
125			array(
126			'id' => 'thumbnail_link',
127			'title' => __( 'Thumb Link', 'foogallery' ),
128			'default' => 'image' ,
129			'type' => 'thumb_link',
130			'desc' => __( 'You can choose to link each thumbnail to the full size image, or to the image\'s attachment page, or you can choose to not link to anything', 'foogallery' ),
131			),
132			array(
133			'id' => 'lightbox',
134			'title' => __( 'Lightbox', 'foogallery' ),
135			'desc' => __( 'Choose which lightbox you want to display images with. The lightbox will only work if you set the thumbnail link to "Full Size Image"', 'foogallery' ),
136			'type' => 'lightbox',
137			),
138			),
139			);
140
141
142			return $gallery_templates;
143			}
144
145			/**
146			* Enqueue scripts that the masonry gallery template relies on
147			*/
148			function enqueue_dependencies() {
			0 ignored issues – show Best Practice introduced 2016-03-01 17:41 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...
149			wp_enqueue_script( 'jquery' );
150			wp_enqueue_script( 'masonry' );
151
152			//enqueue core files
153			foogallery_enqueue_core_gallery_template_style();
154			foogallery_enqueue_core_gallery_template_script();
155
156			$css = FOOGALLERY_DEFAULT_TEMPLATES_EXTENSION_URL . 'masonry/css/foogallery.masonry.min.css';
157			wp_enqueue_style( 'foogallery-masonry', $css, array( 'foogallery-core' ), FOOGALLERY_VERSION );
158
159			$js = FOOGALLERY_DEFAULT_TEMPLATES_EXTENSION_URL . 'masonry/js/foogallery.masonry.min.js';
160			wp_enqueue_script( 'foogallery-masonry', $js, array( 'foogallery-core' ), FOOGALLERY_VERSION );
161			}
162
163			/**
164			* Get the thumb dimensions arguments saved for the gallery for this gallery template
165			*
166			* @param array $dimensions
167			* @param FooGallery $foogallery
168			*
169			* @return mixed
170			*/
171			function get_thumbnail_dimensions( $dimensions, $foogallery ) {
			0 ignored issues – show Best Practice introduced 2017-03-23 18:26 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...
172			$width = $foogallery->get_meta( 'masonry_thumbnail_width', false );
173			return array(
174			'height' => 0,
175			'width' => intval( $width ),
176			'crop' => false
177			);
178			}
179
180			/**
181			* Add thumbnail fields to the gallery template
182			*
183			* @uses "foogallery_override_gallery_template_fields"
184			* @param $fields
185			* @param $template
186			*
187			* @return array
188			*/
189			function add_common_thumbnail_fields( $fields, $template ) {
			0 ignored issues – show Best Practice introduced 2017-04-28 18:45 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...
190			return apply_filters( 'foogallery_gallery_template_common_thumbnail_fields', $fields );
191			}
192			}
193			}

fooplugins / foogallery

GitHub Access Token became invalid

Push — feature/gallery-template-clien... ( d87348...a56405 )

FooGallery_Masonry_Gallery_Template::add_template() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like