GravityView_Theme_Hooks_WPML - Code Metrics - Inspection of "Merge pull request #827 from gravityview/develop" - gravityview/GravityView - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 39734d...9bfb60 )

by Zack

created 2017-01-20 05:15 UTC

GravityView_Theme_Hooks_WPML A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	154
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Importance

Changes

Metric	Value
dl	0
loc	154
rs	10
c	0
b	0
f	0
wmc	12
lcom	0
cbo	3

5 Methods

Rating	Name	Size	Complexity
A	add_hooks()	8	1
A	filter_gravityview_back_link()	7	1
A	remove_url_hooks()	11	2
A	add_url_hooks()	11	2
B	wpml_ls_filter()	36	6

<?php

/**
 * Add WPML compatibility to GravityView, including registering scripts and styles to GravityView no-conflict list
 *
 * @file      class-gravityview-theme-hooks-wpml.php
 * @package   GravityView
 * @license   GPL2+
 * @author    Katz Web Services, Inc.
 * @link      http://gravityview.co
 * @copyright Copyright 2015, Katz Web Services, Inc.
 *
 * @since 1.19.2
 */

/**
 * @inheritDoc
 */
class GravityView_Theme_Hooks_WPML extends GravityView_Plugin_and_Theme_Hooks {

	/**
	 * @inheritDoc
	 * @since 1.19.2
	 */
	protected $script_handles = array(
		'wpml-cpi-scripts',
		'sitepress-scripts',
		'sitepress-post-edit',
		'sitepress-post-list-quickedit',
		'sitepress-languages',
		'sitepress-troubleshooting',
	);

	/**
	 * @inheritDoc
	 * @since 1.19.2
	 */
	protected $style_handles = array(
		'wpml-select-2',
		'wpml-tm-styles',
		'wpml-tm-queue',
		'wpml-dialog',
		'wpml-tm-editor-css',
	);

	/**
	 * @inheritDoc
	 * @since 1.19.2
	 */
	protected $constant_name = 'ICL_SITEPRESS_VERSION';

	/**
	 * Add filters for WPML links
	 *
	 * @since 1.19.4
	 */
	public function add_hooks() {

		parent::add_hooks();

		add_filter( 'icl_ls_languages', array( $this, 'wpml_ls_filter' ) );

		add_filter( 'gravityview_directory_link', array( $this, 'filter_gravityview_back_link') );

	}

	/**
	 * Add WPML filters to GravityView directory link
	 *
	 * This also modifies all the Edit Entry, Cancel Edit, Go Back links
	 *
	 * @since 1.19.4
	 *
	 * @see GravityView_API::directory_link
	 * @uses WPML_URL_Filters::permalink_filter
	 *
	 * @param string $link Permalink to the GravityView directory, without language params
	 *
	 * @return string $link, with language params added by WPML
	 */
	function filter_gravityview_back_link( $link ) {

		global $wpml_url_filters;
function myFunction($a, $b) {
    // Do something
}

		$link = $wpml_url_filters->permalink_filter( $link, GravityView_frontend::getInstance()->getPostId() );

		return $link;
	}

	/**
	 * Remove WPML permalink filters
	 *
	 * @since 1.19.4
	 *
	 * @return void
	 */
	private function remove_url_hooks() {
		global $wpml_url_filters;
function myFunction($a, $b) {
    // Do something
}

		$wpml_url_filters->remove_global_hooks();

		if ( $wpml_url_filters->frontend_uses_root() === true ) {

			remove_filter( 'page_link', array( $wpml_url_filters, 'page_link_filter_root' ), 1 );
		} else {
			remove_filter( 'page_link', array( $wpml_url_filters, 'page_link_filter' ), 1 );
		}
	}

	/**
	 * Add the WPML permalink filters back in
	 *
	 * @since 1.19.4
	 *
	 * @return void
	 */
	private function add_url_hooks() {
		global $wpml_url_filters;
function myFunction($a, $b) {
    // Do something
}

		$wpml_url_filters->add_global_hooks();

		if ( $wpml_url_filters->frontend_uses_root() === true ) {

			add_filter( 'page_link', array( $wpml_url_filters, 'page_link_filter_root' ), 1, 2 );
		} else {
			add_filter( 'page_link', array( $wpml_url_filters, 'page_link_filter' ), 1, 2 );
		}
	}

	/**
	 * Modify the language links to fix /entry/ var from being stripped
	 *
	 * @since 1.19.4
	 *
	 * @param array $languages Array of active languages with their details
	 *
	 * @return array If currently a single entry screen, re-generate URL after removing WPML filters
	 */
	public function wpml_ls_filter( $languages ) {
		global $sitepress, $post;
function myFunction($a, $b) {
    // Do something
}

		if ( $entry_slug = GravityView_frontend::getInstance()->getSingleEntry() ) {

			$trid         = $sitepress->get_element_trid( $post->ID );
			$translations = $sitepress->get_element_translations( $trid );

			$this->remove_url_hooks();

			if( $translations ) {
				foreach ( $languages as $lang_code => $language ) {

					$lang_post_id = $translations[ $lang_code ]->element_id;

					$entry_link = GravityView_API::entry_link( $entry_slug, $lang_post_id );

					if ( ! empty( $translations[ $lang_code ]->original ) ) {

						// The original doesn't need a language parameter
						$languages[ $lang_code ]['url'] = remove_query_arg( 'lang', $entry_link );

					} elseif ( $entry_link ) {

						// Every other language does
						$languages[ $lang_code ]['url'] = add_query_arg( array( 'lang' => $lang_code ), $entry_link );

					}
				}
			}

			$this->add_url_hooks();
		}

		return $languages;
	}

}

new GravityView_Theme_Hooks_WPML;

1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-12-02 23:33 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 18 and the first side effect is on line 173. 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			* Add WPML compatibility to GravityView, including registering scripts and styles to GravityView no-conflict list
4			*
5			* @file class-gravityview-theme-hooks-wpml.php
6			* @package GravityView
7			* @license GPL2+
8			* @author Katz Web Services, Inc.
9			* @link http://gravityview.co
10			* @copyright Copyright 2015, Katz Web Services, Inc.
11			*
12			* @since 1.19.2
13			*/
14
15			/**
16			* @inheritDoc
17			*/
18			class GravityView_Theme_Hooks_WPML extends GravityView_Plugin_and_Theme_Hooks {
19
20			/**
21			* @inheritDoc
22			* @since 1.19.2
23			*/
24			protected $script_handles = array(
25			'wpml-cpi-scripts',
26			'sitepress-scripts',
27			'sitepress-post-edit',
28			'sitepress-post-list-quickedit',
29			'sitepress-languages',
30			'sitepress-troubleshooting',
31			);
32
33			/**
34			* @inheritDoc
35			* @since 1.19.2
36			*/
37			protected $style_handles = array(
38			'wpml-select-2',
39			'wpml-tm-styles',
40			'wpml-tm-queue',
41			'wpml-dialog',
42			'wpml-tm-editor-css',
43			);
44
45			/**
46			* @inheritDoc
47			* @since 1.19.2
48			*/
49			protected $constant_name = 'ICL_SITEPRESS_VERSION';
50
51			/**
52			* Add filters for WPML links
53			*
54			* @since 1.19.4
55			*/
56			public function add_hooks() {
57
58			parent::add_hooks();
59
60			add_filter( 'icl_ls_languages', array( $this, 'wpml_ls_filter' ) );
61
62			add_filter( 'gravityview_directory_link', array( $this, 'filter_gravityview_back_link') );
			0 ignored issues – show introduced 2017-01-14 01:35 UTC by Report Bug Copy Issue Report No space before closing parenthesis of array is bad style Loading history...
63			}
64
65			/**
66			* Add WPML filters to GravityView directory link
67			*
68			* This also modifies all the Edit Entry, Cancel Edit, Go Back links
69			*
70			* @since 1.19.4
71			*
72			* @see GravityView_API::directory_link
73			* @uses WPML_URL_Filters::permalink_filter
74			*
75			* @param string $link Permalink to the GravityView directory, without language params
76			*
77			* @return string $link, with language params added by WPML
78			*/
79			function filter_gravityview_back_link( $link ) {
			0 ignored issues – show Best Practice introduced 2017-01-14 01:35 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...
80			global $wpml_url_filters;
			0 ignored issues – show Compatibility Best Practice introduced 2017-01-14 01:35 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...
81
82			$link = $wpml_url_filters->permalink_filter( $link, GravityView_frontend::getInstance()->getPostId() );
83
84			return $link;
85			}
86
87			/**
88			* Remove WPML permalink filters
89			*
90			* @since 1.19.4
91			*
92			* @return void
93			*/
94			private function remove_url_hooks() {
95			global $wpml_url_filters;
			0 ignored issues – show Compatibility Best Practice introduced 2017-01-14 01:35 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...
96
97			$wpml_url_filters->remove_global_hooks();
98
99			if ( $wpml_url_filters->frontend_uses_root() === true ) {
			0 ignored issues – show introduced 2017-01-14 01:35 UTC by Report Bug Copy Issue Report Found "=== true". Use Yoda Condition checks, you must Loading history...
100			remove_filter( 'page_link', array( $wpml_url_filters, 'page_link_filter_root' ), 1 );
101			} else {
102			remove_filter( 'page_link', array( $wpml_url_filters, 'page_link_filter' ), 1 );
103			}
104			}
105
106			/**
107			* Add the WPML permalink filters back in
108			*
109			* @since 1.19.4
110			*
111			* @return void
112			*/
113			private function add_url_hooks() {
114			global $wpml_url_filters;
			0 ignored issues – show Compatibility Best Practice introduced 2017-01-14 01:35 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...
115
116			$wpml_url_filters->add_global_hooks();
117
118			if ( $wpml_url_filters->frontend_uses_root() === true ) {
			0 ignored issues – show introduced 2017-01-14 01:35 UTC by Report Bug Copy Issue Report Found "=== true". Use Yoda Condition checks, you must Loading history...
119			add_filter( 'page_link', array( $wpml_url_filters, 'page_link_filter_root' ), 1, 2 );
120			} else {
121			add_filter( 'page_link', array( $wpml_url_filters, 'page_link_filter' ), 1, 2 );
122			}
123			}
124
125			/**
126			* Modify the language links to fix /entry/ var from being stripped
127			*
128			* @since 1.19.4
129			*
130			* @param array $languages Array of active languages with their details
131			*
132			* @return array If currently a single entry screen, re-generate URL after removing WPML filters
133			*/
134			public function wpml_ls_filter( $languages ) {
135			global $sitepress, $post;
			0 ignored issues – show Compatibility Best Practice introduced 2017-01-14 01:35 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...
136
137			if ( $entry_slug = GravityView_frontend::getInstance()->getSingleEntry() ) {
138
139			$trid = $sitepress->get_element_trid( $post->ID );
140			$translations = $sitepress->get_element_translations( $trid );
141
142			$this->remove_url_hooks();
143
144			if( $translations ) {
145			foreach ( $languages as $lang_code => $language ) {
146
147			$lang_post_id = $translations[ $lang_code ]->element_id;
148
149			$entry_link = GravityView_API::entry_link( $entry_slug, $lang_post_id );
150
151			if ( ! empty( $translations[ $lang_code ]->original ) ) {
152
153			// The original doesn't need a language parameter
154			$languages[ $lang_code ]['url'] = remove_query_arg( 'lang', $entry_link );
155
156			} elseif ( $entry_link ) {
157
158			// Every other language does
159			$languages[ $lang_code ]['url'] = add_query_arg( array( 'lang' => $lang_code ), $entry_link );
160
161			}
162			}
163			}
164
165			$this->add_url_hooks();
166			}
167
168			return $languages;
169			}
170
171			}
172
173			new GravityView_Theme_Hooks_WPML;

gravityview / GravityView

Push — master ( 39734d...9bfb60 )

GravityView_Theme_Hooks_WPML A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

5 Methods

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. 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