FooGallery_Pro_Video_Legacy::foogallery_build_class_attribute() - Code Metrics - Inspection of "updated view" - fooplugins/foogallery - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/video-support ( 96814b )

by Brad

created 2018-06-22 10:58 UTC

foogallery_build_class_attribute() C

↳ Parent: FooGallery_Pro_Video_Legacy

Complexity

Conditions	13
Paths	22

Size

Total Lines	59
Code Lines	44

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	13
eloc	44
nc	22
nop	1
dl	0
loc	59
rs	6.4268
c	0
b	0
f	0

How to fix Long Method Complexity

<?php
/**
 * All Legacy FooVideo Code lives in this class
 * Date: 19/05/2018
 */
if ( ! class_exists( 'FooGallery_Pro_Video_Legacy' ) ) {

	class FooGallery_Pro_Video_Legacy {
namespace YourVendor;

class YourClass { }

		function __construct() {

			add_filter( 'foogallery_is_attachment_video', array( $this, 'foogallery_is_attachment_video_legacy' ), 10, 2 );

			add_filter( 'foogallery_clean_video_url', array( $this, 'foogallery_clean_video_url_legacy_filter' ) );
			add_filter( 'foogallery_youtubekey', array( $this, 'foogallery_youtubekey_legacy_filter' ) );

			//check if the old FooVideo is installed
			if ( is_admin() && class_exists('Foo_Video') ) {
				add_action( 'admin_notices', array( $this, 'display_foovideo_notice') );
				add_action( 'admin_menu',  array( $this, 'add_migration_menu' ) );
			}

			// Ajax calls for migrating
			add_action( 'wp_ajax_foogallery_video_migration', array( $this, 'ajax_foogallery_video_migration' ) );
			add_action( 'wp_ajax_foogallery_video_migration_reset', array( $this, 'ajax_foogallery_video_migration_reset' ) );
		}

		/**
		 * Legacy way of knowing if an attachment is a video
		 *
		 * @param $is_video
		 * @param $foogallery_attachment
		 *
		 * @return bool
		 */
		function foogallery_is_attachment_video_legacy( $is_video, $foogallery_attachment ) {

			$video_info = get_post_meta( $foogallery_attachment->ID, FOOGALLERY_VIDEO_POST_META, true );

			return isset( $video_info ) && isset( $video_info['id'] );
		}

		/**
		 * Applies the legacy filter for backwards compatibility
		 * @param $url
		 *
		 * @return string
		 */
		function foogallery_clean_video_url_legacy_filter( $url ) {

			return apply_filters( 'foogallery_foovideo_clean_video_url', $url );
		}

		public function foogallery_build_class_attribute( $classes ) {
			global $current_foogallery_template;

			//first determine if the gallery has any videos

			//get the selected video icon
			$video_hover_icon = foogallery_gallery_template_setting( 'video_hover_icon', 'fg-video-default' );

			//backwards compatible for the videoslider
			if ( 'videoslider' === $current_foogallery_template ) {
				switch ( $video_hover_icon ) {
					case 'video-icon-default':
						$video_hover_icon = 'rvs-flat-circle-play';
						break;
					case 'video-icon-1':
						$video_hover_icon = 'rvs-plain-arrow-play';
						break;
					case 'video-icon-2':
						$video_hover_icon = 'rvs-youtube-play';
						break;
					case 'video-icon-3':
						$video_hover_icon = 'rvs-bordered-circle-play';
						break;
					default:
						$video_hover_icon = '';
				}
			} else {
				switch ( $video_hover_icon ) {
					case 'video-icon-default':
						$video_hover_icon = 'fg-video-default';
						break;
					case 'video-icon-1':
						$video_hover_icon = 'fg-video-1';
						break;
					case 'video-icon-2':
						$video_hover_icon = 'fg-video-2';
						break;
					case 'video-icon-3':
						$video_hover_icon = 'fg-video-3';
						break;
					case 'video-icon-4':
						$video_hover_icon = 'fg-video-4';
						break;
					default:
						$video_hover_icon = '';
				}
			}

			//include the video icon class
			$classes[] = $video_hover_icon;
			//get the video icon sticky state
			$video_icon_sticky = foogallery_gallery_template_setting( 'foovideo_sticky_icon', '' );
			if ( 'videoslider' === $current_foogallery_template && '' === $video_icon_sticky ) {
				$video_icon_sticky = 'rvs-show-play-on-hover';
			}
			//include the video sticky class
			$classes[] = $video_icon_sticky;
			return $classes;
		}

		/**
		 * Display a message if the FooVideo extension is also installed
		 */
		function display_foovideo_notice() {

			?>
			<div class="notice error">
				<p>
					<strong><?php _e('FooVideo Extension Redundant!', 'foogallery'); ?></strong><br/>
					<?php _e('You have both FooGallery PRO and the legacy FooVideo extension activated. FooGallery PRO now includes all the video features that FooVideo had, plus more! Which means the FooVideo extension is now redundant.', 'foogallery'); ?>
					<br/>
					<?php _e('Your video galleries will continue to work, but we recommend you migrate them across to FooGallery PRO and then deactivate FooVideo.', 'foogallery'); ?>
					<br/>
					<br/>
					<a href="#" class="button button-primary button-large"><?php _e('Migrate Video Galleries', 'foogallery'); ?></a>
					<br/>
					<br/>
				</p>
			</div>
			<?php
		}

		/**
		 * Outputs the video migration view
		 */
		function render_video_migration_view() {

			require_once 'view-video-migration.php';
		}

		/**
		 * Add a new menu item for running the migration
		 */
		function add_migration_menu() {

			foogallery_add_submenu_page( __( 'Video Migration', 'foogallery' ), 'manage_options', 'foogallery-video-migration', array( $this, 'render_video_migration_view', ) );
		}

		function ajax_foogallery_video_migration() {

			if ( check_admin_referer( 'foogallery_video_migration' ) ) {
				$helper = new FooGallery_Pro_Video_Migration_Helper();
				$state = $helper->run_next_migration_step();
				header( 'Content-type: application/json' );
				echo json_encode( $state );
			}
			die();
		}

		function ajax_foogallery_video_migration_reset() {

			if ( check_admin_referer( 'foogallery_video_migration' ) ) {
				$helper = new FooGallery_Pro_Video_Migration_Helper();
				$state = $helper->reset_state();
				header( 'Content-type: application/json' );
				echo json_encode( $state );
			}
			die();
		}
	}
}

1			<?php
2			/**
3			* All Legacy FooVideo Code lives in this class
4			* Date: 19/05/2018
5			*/
6			if ( ! class_exists( 'FooGallery_Pro_Video_Legacy' ) ) {
7
8			class FooGallery_Pro_Video_Legacy {
			0 ignored issues – show Coding Style Compatibility introduced 2018-06-22 11:04 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 2018-06-22 11:04 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			add_filter( 'foogallery_is_attachment_video', array( $this, 'foogallery_is_attachment_video_legacy' ), 10, 2 );
12
13			add_filter( 'foogallery_clean_video_url', array( $this, 'foogallery_clean_video_url_legacy_filter' ) );
14			add_filter( 'foogallery_youtubekey', array( $this, 'foogallery_youtubekey_legacy_filter' ) );
15
16			//check if the old FooVideo is installed
17			if ( is_admin() && class_exists('Foo_Video') ) {
18			add_action( 'admin_notices', array( $this, 'display_foovideo_notice') );
19			add_action( 'admin_menu', array( $this, 'add_migration_menu' ) );
20			}
21
22			// Ajax calls for migrating
23			add_action( 'wp_ajax_foogallery_video_migration', array( $this, 'ajax_foogallery_video_migration' ) );
24			add_action( 'wp_ajax_foogallery_video_migration_reset', array( $this, 'ajax_foogallery_video_migration_reset' ) );
25			}
26
27			/**
28			* Legacy way of knowing if an attachment is a video
29			*
30			* @param $is_video
31			* @param $foogallery_attachment
32			*
33			* @return bool
34			*/
35			function foogallery_is_attachment_video_legacy( $is_video, $foogallery_attachment ) {
			0 ignored issues – show Best Practice introduced 2018-06-22 11:04 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...
36			$video_info = get_post_meta( $foogallery_attachment->ID, FOOGALLERY_VIDEO_POST_META, true );
37
38			return isset( $video_info ) && isset( $video_info['id'] );
39			}
40
41			/**
42			* Applies the legacy filter for backwards compatibility
43			* @param $url
44			*
45			* @return string
46			*/
47			function foogallery_clean_video_url_legacy_filter( $url ) {
			0 ignored issues – show Best Practice introduced 2018-06-22 11:04 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...
48			return apply_filters( 'foogallery_foovideo_clean_video_url', $url );
49			}
50
51			public function foogallery_build_class_attribute( $classes ) {
52			global $current_foogallery_template;
53
54			//first determine if the gallery has any videos
55
56			//get the selected video icon
57			$video_hover_icon = foogallery_gallery_template_setting( 'video_hover_icon', 'fg-video-default' );
58
59			//backwards compatible for the videoslider
60			if ( 'videoslider' === $current_foogallery_template ) {
61			switch ( $video_hover_icon ) {
62			case 'video-icon-default':
63			$video_hover_icon = 'rvs-flat-circle-play';
64			break;
65			case 'video-icon-1':
66			$video_hover_icon = 'rvs-plain-arrow-play';
67			break;
68			case 'video-icon-2':
69			$video_hover_icon = 'rvs-youtube-play';
70			break;
71			case 'video-icon-3':
72			$video_hover_icon = 'rvs-bordered-circle-play';
73			break;
74			default:
75			$video_hover_icon = '';
76			}
77			} else {
78			switch ( $video_hover_icon ) {
79			case 'video-icon-default':
80			$video_hover_icon = 'fg-video-default';
81			break;
82			case 'video-icon-1':
83			$video_hover_icon = 'fg-video-1';
84			break;
85			case 'video-icon-2':
86			$video_hover_icon = 'fg-video-2';
87			break;
88			case 'video-icon-3':
89			$video_hover_icon = 'fg-video-3';
90			break;
91			case 'video-icon-4':
92			$video_hover_icon = 'fg-video-4';
93			break;
94			default:
95			$video_hover_icon = '';
96			}
97			}
98
99			//include the video icon class
100			$classes[] = $video_hover_icon;
101			//get the video icon sticky state
102			$video_icon_sticky = foogallery_gallery_template_setting( 'foovideo_sticky_icon', '' );
103			if ( 'videoslider' === $current_foogallery_template && '' === $video_icon_sticky ) {
104			$video_icon_sticky = 'rvs-show-play-on-hover';
105			}
106			//include the video sticky class
107			$classes[] = $video_icon_sticky;
108			return $classes;
109			}
110
111			/**
112			* Display a message if the FooVideo extension is also installed
113			*/
114			function display_foovideo_notice() {
			0 ignored issues – show Best Practice introduced 2018-06-22 11:04 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...
115			?>
116			<div class="notice error">
117			<p>
118			<strong><?php _e('FooVideo Extension Redundant!', 'foogallery'); ?></strong><br/>
119			<?php _e('You have both FooGallery PRO and the legacy FooVideo extension activated. FooGallery PRO now includes all the video features that FooVideo had, plus more! Which means the FooVideo extension is now redundant.', 'foogallery'); ?>
120			<br/>
121			<?php _e('Your video galleries will continue to work, but we recommend you migrate them across to FooGallery PRO and then deactivate FooVideo.', 'foogallery'); ?>
122			<br/>
123			<br/>
124			<a href="#" class="button button-primary button-large"><?php _e('Migrate Video Galleries', 'foogallery'); ?></a>
125			<br/>
126			<br/>
127			</p>
128			</div>
129			<?php
130			}
131
132			/**
133			* Outputs the video migration view
134			*/
135			function render_video_migration_view() {
			0 ignored issues – show Best Practice introduced 2018-06-22 11:04 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...
136			require_once 'view-video-migration.php';
137			}
138
139			/**
140			* Add a new menu item for running the migration
141			*/
142			function add_migration_menu() {
			0 ignored issues – show Best Practice introduced 2018-06-22 11:04 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...
143			foogallery_add_submenu_page( __( 'Video Migration', 'foogallery' ), 'manage_options', 'foogallery-video-migration', array( $this, 'render_video_migration_view', ) );
144			}
145
146			function ajax_foogallery_video_migration() {
			0 ignored issues – show Best Practice introduced 2018-06-22 11:04 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...
147			if ( check_admin_referer( 'foogallery_video_migration' ) ) {
148			$helper = new FooGallery_Pro_Video_Migration_Helper();
149			$state = $helper->run_next_migration_step();
150			header( 'Content-type: application/json' );
151			echo json_encode( $state );
152			}
153			die();
154			}
155
156			function ajax_foogallery_video_migration_reset() {
			0 ignored issues – show Best Practice introduced 2018-06-22 11:04 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...
157			if ( check_admin_referer( 'foogallery_video_migration' ) ) {
158			$helper = new FooGallery_Pro_Video_Migration_Helper();
159			$state = $helper->reset_state();
160			header( 'Content-type: application/json' );
161			echo json_encode( $state );
162			}
163			die();
164			}
165			}
166			}

fooplugins / foogallery

GitHub Access Token became invalid

Push — feature/video-support ( 96814b )

foogallery_build_class_attribute() C

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like