GravityView_Admin_Bar::remove_links() - Code Metrics - Inspection of "Version 1.17" - gravityview/GravityView - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#716)

by Zack

created 2016-06-15 02:14 UTC

GravityView_Admin_Bar::remove_links() A

↳ Parent: GravityView_Admin_Bar

Complexity

Conditions	3
Paths	2

Size

Total Lines	7
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	3
eloc	3
c	2
b	0
f	0
nc	2
nop	0
dl	0
loc	7
rs	9.4285

<?php


/**
 * Handle management of the Admin Bar links
 *
 * @since 1.13
 */
class GravityView_Admin_Bar {

	/**
	 * @var GravityView_frontend|null
	 */
	var $gravityview_view = null;
class A {
    var $property;
}

	function __construct() {


		$this->gravityview_view = GravityView_frontend::getInstance();

		$this->add_hooks();
	}

	/**
	 * @since 1.13
	 */
	private function add_hooks() {
		add_action( 'add_admin_bar_menus', array( $this, 'remove_links' ), 80 );
		add_action( 'admin_bar_menu', array( $this, 'add_links' ), 85 );
		add_action( 'wp_after_admin_bar_render', array( $this, 'add_floaty_icon' ) );
	}

	/**
	 * Add helpful GV links to the menu bar, like Edit Entry on single entry page.
	 *
	 * @since 1.13
	 * @return void
	 */
	function add_links() {

		/** @var WP_Admin_Bar $wp_admin_bar */
		global $wp_admin_bar;
function myFunction($a, $b) {
    // Do something
}

		if( is_admin() ) {
			return;
		}

		$view_data = GravityView_View_Data::getInstance()->get_views();

		if( empty( $view_data ) ) {
			return;
		}

		$wp_admin_bar->add_menu( array(
			'id' => 'gravityview',
			'title' => __( 'GravityView', 'gravityview' ),
			'href' => '#',
		) );

		$this->add_edit_view_and_form_link();

		$this->add_edit_entry_link();

	}

	/**
	 * Add the Floaty icon to the toolbar without loading the whole icon font
	 *
	 * @since 1.17
	 *
	 * @return void
	 */
	public function add_floaty_icon() {
		?>
		<style>
			#wp-admin-bar-gravityview > .ab-item:before {
				content: '';
				<?php // Base64-encode so that it works in Firefox as well, even though https://css-tricks.com/probably-dont-base64-svg/ ?>
				background: url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='20.4 27.05 20 21'%3E%3Cpath fill='none' d='M25.8 6.7c0 .7.1 1.3.4 1.9-.1-.3-.1-.6-.1-1 0-3.1 3.3-6.6 7.8-5.2-.9-.5-1.8-.8-2.9-.8-2.9-.1-5.2 2.2-5.2 5.1z'/%3E%3Cpath fill='%23F0F5FA' d='M36.23 33.77c-1.45-1.48-3.37-2.3-5.44-2.43V30.3c.6-.13 1.1-.7 1.1-1.44 0-.83-.7-1.5-1.5-1.5s-1.5.66-1.5 1.5c0 .7.43 1.3 1.1 1.48v1.03c-2.07.08-4 .92-5.47 2.37-1.57 1.5-2.43 3.57-2.43 5.75 0 .1 0 .3.04.6 0 .1.05.3.07.5.1.6.25 1.1.44 1.7l.2.5c.03.1.06.2.12.3l.2.4c.37.63.8 1.22 1.3 1.72 1.55 1.55 3.6 2.4 5.8 2.4h.1c2.15 0 4.2-.85 5.7-2.36.55-.53 1-1.1 1.36-1.7.1-.16.17-.3.23-.47l.14-.3.2-.5c.2-.57.33-1.15.42-1.74l.08-.5c.04-.2.04-.4.04-.6.02-2.16-.8-4.23-2.38-5.8zM29.2 29.2c0 .08 0 .16.03.28-.06-.17-.1-.34-.1-.53 0-.8.63-1.43 1.44-1.43.3 0 .58.1.8.25-1.25-.4-2.17.56-2.17 1.43zm1.26 2.8c3.6.04 6.6 2.58 7.3 5.98-.94-2.03-3.84-3.5-7.33-3.54-3.46 0-6.4 1.45-7.36 3.46.75-3.38 3.76-5.9 7.4-5.9zM29 43.66c-3.06-.42-5.35-2.18-5.35-4.27 0-2.4 3.04-4.4 6.78-4.3h1.03c-2.18 2.1-2.6 5.4-2.45 8.5zm8.32-1.18c-1.3 2.65-3.96 4.33-6.9 4.33-2.92 0-5.6-1.6-6.9-4.3-.3-.6-.45-1.2-.54-1.9.84 2.16 3.82 3.75 7.42 3.78 3.6 0 6.6-1.57 7.45-3.7-.1.68-.28 1.3-.53 1.88z' opacity='.6'/%3E%3C/svg%3E") 50% 50% no-repeat !important;
				top: 2px;
				width: 20px;
				height: 20px;
				display: inline-block;
			}
		</style>
		<?php
	}

	/**
	 * Add Edit Entry links when on a single entry
	 *
	 * @since 1.13
	 * @return void
	 */
	function add_edit_entry_link() {

		/** @var WP_Admin_Bar $wp_admin_bar */
		global $wp_admin_bar;
function myFunction($a, $b) {
    // Do something
}

		$entry_id = $this->gravityview_view->getSingleEntry();

		if ( $entry_id && GVCommon::has_cap( array( 'gravityforms_edit_entries', 'gravityview_edit_entries' ), $entry_id ) ) {

			$entry = $this->gravityview_view->getEntry();

			$wp_admin_bar->add_menu( array(
				'id' => 'edit-entry',
				'parent' => 'gravityview',
				'title' => __( 'Edit Entry', 'gravityview' ),
				'meta' => array(
					'title' => sprintf( __( 'Edit Entry %s', 'gravityview' ), GravityView_API::get_entry_slug( $entry['id'], $entry ) ),
				),
				'href' => esc_url_raw( admin_url( sprintf( 'admin.php?page=gf_entries&amp;screen_mode=edit&amp;view=entry&amp;id=%d&lid=%d', $entry['form_id'], $entry['id'] ) ) ),
			) );

		}
	}

	/**
	 * Add Edit View link when in embedded View
	 *
	 * @since 1.13
	 * @return void
	 */
	function add_edit_view_and_form_link() {

		/** @var WP_Admin_Bar $wp_admin_bar */
		global $wp_admin_bar;
function myFunction($a, $b) {
    // Do something
}

		if( GVCommon::has_cap( array( 'edit_gravityviews', 'edit_gravityview', 'gravityforms_edit_forms' ) ) ) {

			$view_data = GravityView_View_Data::getInstance();

			$views = $view_data->get_views();

			// If there is a View embed, show Edit View link.
			if ( ! empty( $views ) ) {

				$added_forms = array();
				$added_views = array();

				foreach ( $views as $view ) {

					$edit_view_title = __( 'Edit View', 'gravityview' );
					$edit_form_title = __( 'Edit Form', 'gravityview' );

					if( sizeof( $views ) > 1 ) {
						$edit_view_title = sprintf( _x( 'Edit View #%d', 'Edit View with the ID of %d', 'gravityview' ), $view['id'] );
						$edit_form_title = sprintf( __( 'Edit Form #%d', 'Edit Form with the ID of %d', 'gravityview' ), $view['form_id'] );
					}

					if( GVCommon::has_cap( 'edit_gravityview', $view['id'] ) && ! in_array( $view['id'], $added_views ) ) {

						$added_views[] = $view['id'];

						$wp_admin_bar->add_menu( array(
							'id'    => 'edit-view-' . $view['id'],
							'parent' => 'gravityview',
							'title' => $edit_view_title,
							'href'  => esc_url_raw( admin_url( sprintf( 'post.php?post=%d&action=edit', $view['id'] ) ) ),
						) );
					}

					if ( ! empty( $view['form_id'] ) && GVCommon::has_cap( array( 'gravityforms_edit_forms' ), $view['form_id'] ) && ! in_array( $view['form_id'], $added_forms )  ) {

						$added_forms[] = $view['form_id'];

						$wp_admin_bar->add_menu( array(
							'id'    => 'edit-form-' . $view['form_id'],
							'parent' => 'gravityview',
							'title' => $edit_form_title,
							'href' => esc_url_raw( admin_url( sprintf( 'admin.php?page=gf_edit_forms&id=%d', $view['form_id'] ) ) ),
						) );
					}
				}
			}
		}
	}

	/**
	 * Remove "Edit Page" or "Edit View" links when on single entry.
	 *
	 * @since 1.17 Also remove when on GravityView post type; the new GravityView menu will be the one-stop shop.
	 * @since 1.13
	 *
	 * @return void
	 */
	function remove_links() {


		// If we're on the single entry page, we don't want to cause confusion.
		if ( $this->gravityview_view->getSingleEntry() || $this->gravityview_view->isGravityviewPostType() ) {
			remove_action( 'admin_bar_menu', 'wp_admin_bar_edit_menu', 80 );
		}
	}
}

new GravityView_Admin_Bar;

Pull Request — master (#716)

GravityView_Admin_Bar::remove_links() A

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. Pass all data via parameters

2. Create a class that maintains your state

1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-02-09 18:31 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 8 and the first side effect is on line 192. 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			/**
4			* Handle management of the Admin Bar links
5			*
6			* @since 1.13
7			*/
8			class GravityView_Admin_Bar {
9
10			/**
11			* @var GravityView_frontend\|null
12			*/
13			var $gravityview_view = null;
			0 ignored issues – show Coding Style introduced 2016-01-18 22:19 UTC by Report Bug Copy Issue Report The visibility should be declared for property `$gravityview_view`. The PSR-2 coding standard requires that all properties in a class have their visibility explicitly declared. If you declare a property using class A { var $property; } the property is implicitly global. To learn more about the PSR-2, please see the PHP-FIG site on the PSR-2. Loading history...
14
15			function __construct() {
			0 ignored issues – show Best Practice introduced 2015-12-04 01:01 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...
16
17			$this->gravityview_view = GravityView_frontend::getInstance();
18
19			$this->add_hooks();
20			}
21
22			/**
23			* @since 1.13
24			*/
25			private function add_hooks() {
26			add_action( 'add_admin_bar_menus', array( $this, 'remove_links' ), 80 );
27			add_action( 'admin_bar_menu', array( $this, 'add_links' ), 85 );
28			add_action( 'wp_after_admin_bar_render', array( $this, 'add_floaty_icon' ) );
29			}
30
31			/**
32			* Add helpful GV links to the menu bar, like Edit Entry on single entry page.
33			*
34			* @since 1.13
35			* @return void
36			*/
37			function add_links() {
			0 ignored issues – show Best Practice introduced 2015-12-04 01:01 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...
38			/** @var WP_Admin_Bar $wp_admin_bar */
39			global $wp_admin_bar;
			0 ignored issues – show Compatibility Best Practice introduced 2016-01-18 22:19 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...
40
41			if( is_admin() ) {
42			return;
43			}
44
45			$view_data = GravityView_View_Data::getInstance()->get_views();
46
47			if( empty( $view_data ) ) {
48			return;
49			}
50
51			$wp_admin_bar->add_menu( array(
52			'id' => 'gravityview',
53			'title' => __( 'GravityView', 'gravityview' ),
54			'href' => '#',
55			) );
56
57			$this->add_edit_view_and_form_link();
58
59			$this->add_edit_entry_link();
60
61			}
62
63			/**
64			* Add the Floaty icon to the toolbar without loading the whole icon font
65			*
66			* @since 1.17
67			*
68			* @return void
69			*/
70			public function add_floaty_icon() {
71			?>
72			<style>
73			#wp-admin-bar-gravityview > .ab-item:before {
74			content: '';
75			<?php // Base64-encode so that it works in Firefox as well, even though https://css-tricks.com/probably-dont-base64-svg/ ?>
76			background: url("data:image/svg+xml;charset=utf8,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='20.4 27.05 20 21'%3E%3Cpath fill='none' d='M25.8 6.7c0 .7.1 1.3.4 1.9-.1-.3-.1-.6-.1-1 0-3.1 3.3-6.6 7.8-5.2-.9-.5-1.8-.8-2.9-.8-2.9-.1-5.2 2.2-5.2 5.1z'/%3E%3Cpath fill='%23F0F5FA' d='M36.23 33.77c-1.45-1.48-3.37-2.3-5.44-2.43V30.3c.6-.13 1.1-.7 1.1-1.44 0-.83-.7-1.5-1.5-1.5s-1.5.66-1.5 1.5c0 .7.43 1.3 1.1 1.48v1.03c-2.07.08-4 .92-5.47 2.37-1.57 1.5-2.43 3.57-2.43 5.75 0 .1 0 .3.04.6 0 .1.05.3.07.5.1.6.25 1.1.44 1.7l.2.5c.03.1.06.2.12.3l.2.4c.37.63.8 1.22 1.3 1.72 1.55 1.55 3.6 2.4 5.8 2.4h.1c2.15 0 4.2-.85 5.7-2.36.55-.53 1-1.1 1.36-1.7.1-.16.17-.3.23-.47l.14-.3.2-.5c.2-.57.33-1.15.42-1.74l.08-.5c.04-.2.04-.4.04-.6.02-2.16-.8-4.23-2.38-5.8zM29.2 29.2c0 .08 0 .16.03.28-.06-.17-.1-.34-.1-.53 0-.8.63-1.43 1.44-1.43.3 0 .58.1.8.25-1.25-.4-2.17.56-2.17 1.43zm1.26 2.8c3.6.04 6.6 2.58 7.3 5.98-.94-2.03-3.84-3.5-7.33-3.54-3.46 0-6.4 1.45-7.36 3.46.75-3.38 3.76-5.9 7.4-5.9zM29 43.66c-3.06-.42-5.35-2.18-5.35-4.27 0-2.4 3.04-4.4 6.78-4.3h1.03c-2.18 2.1-2.6 5.4-2.45 8.5zm8.32-1.18c-1.3 2.65-3.96 4.33-6.9 4.33-2.92 0-5.6-1.6-6.9-4.3-.3-.6-.45-1.2-.54-1.9.84 2.16 3.82 3.75 7.42 3.78 3.6 0 6.6-1.57 7.45-3.7-.1.68-.28 1.3-.53 1.88z' opacity='.6'/%3E%3C/svg%3E") 50% 50% no-repeat !important;
77			top: 2px;
78			width: 20px;
79			height: 20px;
80			display: inline-block;
81			}
82			</style>
83			<?php
84			}
85
86			/**
87			* Add Edit Entry links when on a single entry
88			*
89			* @since 1.13
90			* @return void
91			*/
92			function add_edit_entry_link() {
			0 ignored issues – show Best Practice introduced 2015-12-04 01:01 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...
93			/** @var WP_Admin_Bar $wp_admin_bar */
94			global $wp_admin_bar;
			0 ignored issues – show Compatibility Best Practice introduced 2016-01-18 22:19 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...
95
96			$entry_id = $this->gravityview_view->getSingleEntry();
97
98			if ( $entry_id && GVCommon::has_cap( array( 'gravityforms_edit_entries', 'gravityview_edit_entries' ), $entry_id ) ) {
99
100			$entry = $this->gravityview_view->getEntry();
101
102			$wp_admin_bar->add_menu( array(
103			'id' => 'edit-entry',
104			'parent' => 'gravityview',
105			'title' => __( 'Edit Entry', 'gravityview' ),
106			'meta' => array(
107			'title' => sprintf( __( 'Edit Entry %s', 'gravityview' ), GravityView_API::get_entry_slug( $entry['id'], $entry ) ),
108			),
109			'href' => esc_url_raw( admin_url( sprintf( 'admin.php?page=gf_entries&screen_mode=edit&view=entry&id=%d&lid=%d', $entry['form_id'], $entry['id'] ) ) ),
110			) );
111
112			}
113			}
114
115			/**
116			* Add Edit View link when in embedded View
117			*
118			* @since 1.13
119			* @return void
120			*/
121			function add_edit_view_and_form_link() {
			0 ignored issues – show Best Practice introduced 2016-05-19 22:12 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...
122			/** @var WP_Admin_Bar $wp_admin_bar */
123			global $wp_admin_bar;
			0 ignored issues – show Compatibility Best Practice introduced 2016-01-18 22:19 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...
124
125			if( GVCommon::has_cap( array( 'edit_gravityviews', 'edit_gravityview', 'gravityforms_edit_forms' ) ) ) {
126
127			$view_data = GravityView_View_Data::getInstance();
128
129			$views = $view_data->get_views();
130
131			// If there is a View embed, show Edit View link.
132			if ( ! empty( $views ) ) {
133
134			$added_forms = array();
135			$added_views = array();
136
137			foreach ( $views as $view ) {
138
139			$edit_view_title = __( 'Edit View', 'gravityview' );
140			$edit_form_title = __( 'Edit Form', 'gravityview' );
141
142			if( sizeof( $views ) > 1 ) {
143			$edit_view_title = sprintf( _x( 'Edit View #%d', 'Edit View with the ID of %d', 'gravityview' ), $view['id'] );
144			$edit_form_title = sprintf( __( 'Edit Form #%d', 'Edit Form with the ID of %d', 'gravityview' ), $view['form_id'] );
145			}
146
147			if( GVCommon::has_cap( 'edit_gravityview', $view['id'] ) && ! in_array( $view['id'], $added_views ) ) {
148
149			$added_views[] = $view['id'];
150
151			$wp_admin_bar->add_menu( array(
152			'id' => 'edit-view-' . $view['id'],
153			'parent' => 'gravityview',
154			'title' => $edit_view_title,
155			'href' => esc_url_raw( admin_url( sprintf( 'post.php?post=%d&action=edit', $view['id'] ) ) ),
156			) );
157			}
158
159			if ( ! empty( $view['form_id'] ) && GVCommon::has_cap( array( 'gravityforms_edit_forms' ), $view['form_id'] ) && ! in_array( $view['form_id'], $added_forms ) ) {
160
161			$added_forms[] = $view['form_id'];
162
163			$wp_admin_bar->add_menu( array(
164			'id' => 'edit-form-' . $view['form_id'],
165			'parent' => 'gravityview',
166			'title' => $edit_form_title,
167			'href' => esc_url_raw( admin_url( sprintf( 'admin.php?page=gf_edit_forms&id=%d', $view['form_id'] ) ) ),
168			) );
169			}
170			}
171			}
172			}
173			}
174
175			/**
176			* Remove "Edit Page" or "Edit View" links when on single entry.
177			*
178			* @since 1.17 Also remove when on GravityView post type; the new GravityView menu will be the one-stop shop.
179			* @since 1.13
180			*
181			* @return void
182			*/
183			function remove_links() {
			0 ignored issues – show Best Practice introduced 2015-12-04 01:01 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...
184
185			// If we're on the single entry page, we don't want to cause confusion.
186			if ( $this->gravityview_view->getSingleEntry() \|\| $this->gravityview_view->isGravityviewPostType() ) {
187			remove_action( 'admin_bar_menu', 'wp_admin_bar_edit_menu', 80 );
188			}
189			}
190			}
191
192			new GravityView_Admin_Bar;

gravityview / GravityView

Pull Request — master (#716)

GravityView_Admin_Bar::remove_links() A

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. Pass all data via parameters

2. Create a class that maintains your state

Duplication Side-by-Side

Filter issues like