Merge pull request #301 from codepress/release/4.2.2

Release/4.2.2

Author: DGStefan

README.MD

@@ -1,3 +1,5 @@
+# Admin Columns [![WordPress](https://img.shields.io/wordpress/plugin/tested/codepress-admin-columns.svg?style=flat-square)](https://wordpress.org/plugins/codepress-admin-columns/) [![WordPress](https://img.shields.io/wordpress/plugin/r/codepress-admin-columns.svg?style=flat-square)](https://wordpress.org/plugins/codepress-admin-columns/) [![WordPress](https://img.shields.io/wordpress/plugin/v/codepress-admin-columns.svg?style=flat-square)](https://wordpress.org/plugins/codepress-admin-columns/) [![WordPress](https://img.shields.io/wordpress/plugin/dt/codepress-admin-columns.svg?style=flat-square)](https://wordpress.org/plugins/codepress-admin-columns/) 
+
 ## Contributing to this project
 
 Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

api.php

@@ -6,6 +6,7 @@
 use AC\ListScreen;
 use AC\ListScreenCollection;
 use AC\Type\ListScreenId;
+use AC\Type\Url;
 
 /**
  * @return AC\AdminColumns
@@ -24,56 +25,33 @@ function ac_is_pro_active() {
 }
 
 /**
- * Get the url where the Admin Columns website is hosted
- *
  * @param string $path
  *
  * @return string
  */
-function ac_get_site_url( $path = '' ) {
-	$url = 'https://www.admincolumns.com';
-
-	if ( ! empty( $path ) ) {
-		$url .= '/' . trim( $path, '/' ) . '/';
-	}
-
-	return $url;
+function ac_get_site_url( $path = null ) {
+	return ( new Url\Site( $path ) )->get_url();
 }
 
 /**
- * Url with utm tags
+ * @param string|null $path
  *
+ * @return string
+ */
+function ac_get_site_documentation_url( $path = null ) {
+	return ( new Url\Documentation( $path ) )->get_url();
+}
+
+/**
  * @param string $path
  * @param string $utm_medium
  * @param string $utm_content
  * @param bool   $utm_campaign
  *
  * @return string
  */
-function ac_get_site_utm_url( $path, $utm_medium, $utm_content = null, $utm_campaign = false ) {
-	$url = ac_get_site_url( $path );
-
-	if ( ! $utm_campaign ) {
-		$utm_campaign = 'plugin-installation';
-	}
-
-	$args = [
-		// Referrer: plugin
-		'utm_source'   => 'plugin-installation',
-
-		// Specific promotions or sales
-		'utm_campaign' => $utm_campaign,
-
-		// Marketing medium: banner, documentation or email
-		'utm_medium'   => $utm_medium,
-
-		// Used for differentiation of medium
-		'utm_content'  => $utm_content,
-	];
-
-	$args = array_map( 'sanitize_key', array_filter( $args ) );
-
-	return add_query_arg( $args, $url );
+function ac_get_site_utm_url( $path, $utm_medium, $utm_content = null, $utm_campaign = null ) {
+	return ( new Url\UtmTags( new Url\Site( $path ), $utm_medium, $utm_content, $utm_campaign ) )->get_url();
 }
 
 /**

assets/css/admin-page-columns.css

@@ -19,6 +19,9 @@
 use AC\DefaultColumnsRepository;
 use AC\ListScreen;
 use AC\Message;
+use AC\Type\Url\Documentation;
+use AC\Type\Url\Site;
+use AC\Type\Url\UtmTags;
 use AC\View;
 
 class Columns extends Page implements Enqueueables, Helpable, Admin\ScreenOptions {
@@ -195,11 +198,22 @@ public function render() {
 
 						<?= new Banner(); ?>
 
-						<?= ( new View() )->set_template( 'admin/side-feedback' ); ?>
+						<?php
+						$view = new View( [
+							'documentation_url' => ( new UtmTags( new Documentation(), 'feedback-docs-button' ) )->get_url(),
+							'upgrade_url'       => ( new UtmTags( new Site( Site::PAGE_ABOUT_PRO ), 'feedback-purchase-button' ) )->get_url(),
+						] );
+						echo $view->set_template( 'admin/side-feedback' );
+						?>
 
 					<?php endif; ?>
 
-					<?= ( new View() )->set_template( 'admin/side-support' ); ?>
+					<?php
+					$view = new View( [
+						'documentation_url' => ( new UtmTags( new Documentation(), 'support' ) )->get_url(),
+					] );
+					echo $view->set_template( 'admin/side-support' );
+					?>
 
 				</div>
 
@@ -257,7 +271,9 @@ public function render() {
 
 		<?php
 
-		$modal = new View();
+		$modal = new View( [
+			'upgrade_url' => ( new UtmTags( new Site( Site::PAGE_ABOUT_PRO ), 'upgrade' ) )->get_url(),
+		] );
 
 		echo $modal->set_template( 'admin/modal-pro' );
 

classes/Admin/Page/Columns.php

@@ -8,6 +8,7 @@
 use AC\Asset\Location;
 use AC\Asset\Style;
 use AC\Deprecated\Hooks;
+use AC\Type\Url;
 
 class Help extends Page implements AC\Asset\Enqueueables {
 
@@ -35,12 +36,14 @@ public function get_assets() {
 	}
 
 	/**
-	 * @param string $page
-	 *
 	 * @return string
 	 */
-	private function get_documention_link( $page ) {
-		return ac_helper()->html->link( ac_get_site_utm_url( 'documentation/' . $page, 'documentation' ), __( 'View documentation', 'codepress-admin-columns' ) . ' »', [ 'target' => '_blank' ] );
+	private function get_documention_link() {
+		return sprintf(
+			'<a href="%s" target="_blank">%s &raquo;</a>',
+			( new Url\Documentation( Url\Documentation::ARTICLE_UPGRADE_V3_TO_V4 ) )->get_url(),
+			__( 'View documentation', 'codepress-admin-columns' )
+		);
 	}
 
 	/**
@@ -79,7 +82,7 @@ private function render_actions() {
 				$message .= ' ' . $this->get_callback_message( $callbacks );
 			}
 
-			$message .= ' ' . $this->get_documention_link( $hook->get_slug() ? 'action-reference/' . $hook->get_slug() : '#action-reference' );
+			$message .= ' ' . $this->get_documention_link();
 
 			$this->render_message( $message );
 		}
@@ -108,7 +111,7 @@ private function render_filters() {
 				$message .= ' ' . $this->get_callback_message( $callbacks );
 			}
 
-			$message .= ' ' . $this->get_documention_link( $hook->get_slug() ? 'filter-reference/' . $hook->get_slug() : '#filter-reference' );
+			$message .= ' ' . $this->get_documention_link();
 
 			$this->render_message( $message );
 		}
@@ -132,7 +135,15 @@ public function render() {
 		<p>
 			<?php _e( 'The Admin Columns plugin has undergone some major changes in version 4.', 'codepress-admin-columns' ); ?> <br/>
 
-			<?php printf( __( 'This site is using some actions or filters that have changed. Please read %s to resolve them.', 'codepress-admin-columns' ), ac_helper()->html->link( ac_get_site_utm_url( 'documentation/faq/upgrading-from-v3-to-v4', 'help' ), __( 'our documentation', 'codepress-admin-columns' ) ) ); ?>
+			<?php
+			printf(
+				__( 'This site is using some actions or filters that have changed. Please read %s to resolve them.', 'codepress-admin-columns' ),
+				sprintf(
+					'<a href="%s" target="_blank">%s</a>', ( new Url\Documentation( Url\Documentation::ARTICLE_UPGRADE_V3_TO_V4 ) )->get_url(),
+					__( 'our documentation', 'codepress-admin-columns' )
+				)
+			);
+			?>
 		</p>
 
 		<?php

classes/Admin/Page/Help.php

@@ -8,6 +8,9 @@
 use AC\Preferences;
 use AC\Registrable;
 use AC\Screen;
+use AC\Type\Url\Documentation;
+use AC\Type\Url\Site;
+use AC\Type\Url\UtmTags;
 use Exception;
 
 class Review
@@ -118,6 +121,24 @@ public function ajax_dismiss_notice() {
 		$this->get_preferences()->set( 'dismiss-review', true );
 	}
 
+	/**
+	 * @param string $utm_medium
+	 *
+	 * @return string
+	 */
+	private function get_forum_url( $utm_medium ) {
+		return ( new UtmTags( new Site( Site::PAGE_FORUM ), $utm_medium ) )->get_url();
+	}
+
+	/**
+	 * @param string $utm_medium
+	 *
+	 * @return string
+	 */
+	private function get_documentation_url( $utm_medium ) {
+		return ( new UtmTags( new Documentation(), $utm_medium ) )->get_url();
+	}
+
 	/**
 	 * @return string
 	 */
@@ -152,13 +173,13 @@ protected function get_message() {
 				printf(
 					__( "We're sorry to hear that; maybe we can help! If you're having problems properly setting up %s or if you would like help with some more advanced features, please visit our %s.", 'codepress-admin-columns' ),
 					$product,
-					'<a href="' . esc_url( ac_get_site_utm_url( 'documentation', 'review-notice' ) ) . '" target="_blank">' . __( 'documentation page', 'codepress-admin-columns' ) . '</a>'
+					'<a href="' . esc_url( $this->get_documentation_url( 'review-notice' ) ) . '" target="_blank">' . __( 'documentation page', 'codepress-admin-columns' ) . '</a>'
 				);
 
 				if ( ac_is_pro_active() ) {
 					printf(
 						__( 'You can also use your admincolumns.com account to access support through %s!', 'codepress-admin-columns' ),
-						'<a href="' . esc_url( ac_get_site_utm_url( 'topics', 'review-notice' ) ) . '" target="_blank">' . __( 'our forum', 'codepress-admin-columns' ) . '</a>'
+						'<a href="' . esc_url( $this->get_forum_url( 'review-notice' ) ) . '" target="_blank">' . __( 'our forum', 'codepress-admin-columns' ) . '</a>'
 					);
 				} else {
 					printf(

classes/Check/Review.php

@@ -25,7 +25,7 @@ function get_value( $post_id ) {
 	}
 
 	function get_raw_value( $post_id ) {
-		return get_post_field( 'post_name', $post_id, 'raw' );
+		return urldecode( get_post_field( 'post_name', $post_id, 'raw' ) );
 	}
 
 }

classes/Column/Post/Slug.php

@@ -2,6 +2,8 @@
 
 namespace AC;
 
+use AC\Type\Url;
+
 abstract class Integration {
 
 	/** @var string */
@@ -13,8 +15,8 @@ abstract class Integration {
 	/** @var string */
 	private $logo;
 
-	/** @var string */
-	private $page;
+	/** @var Url */
+	private $url;
 
 	/** @var string */
 	private $plugin_link;
@@ -32,21 +34,21 @@ abstract class Integration {
 	 * @param string $plugin_link
 	 * @param string $page
 	 */
-	public function __construct( $basename, $title, $logo, $description, $plugin_link = null, $page = null ) {
+	public function __construct( $basename, $title, $logo, $description, $plugin_link = null, Url $url = null ) {
 		if ( null === $plugin_link ) {
 			$plugin_link = $this->search_plugin( $title );
 		}
 
-		if ( null === $page ) {
-			$page = 'pricing-purchase';
+		if ( null === $url ) {
+			$url = new Url\Site( Url\Site::PAGE_PRICING );
 		}
 
 		$this->basename = $basename;
 		$this->title = $title;
 		$this->logo = $logo;
 		$this->description = $description;
 		$this->plugin_link = $plugin_link;
-		$this->page = $page;
+		$this->url = $url;
 	}
 
 	/**
@@ -116,7 +118,7 @@ public function get_description() {
 	 * @return string
 	 */
 	public function get_link() {
-		return ac_get_site_utm_url( $this->page, 'addon', $this->get_slug() );
+		return ( new Url\UtmTags( $this->url, 'addon', $this->get_slug() ) )->get_url();
 	}
 
 	/**

classes/Integration.php

@@ -4,6 +4,7 @@
 
 use AC\Integration;
 use AC\Screen;
+use AC\Type\Url\Site;
 
 final class ACF extends Integration {
 
@@ -14,7 +15,7 @@ public function __construct() {
 			'assets/images/addons/acf.png',
 			__( 'Display and edit ACF fields in the posts overview in seconds!', 'codepress-admin-columns' ),
 			'https://www.advancedcustomfields.com',
-			'advanced-custom-fields'
+			new Site( Site::PAGE_ADDON_ACF )
 		);
 	}
 

classes/Integration/ACF.php

@@ -5,6 +5,7 @@
 use AC\Integration;
 use AC\ListScreen;
 use AC\Screen;
+use AC\Type\Url\Site;
 
 final class BuddyPress extends Integration {
 
@@ -13,7 +14,9 @@ public function __construct() {
 			'ac-addon-buddypress/ac-addon-buddypress.php',
 			__( 'BuddyPress', 'codepress-admin-columns' ),
 			'assets/images/addons/buddypress.png',
-			__( 'Display any of your Profile Fields for BuddyPress on your users overview.', 'codepress-admin-columns' )
+			__( 'Display any of your Profile Fields for BuddyPress on your users overview.', 'codepress-admin-columns' ),
+			null,
+			new Site( Site::PAGE_ADDON_BUDDYPRESS )
 		);
 	}