insideout10 / wordlift-plugin

src/modules/food-kg/includes/Notices.php

Indentation +32 added lines, -32 removed lines

@@ -3,45 +3,45 @@
 namespace Wordlift\Modules\Food_Kg;
 
 class Notices {
-	/**
-	 * @var array{'type': string, 'html': string}
-	 */
-	private $notices = array();
+    /**
+     * @var array{'type': string, 'html': string}
+     */
+    private $notices = array();
 
-	public function register_hooks() {
-		add_action( 'admin_notices', array( $this, '__admin_notices' ) );
-	}
+    public function register_hooks() {
+        add_action( 'admin_notices', array( $this, '__admin_notices' ) );
+    }
 
-	/**
-	 * @param 'info'|'warning'|'error'|'success' $type
-	 * @param string                             $html
-	 *
-	 * @return void
-	 */
-	public function queue( $type, $html ) {
-		set_transient(
-			'_wl_notices',
-			array(
-				'type' => $type,
-				'html' => $html,
-			),
-			60
-		);
-	}
+    /**
+     * @param 'info'|'warning'|'error'|'success' $type
+     * @param string                             $html
+     *
+     * @return void
+     */
+    public function queue( $type, $html ) {
+        set_transient(
+            '_wl_notices',
+            array(
+                'type' => $type,
+                'html' => $html,
+            ),
+            60
+        );
+    }
 
-	public function __admin_notices() {
-		/** @var false|array{'type': string, 'html': string} $notice */
-		$notice = get_transient( '_wl_notices' );
-		if ( ! $notice ) {
-			return;
-		}
+    public function __admin_notices() {
+        /** @var false|array{'type': string, 'html': string} $notice */
+        $notice = get_transient( '_wl_notices' );
+        if ( ! $notice ) {
+            return;
+        }
 
-		$type_e = esc_attr( $notice['type'] );
-		?>
+        $type_e = esc_attr( $notice['type'] );
+        ?>
 		<div class="notice notice-<?php echo esc_attr( $type_e ); ?> is-dismissible">
 			<p><?php echo wp_kses( $notice['html'], array( 'a' ) ); ?></p>
 		</div>
 		<?php
-	}
+    }
 
 }

Spacing +7 added lines, -7 removed lines

@@ -9,7 +9,7 @@ 
 	private $notices = array();
 
 	public function register_hooks() {
-		add_action( 'admin_notices', array( $this, '__admin_notices' ) );
+		add_action('admin_notices', array($this, '__admin_notices'));
 	}
 
 	/**
@@ -18,7 +18,7 @@ 
 	 *
 	 * @return void
 	 */
-	public function queue( $type, $html ) {
+	public function queue($type, $html) {
 		set_transient(
 			'_wl_notices',
 			array(
@@ -31,15 +31,15 @@ 
 
 	public function __admin_notices() {
 		/** @var false|array{'type': string, 'html': string} $notice */
-		$notice = get_transient( '_wl_notices' );
-		if ( ! $notice ) {
+		$notice = get_transient('_wl_notices');
+		if ( ! $notice) {
 			return;
 		}
 
-		$type_e = esc_attr( $notice['type'] );
+		$type_e = esc_attr($notice['type']);
 		?>
-		<div class="notice notice-<?php echo esc_attr( $type_e ); ?> is-dismissible">
-			<p><?php echo wp_kses( $notice['html'], array( 'a' ) ); ?></p>
+		<div class="notice notice-<?php echo esc_attr($type_e); ?> is-dismissible">
+			<p><?php echo wp_kses($notice['html'], array('a')); ?></p>
 		</div>
 		<?php
 	}

src/includes/class-wordlift-activator.php

Indentation +31 added lines, -31 removed lines

@@ -21,44 +21,44 @@
  */
 class Wordlift_Activator {
 
-	/**
-	 * Short Description. (use period)
-	 *
-	 * Long Description.
-	 *
-	 * @since    1.0.0
-	 */
-	public static function activate() {
+    /**
+     * Short Description. (use period)
+     *
+     * Long Description.
+     *
+     * @since    1.0.0
+     */
+    public static function activate() {
 
-		// Do not let the plugin be activate on WordPress versions before 4.4.
-		$version = get_bloginfo( 'version' );
-		if ( version_compare( $version, '4.9', '<' ) ) {
-			die( esc_html__( 'The WordLift plugin requires WordPress version 4.9 or above.', 'wordlift' ) );
-		}
+        // Do not let the plugin be activate on WordPress versions before 4.4.
+        $version = get_bloginfo( 'version' );
+        if ( version_compare( $version, '4.9', '<' ) ) {
+            die( esc_html__( 'The WordLift plugin requires WordPress version 4.9 or above.', 'wordlift' ) );
+        }
 
-		$configuration_service = Wordlift_Configuration_Service::get_instance();
+        $configuration_service = Wordlift_Configuration_Service::get_instance();
 
-		// Create a blank application key if there is none.
-		$key = $configuration_service->get_key();
+        // Create a blank application key if there is none.
+        $key = $configuration_service->get_key();
 
-		if ( empty( $key ) ) {
-			$configuration_service->set_key( '' );
-		}
+        if ( empty( $key ) ) {
+            $configuration_service->set_key( '' );
+        }
 
-		// Intentionally go through the whole upgrade procedure to be DRY.
-		// The following function is called also from `init` so it's not necessary
-		// here.
-		// wl_core_update_db_check.
+        // Intentionally go through the whole upgrade procedure to be DRY.
+        // The following function is called also from `init` so it's not necessary
+        // here.
+        // wl_core_update_db_check.
 
-		// If WordLift's key is not configured, set `_wl_activation_redirect` transient. We won't redirect here, because we can't give
-		// for granted that we're in a browser admin session.
-		if ( '' === $configuration_service->get_key() ) {
-			set_transient( '_wl_activation_redirect', true, 30 );
-		}
+        // If WordLift's key is not configured, set `_wl_activation_redirect` transient. We won't redirect here, because we can't give
+        // for granted that we're in a browser admin session.
+        if ( '' === $configuration_service->get_key() ) {
+            set_transient( '_wl_activation_redirect', true, 30 );
+        }
 
-		// Clear caches.
-		Wordlift_File_Cache_Service::flush_all();
+        // Clear caches.
+        Wordlift_File_Cache_Service::flush_all();
 
-	}
+    }
 
 }

Spacing +7 added lines, -7 removed lines

@@ -31,9 +31,9 @@ 
 	public static function activate() {
 
 		// Do not let the plugin be activate on WordPress versions before 4.4.
-		$version = get_bloginfo( 'version' );
-		if ( version_compare( $version, '4.9', '<' ) ) {
-			die( esc_html__( 'The WordLift plugin requires WordPress version 4.9 or above.', 'wordlift' ) );
+		$version = get_bloginfo('version');
+		if (version_compare($version, '4.9', '<')) {
+			die(esc_html__('The WordLift plugin requires WordPress version 4.9 or above.', 'wordlift'));
 		}
 
 		$configuration_service = Wordlift_Configuration_Service::get_instance();
@@ -41,8 +41,8 @@ 
 		// Create a blank application key if there is none.
 		$key = $configuration_service->get_key();
 
-		if ( empty( $key ) ) {
-			$configuration_service->set_key( '' );
+		if (empty($key)) {
+			$configuration_service->set_key('');
 		}
 
 		// Intentionally go through the whole upgrade procedure to be DRY.
@@ -52,8 +52,8 @@ 
 
 		// If WordLift's key is not configured, set `_wl_activation_redirect` transient. We won't redirect here, because we can't give
 		// for granted that we're in a browser admin session.
-		if ( '' === $configuration_service->get_key() ) {
-			set_transient( '_wl_activation_redirect', true, 30 );
+		if ('' === $configuration_service->get_key()) {
+			set_transient('_wl_activation_redirect', true, 30);
 		}
 
 		// Clear caches.

src/includes/class-wordlift-timeline-service.php

Indentation +348 added lines, -348 removed lines

@@ -16,353 +16,353 @@
  */
 class Wordlift_Timeline_Service {
 
-	/**
-	 * The Log service.
-	 *
-	 * @since  3.1.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log The Log service.
-	 */
-	private $log;
-
-	/**
-	 * The number of words to use for the excerpt, set in the `to_json` function
-	 * and used by a filter.
-	 *
-	 * @since  3.7.0
-	 * @access private
-	 * @var int $excerpt_length The number of words to use for the excerpt.
-	 */
-	private $excerpt_length;
-
-	/**
-	 * A singleton instance of the Timeline service (useful for unit tests).
-	 *
-	 * @since  3.1.0
-	 * @access private
-	 * @var \Wordlift_Timeline_Service $instance The singleton instance.
-	 */
-	private static $instance;
-
-	/**
-	 * Create a Wordlift_Timeline_Service instance.
-	 *
-	 * @since 3.1.0
-	 */
-	public function __construct() {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Timeline_Service' );
-
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the singleton instance of the Wordlift_Timeline_Service
-	 *
-	 * @return \Wordlift_Timeline_Service The singleton instance of the Wordlift_Timeline_Service.
-	 * @since 3.1.0
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Retrieve timeline events and output them in JSON.
-	 *
-	 * @since 3.1.0
-	 */
-	public function ajax_timeline() {
-
-		check_ajax_referer( 'wl_timeline' );
-
-		// Get the ID of the post who requested the timeline.
-		$post_id = ( isset( $_REQUEST['post_id'] ) ? (int) $_REQUEST['post_id'] : null );
-
-		// Get the events and transform them for the JSON response, then send them to the client.
-		wp_send_json( $this->to_json( $this->get_events( $post_id ) ) );
-
-	}
-
-	/**
-	 * Retrieve timeline events.
-	 *
-	 * @param int $post_id The post ID.
-	 *
-	 * @return array An array of event posts.
-	 * @since 3.1.0
-	 *
-	 * @uses  wl_core_get_related_entity_ids() to retrieve the entities referenced by the specified post.
-	 */
-	public function get_events( $post_id = null ) {
-
-		// Get the entity IDs either from the entities related to the specified post or from the last 50 published
-		// posts if no post has been specified.
-		$ids = ( is_numeric( $post_id )
-			? wl_core_get_related_entity_ids( $post_id )
-			: $this->get_all_related_to_last_50_published_posts() );
-
-		// Add the post itself if it's an entity.
-		if ( is_numeric( $post_id ) && Wordlift_Entity_Service::get_instance()->is_entity( $post_id ) ) {
-			$ids[] = $post_id;
-		}
-
-		// If there's no entities, return an empty array right away.
-		if ( 0 === count( $ids ) ) {
-			$this->log->trace( "No events found [ post id :: $post_id ]" );
-
-			return array();
-		}
-
-		$this->log->trace( 'Getting events [ entity ids :: ' . join( ', ', $ids ) . ' ]' );
-
-		$args = array(
-			'post__in'       => $ids,
-			'post_type'      => Wordlift_Entity_Service::valid_entity_post_types(),
-			'post_status'    => 'publish',
-			'posts_per_page' => - 1,
-			'meta_query'     => array(
-				'relation' => 'AND',
-				array(
-					'key'     => Wordlift_Schema_Service::FIELD_DATE_START,
-					'value'   => null,
-					'compare' => '!=',
-				),
-				array(
-					'key'     => Wordlift_Schema_Service::FIELD_DATE_END,
-					'value'   => null,
-					'compare' => '!=',
-				),
-			),
-			'tax_query'      => array(
-				array(
-					'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-					'field'    => 'slug',
-					'terms'    => 'event',
-				),
-			),
-			'orderby'        => 'meta_value',
-			'order'          => 'DESC',
-			'meta_key'       => Wordlift_Schema_Service::FIELD_DATE_START,
-		);
-
-		return get_posts( $args );
-	}
-
-	/**
-	 * Convert timeline events to JSON. This function sets the global post in order
-	 * to get an automatic excerpt. Since we're being called inside an AJAX request,
-	 * we're not taking care of restoring any previous post: there isn't any.
-	 *
-	 * @param array $posts An array of posts.
-	 *
-	 * @return array|string An array of timeline events or an empty string if no posts are provided.
-	 * @since 3.1.0
-	 */
-	public function to_json( $posts ) {
-		check_ajax_referer( 'wl_timeline' );
-		// If there are no events, return empty JSON
-		if ( empty( $posts ) || $posts === null ) {
-			return '';
-		}
-
-		// {media|thumbnail}: if set to 'media' the image is attached to the slide, if set to 'background' the image is set as background.
-		$display_images_as = isset( $_REQUEST['display_images_as'] ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['display_images_as'] ) ) : 'media';
-
-		// The number of words for the excerpt (by default 55, as WordPress).
-		$excerpt_length       = isset( $_REQUEST['excerpt_length'] ) && is_numeric( $_REQUEST['excerpt_length'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['excerpt_length'] ) ) : 55;
-		$this->excerpt_length = $excerpt_length;
-		add_filter( 'excerpt_length', array( $this, 'excerpt_length' ), 10, 0 );
-
-		// Add a filter to remove the [...] after excerpts, since we're adding
-		// a link to the post itself.
-		add_filter( 'excerpt_more', array( $this, 'excerpt_more' ), 10, 0 );
-
-		// Prepare for the starting slide data. The starting slide will be the one where *now* is between *start/end* dates.
-		$start_at_slide = 0;
-		$event_index    = - 1;
-		$now            = time();
-
-		// Prepare the timeline variable.
-		$timeline = array();
-
-		// Populate the arrays.
-		$timeline['events'] = array_map(
-			function ( $item ) use ( &$timeline, &$event_index, &$start_at_slide, &$now, $display_images_as, $excerpt_length ) {
-
-				$date = array();
-
-				// Get the start and end dates.
-				// We have to remove double quotes from date to make timeline work properly
-				$start_date = strtotime( str_replace( '"', '', get_post_meta( $item->ID, Wordlift_Schema_Service::FIELD_DATE_START, true ) ) );
-				$end_date   = strtotime( str_replace( '"', '', get_post_meta( $item->ID, Wordlift_Schema_Service::FIELD_DATE_END, true ) ) );
-
-				// Set the starting slide.
-				// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-				$event_index ++;
-				// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-				if ( 0 === $start_at_slide && $now >= $start_date && $now <= $end_date ) {
-					// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-					$start_at_slide = $event_index;
-				}
-
-				// Load thumbnail
-				$thumbnail_id = get_post_thumbnail_id( $item->ID );
-				$attachment   = wp_get_attachment_image_src( $thumbnail_id );
-				if ( '' !== (string) $thumbnail_id && 0 !== $thumbnail_id
-					 && false !== $attachment
-				) {
-
-					// Set the thumbnail URL.
-					// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-					if ( 'background' === $display_images_as ) {
-						$date['background'] = array( 'url' => $attachment[0] );
-						$date['media']      = array( 'thumbnail' => $attachment[0] );
-					} else {
-						$date['media'] = array(
-							'url'       => $attachment[0],
-							'thumbnail' => $attachment[0],
-						);
-					}
-				}
-
-				// Set the start/end dates by converting them to TimelineJS required format.
-				$date['start_date'] = Wordlift_Timeline_Service::date( $start_date );
-				$date['end_date']   = Wordlift_Timeline_Service::date( $end_date );
-
-				setup_postdata( $GLOBALS['post'] = $item ); // phpcs:ignore Squiz.PHP.DisallowMultipleAssignments.Found,WordPress.WP.GlobalVariablesOverride.Prohibited
-
-				$more_link_text = sprintf(
-					'<span aria-label="%1$s">%2$s</span>',
-					sprintf(
-					/* translators: %s: Name of current post */
-						__( 'Continue reading %s', 'wordlift' ),
-						the_title_attribute( array( 'echo' => false ) )
-					),
-					__( '(more&hellip;)', 'wordlift' )
-				);
-
-				// Set the event text only with the headline (see https://github.com/insideout10/wordlift-plugin/issues/352).
-				$date['text'] = array(
-					'headline' => '<a href="' . get_permalink( $item->ID ) . '">' . $item->post_title . '</a>',
-				);
-
-				// If we have an excerpt, set it.
-				// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-				if ( 0 < $excerpt_length ) {
-					$date['text']['text'] = sprintf( '%s <a href="%s">%s</a>', get_the_excerpt(), get_permalink(), $more_link_text );
-				}
-
-				return $date;
-
-			},
-			$posts
-		);
-
-		// Finally remove the excerpt filter.
-		remove_filter( 'excerpt_length', array( $this, 'excerpt_length' ) );
-
-		// The JSON format is defined here: https://timeline.knightlab.com/docs/json-format.html
-		return array(
-			'timeline'       => $timeline,
-			'start_at_slide' => $start_at_slide,
-		);
-	}
-
-	/**
-	 * This function filters {@link excerpt_more} by removing it, since we're
-	 * adding the 'read more' link. This filter is set by {@see to_json}.
-	 *
-	 * @return string An empty string.
-	 * @since 3.7.0
-	 */
-	public function excerpt_more() {
-
-		return '';
-	}
-
-	/**
-	 * A filter for the excerpt length, set by the `to_json` function, to tailor
-	 * how many words to return according to the client setting.
-	 *
-	 * @return int The number of words for the preset.
-	 * @since 3.7.0
-	 */
-	public function excerpt_length() {
-
-		return $this->excerpt_length;
-	}
-
-	/**
-	 * Convert the date to a date array.
-	 *
-	 * @param $value int A date value.
-	 *
-	 * @return array An array containing year, month and day values.
-	 * @since 3.7.0
-	 */
-	public static function date( $value ) {
-
-		return array(
-			'year'  => (int) gmdate( 'Y', $value ),
-			'month' => (int) gmdate( 'm', $value ),
-			'day'   => (int) gmdate( 'd', $value ),
-
-		);
-	}
-
-	/**
-	 * Get the entities related to the last 50 posts published on this blog (we're keeping a long function name due to
-	 * its specific function).
-	 *
-	 * @return array An array of post IDs.
-	 * @since 3.1.0
-	 */
-	public function get_all_related_to_last_50_published_posts() {
-
-		// Global timeline. Get entities from the latest posts.
-		$latest_posts_ids = get_posts(
-			array(
-				'numberposts' => 50,
-				'fields'      => 'ids', // only get post IDs
-				'post_type'   => Wordlift_Entity_Service::valid_entity_post_types(),
-				'tax_query'   => array(
-					'relation' => 'OR',
-					array(
-						'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-						'operator' => 'NOT EXISTS',
-					),
-					array(
-						'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-						'field'    => 'slug',
-						'terms'    => 'article',
-					),
-				),
-				'post_status' => 'publish',
-			)
-		);
-
-		if ( empty( $latest_posts_ids ) ) {
-			// There are no posts.
-			return array();
-		}
-
-		// Collect entities related to latest posts
-		$entity_ids = array();
-		foreach ( $latest_posts_ids as $id ) {
-			$entity_ids = array_merge(
-				$entity_ids,
-				wl_core_get_related_entity_ids(
-					$id,
-					array(
-						'status' => 'publish',
-					)
-				)
-			);
-		}
-
-		return $entity_ids;
-	}
+    /**
+     * The Log service.
+     *
+     * @since  3.1.0
+     * @access private
+     * @var \Wordlift_Log_Service $log The Log service.
+     */
+    private $log;
+
+    /**
+     * The number of words to use for the excerpt, set in the `to_json` function
+     * and used by a filter.
+     *
+     * @since  3.7.0
+     * @access private
+     * @var int $excerpt_length The number of words to use for the excerpt.
+     */
+    private $excerpt_length;
+
+    /**
+     * A singleton instance of the Timeline service (useful for unit tests).
+     *
+     * @since  3.1.0
+     * @access private
+     * @var \Wordlift_Timeline_Service $instance The singleton instance.
+     */
+    private static $instance;
+
+    /**
+     * Create a Wordlift_Timeline_Service instance.
+     *
+     * @since 3.1.0
+     */
+    public function __construct() {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Timeline_Service' );
+
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the singleton instance of the Wordlift_Timeline_Service
+     *
+     * @return \Wordlift_Timeline_Service The singleton instance of the Wordlift_Timeline_Service.
+     * @since 3.1.0
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Retrieve timeline events and output them in JSON.
+     *
+     * @since 3.1.0
+     */
+    public function ajax_timeline() {
+
+        check_ajax_referer( 'wl_timeline' );
+
+        // Get the ID of the post who requested the timeline.
+        $post_id = ( isset( $_REQUEST['post_id'] ) ? (int) $_REQUEST['post_id'] : null );
+
+        // Get the events and transform them for the JSON response, then send them to the client.
+        wp_send_json( $this->to_json( $this->get_events( $post_id ) ) );
+
+    }
+
+    /**
+     * Retrieve timeline events.
+     *
+     * @param int $post_id The post ID.
+     *
+     * @return array An array of event posts.
+     * @since 3.1.0
+     *
+     * @uses  wl_core_get_related_entity_ids() to retrieve the entities referenced by the specified post.
+     */
+    public function get_events( $post_id = null ) {
+
+        // Get the entity IDs either from the entities related to the specified post or from the last 50 published
+        // posts if no post has been specified.
+        $ids = ( is_numeric( $post_id )
+            ? wl_core_get_related_entity_ids( $post_id )
+            : $this->get_all_related_to_last_50_published_posts() );
+
+        // Add the post itself if it's an entity.
+        if ( is_numeric( $post_id ) && Wordlift_Entity_Service::get_instance()->is_entity( $post_id ) ) {
+            $ids[] = $post_id;
+        }
+
+        // If there's no entities, return an empty array right away.
+        if ( 0 === count( $ids ) ) {
+            $this->log->trace( "No events found [ post id :: $post_id ]" );
+
+            return array();
+        }
+
+        $this->log->trace( 'Getting events [ entity ids :: ' . join( ', ', $ids ) . ' ]' );
+
+        $args = array(
+            'post__in'       => $ids,
+            'post_type'      => Wordlift_Entity_Service::valid_entity_post_types(),
+            'post_status'    => 'publish',
+            'posts_per_page' => - 1,
+            'meta_query'     => array(
+                'relation' => 'AND',
+                array(
+                    'key'     => Wordlift_Schema_Service::FIELD_DATE_START,
+                    'value'   => null,
+                    'compare' => '!=',
+                ),
+                array(
+                    'key'     => Wordlift_Schema_Service::FIELD_DATE_END,
+                    'value'   => null,
+                    'compare' => '!=',
+                ),
+            ),
+            'tax_query'      => array(
+                array(
+                    'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                    'field'    => 'slug',
+                    'terms'    => 'event',
+                ),
+            ),
+            'orderby'        => 'meta_value',
+            'order'          => 'DESC',
+            'meta_key'       => Wordlift_Schema_Service::FIELD_DATE_START,
+        );
+
+        return get_posts( $args );
+    }
+
+    /**
+     * Convert timeline events to JSON. This function sets the global post in order
+     * to get an automatic excerpt. Since we're being called inside an AJAX request,
+     * we're not taking care of restoring any previous post: there isn't any.
+     *
+     * @param array $posts An array of posts.
+     *
+     * @return array|string An array of timeline events or an empty string if no posts are provided.
+     * @since 3.1.0
+     */
+    public function to_json( $posts ) {
+        check_ajax_referer( 'wl_timeline' );
+        // If there are no events, return empty JSON
+        if ( empty( $posts ) || $posts === null ) {
+            return '';
+        }
+
+        // {media|thumbnail}: if set to 'media' the image is attached to the slide, if set to 'background' the image is set as background.
+        $display_images_as = isset( $_REQUEST['display_images_as'] ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['display_images_as'] ) ) : 'media';
+
+        // The number of words for the excerpt (by default 55, as WordPress).
+        $excerpt_length       = isset( $_REQUEST['excerpt_length'] ) && is_numeric( $_REQUEST['excerpt_length'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['excerpt_length'] ) ) : 55;
+        $this->excerpt_length = $excerpt_length;
+        add_filter( 'excerpt_length', array( $this, 'excerpt_length' ), 10, 0 );
+
+        // Add a filter to remove the [...] after excerpts, since we're adding
+        // a link to the post itself.
+        add_filter( 'excerpt_more', array( $this, 'excerpt_more' ), 10, 0 );
+
+        // Prepare for the starting slide data. The starting slide will be the one where *now* is between *start/end* dates.
+        $start_at_slide = 0;
+        $event_index    = - 1;
+        $now            = time();
+
+        // Prepare the timeline variable.
+        $timeline = array();
+
+        // Populate the arrays.
+        $timeline['events'] = array_map(
+            function ( $item ) use ( &$timeline, &$event_index, &$start_at_slide, &$now, $display_images_as, $excerpt_length ) {
+
+                $date = array();
+
+                // Get the start and end dates.
+                // We have to remove double quotes from date to make timeline work properly
+                $start_date = strtotime( str_replace( '"', '', get_post_meta( $item->ID, Wordlift_Schema_Service::FIELD_DATE_START, true ) ) );
+                $end_date   = strtotime( str_replace( '"', '', get_post_meta( $item->ID, Wordlift_Schema_Service::FIELD_DATE_END, true ) ) );
+
+                // Set the starting slide.
+                // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
+                $event_index ++;
+                // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
+                if ( 0 === $start_at_slide && $now >= $start_date && $now <= $end_date ) {
+                    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
+                    $start_at_slide = $event_index;
+                }
+
+                // Load thumbnail
+                $thumbnail_id = get_post_thumbnail_id( $item->ID );
+                $attachment   = wp_get_attachment_image_src( $thumbnail_id );
+                if ( '' !== (string) $thumbnail_id && 0 !== $thumbnail_id
+                     && false !== $attachment
+                ) {
+
+                    // Set the thumbnail URL.
+                    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
+                    if ( 'background' === $display_images_as ) {
+                        $date['background'] = array( 'url' => $attachment[0] );
+                        $date['media']      = array( 'thumbnail' => $attachment[0] );
+                    } else {
+                        $date['media'] = array(
+                            'url'       => $attachment[0],
+                            'thumbnail' => $attachment[0],
+                        );
+                    }
+                }
+
+                // Set the start/end dates by converting them to TimelineJS required format.
+                $date['start_date'] = Wordlift_Timeline_Service::date( $start_date );
+                $date['end_date']   = Wordlift_Timeline_Service::date( $end_date );
+
+                setup_postdata( $GLOBALS['post'] = $item ); // phpcs:ignore Squiz.PHP.DisallowMultipleAssignments.Found,WordPress.WP.GlobalVariablesOverride.Prohibited
+
+                $more_link_text = sprintf(
+                    '<span aria-label="%1$s">%2$s</span>',
+                    sprintf(
+                    /* translators: %s: Name of current post */
+                        __( 'Continue reading %s', 'wordlift' ),
+                        the_title_attribute( array( 'echo' => false ) )
+                    ),
+                    __( '(more&hellip;)', 'wordlift' )
+                );
+
+                // Set the event text only with the headline (see https://github.com/insideout10/wordlift-plugin/issues/352).
+                $date['text'] = array(
+                    'headline' => '<a href="' . get_permalink( $item->ID ) . '">' . $item->post_title . '</a>',
+                );
+
+                // If we have an excerpt, set it.
+                // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
+                if ( 0 < $excerpt_length ) {
+                    $date['text']['text'] = sprintf( '%s <a href="%s">%s</a>', get_the_excerpt(), get_permalink(), $more_link_text );
+                }
+
+                return $date;
+
+            },
+            $posts
+        );
+
+        // Finally remove the excerpt filter.
+        remove_filter( 'excerpt_length', array( $this, 'excerpt_length' ) );
+
+        // The JSON format is defined here: https://timeline.knightlab.com/docs/json-format.html
+        return array(
+            'timeline'       => $timeline,
+            'start_at_slide' => $start_at_slide,
+        );
+    }
+
+    /**
+     * This function filters {@link excerpt_more} by removing it, since we're
+     * adding the 'read more' link. This filter is set by {@see to_json}.
+     *
+     * @return string An empty string.
+     * @since 3.7.0
+     */
+    public function excerpt_more() {
+
+        return '';
+    }
+
+    /**
+     * A filter for the excerpt length, set by the `to_json` function, to tailor
+     * how many words to return according to the client setting.
+     *
+     * @return int The number of words for the preset.
+     * @since 3.7.0
+     */
+    public function excerpt_length() {
+
+        return $this->excerpt_length;
+    }
+
+    /**
+     * Convert the date to a date array.
+     *
+     * @param $value int A date value.
+     *
+     * @return array An array containing year, month and day values.
+     * @since 3.7.0
+     */
+    public static function date( $value ) {
+
+        return array(
+            'year'  => (int) gmdate( 'Y', $value ),
+            'month' => (int) gmdate( 'm', $value ),
+            'day'   => (int) gmdate( 'd', $value ),
+
+        );
+    }
+
+    /**
+     * Get the entities related to the last 50 posts published on this blog (we're keeping a long function name due to
+     * its specific function).
+     *
+     * @return array An array of post IDs.
+     * @since 3.1.0
+     */
+    public function get_all_related_to_last_50_published_posts() {
+
+        // Global timeline. Get entities from the latest posts.
+        $latest_posts_ids = get_posts(
+            array(
+                'numberposts' => 50,
+                'fields'      => 'ids', // only get post IDs
+                'post_type'   => Wordlift_Entity_Service::valid_entity_post_types(),
+                'tax_query'   => array(
+                    'relation' => 'OR',
+                    array(
+                        'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                        'operator' => 'NOT EXISTS',
+                    ),
+                    array(
+                        'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                        'field'    => 'slug',
+                        'terms'    => 'article',
+                    ),
+                ),
+                'post_status' => 'publish',
+            )
+        );
+
+        if ( empty( $latest_posts_ids ) ) {
+            // There are no posts.
+            return array();
+        }
+
+        // Collect entities related to latest posts
+        $entity_ids = array();
+        foreach ( $latest_posts_ids as $id ) {
+            $entity_ids = array_merge(
+                $entity_ids,
+                wl_core_get_related_entity_ids(
+                    $id,
+                    array(
+                        'status' => 'publish',
+                    )
+                )
+            );
+        }
+
+        return $entity_ids;
+    }
 
 }

Spacing +48 added lines, -48 removed lines

@@ -51,7 +51,7 @@ 
 	 */
 	public function __construct() {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Timeline_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Timeline_Service');
 
 		self::$instance = $this;
 
@@ -75,13 +75,13 @@ 
 	 */
 	public function ajax_timeline() {
 
-		check_ajax_referer( 'wl_timeline' );
+		check_ajax_referer('wl_timeline');
 
 		// Get the ID of the post who requested the timeline.
-		$post_id = ( isset( $_REQUEST['post_id'] ) ? (int) $_REQUEST['post_id'] : null );
+		$post_id = (isset($_REQUEST['post_id']) ? (int) $_REQUEST['post_id'] : null);
 
 		// Get the events and transform them for the JSON response, then send them to the client.
-		wp_send_json( $this->to_json( $this->get_events( $post_id ) ) );
+		wp_send_json($this->to_json($this->get_events($post_id)));
 
 	}
 
@@ -95,33 +95,33 @@ 
 	 *
 	 * @uses  wl_core_get_related_entity_ids() to retrieve the entities referenced by the specified post.
 	 */
-	public function get_events( $post_id = null ) {
+	public function get_events($post_id = null) {
 
 		// Get the entity IDs either from the entities related to the specified post or from the last 50 published
 		// posts if no post has been specified.
-		$ids = ( is_numeric( $post_id )
-			? wl_core_get_related_entity_ids( $post_id )
-			: $this->get_all_related_to_last_50_published_posts() );
+		$ids = (is_numeric($post_id)
+			? wl_core_get_related_entity_ids($post_id)
+			: $this->get_all_related_to_last_50_published_posts());
 
 		// Add the post itself if it's an entity.
-		if ( is_numeric( $post_id ) && Wordlift_Entity_Service::get_instance()->is_entity( $post_id ) ) {
+		if (is_numeric($post_id) && Wordlift_Entity_Service::get_instance()->is_entity($post_id)) {
 			$ids[] = $post_id;
 		}
 
 		// If there's no entities, return an empty array right away.
-		if ( 0 === count( $ids ) ) {
-			$this->log->trace( "No events found [ post id :: $post_id ]" );
+		if (0 === count($ids)) {
+			$this->log->trace("No events found [ post id :: $post_id ]");
 
 			return array();
 		}
 
-		$this->log->trace( 'Getting events [ entity ids :: ' . join( ', ', $ids ) . ' ]' );
+		$this->log->trace('Getting events [ entity ids :: '.join(', ', $ids).' ]');
 
 		$args = array(
 			'post__in'       => $ids,
 			'post_type'      => Wordlift_Entity_Service::valid_entity_post_types(),
 			'post_status'    => 'publish',
-			'posts_per_page' => - 1,
+			'posts_per_page' => -1,
 			'meta_query'     => array(
 				'relation' => 'AND',
 				array(
@@ -147,7 +147,7 @@ 
 			'meta_key'       => Wordlift_Schema_Service::FIELD_DATE_START,
 		);
 
-		return get_posts( $args );
+		return get_posts($args);
 	}
 
 	/**
@@ -160,24 +160,24 @@ 
 	 * @return array|string An array of timeline events or an empty string if no posts are provided.
 	 * @since 3.1.0
 	 */
-	public function to_json( $posts ) {
-		check_ajax_referer( 'wl_timeline' );
+	public function to_json($posts) {
+		check_ajax_referer('wl_timeline');
 		// If there are no events, return empty JSON
-		if ( empty( $posts ) || $posts === null ) {
+		if (empty($posts) || $posts === null) {
 			return '';
 		}
 
 		// {media|thumbnail}: if set to 'media' the image is attached to the slide, if set to 'background' the image is set as background.
-		$display_images_as = isset( $_REQUEST['display_images_as'] ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['display_images_as'] ) ) : 'media';
+		$display_images_as = isset($_REQUEST['display_images_as']) ? sanitize_text_field(wp_unslash((string) $_REQUEST['display_images_as'])) : 'media';
 
 		// The number of words for the excerpt (by default 55, as WordPress).
-		$excerpt_length       = isset( $_REQUEST['excerpt_length'] ) && is_numeric( $_REQUEST['excerpt_length'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['excerpt_length'] ) ) : 55;
+		$excerpt_length       = isset($_REQUEST['excerpt_length']) && is_numeric($_REQUEST['excerpt_length']) ? sanitize_text_field(wp_unslash($_REQUEST['excerpt_length'])) : 55;
 		$this->excerpt_length = $excerpt_length;
-		add_filter( 'excerpt_length', array( $this, 'excerpt_length' ), 10, 0 );
+		add_filter('excerpt_length', array($this, 'excerpt_length'), 10, 0);
 
 		// Add a filter to remove the [...] after excerpts, since we're adding
 		// a link to the post itself.
-		add_filter( 'excerpt_more', array( $this, 'excerpt_more' ), 10, 0 );
+		add_filter('excerpt_more', array($this, 'excerpt_more'), 10, 0);
 
 		// Prepare for the starting slide data. The starting slide will be the one where *now* is between *start/end* dates.
 		$start_at_slide = 0;
@@ -189,36 +189,36 @@ 
 
 		// Populate the arrays.
 		$timeline['events'] = array_map(
-			function ( $item ) use ( &$timeline, &$event_index, &$start_at_slide, &$now, $display_images_as, $excerpt_length ) {
+			function($item) use (&$timeline, &$event_index, &$start_at_slide, &$now, $display_images_as, $excerpt_length) {
 
 				$date = array();
 
 				// Get the start and end dates.
 				// We have to remove double quotes from date to make timeline work properly
-				$start_date = strtotime( str_replace( '"', '', get_post_meta( $item->ID, Wordlift_Schema_Service::FIELD_DATE_START, true ) ) );
-				$end_date   = strtotime( str_replace( '"', '', get_post_meta( $item->ID, Wordlift_Schema_Service::FIELD_DATE_END, true ) ) );
+				$start_date = strtotime(str_replace('"', '', get_post_meta($item->ID, Wordlift_Schema_Service::FIELD_DATE_START, true)));
+				$end_date   = strtotime(str_replace('"', '', get_post_meta($item->ID, Wordlift_Schema_Service::FIELD_DATE_END, true)));
 
 				// Set the starting slide.
 				// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-				$event_index ++;
+				$event_index++;
 				// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-				if ( 0 === $start_at_slide && $now >= $start_date && $now <= $end_date ) {
+				if (0 === $start_at_slide && $now >= $start_date && $now <= $end_date) {
 					// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
 					$start_at_slide = $event_index;
 				}
 
 				// Load thumbnail
-				$thumbnail_id = get_post_thumbnail_id( $item->ID );
-				$attachment   = wp_get_attachment_image_src( $thumbnail_id );
-				if ( '' !== (string) $thumbnail_id && 0 !== $thumbnail_id
+				$thumbnail_id = get_post_thumbnail_id($item->ID);
+				$attachment   = wp_get_attachment_image_src($thumbnail_id);
+				if ('' !== (string) $thumbnail_id && 0 !== $thumbnail_id
 					 && false !== $attachment
 				) {
 
 					// Set the thumbnail URL.
 					// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-					if ( 'background' === $display_images_as ) {
-						$date['background'] = array( 'url' => $attachment[0] );
-						$date['media']      = array( 'thumbnail' => $attachment[0] );
+					if ('background' === $display_images_as) {
+						$date['background'] = array('url' => $attachment[0]);
+						$date['media']      = array('thumbnail' => $attachment[0]);
 					} else {
 						$date['media'] = array(
 							'url'       => $attachment[0],
@@ -228,30 +228,30 @@ 
 				}
 
 				// Set the start/end dates by converting them to TimelineJS required format.
-				$date['start_date'] = Wordlift_Timeline_Service::date( $start_date );
-				$date['end_date']   = Wordlift_Timeline_Service::date( $end_date );
+				$date['start_date'] = Wordlift_Timeline_Service::date($start_date);
+				$date['end_date']   = Wordlift_Timeline_Service::date($end_date);
 
-				setup_postdata( $GLOBALS['post'] = $item ); // phpcs:ignore Squiz.PHP.DisallowMultipleAssignments.Found,WordPress.WP.GlobalVariablesOverride.Prohibited
+				setup_postdata($GLOBALS['post'] = $item); // phpcs:ignore Squiz.PHP.DisallowMultipleAssignments.Found,WordPress.WP.GlobalVariablesOverride.Prohibited
 
 				$more_link_text = sprintf(
 					'<span aria-label="%1$s">%2$s</span>',
 					sprintf(
 					/* translators: %s: Name of current post */
-						__( 'Continue reading %s', 'wordlift' ),
-						the_title_attribute( array( 'echo' => false ) )
+						__('Continue reading %s', 'wordlift'),
+						the_title_attribute(array('echo' => false))
 					),
-					__( '(more&hellip;)', 'wordlift' )
+					__('(more&hellip;)', 'wordlift')
 				);
 
 				// Set the event text only with the headline (see https://github.com/insideout10/wordlift-plugin/issues/352).
 				$date['text'] = array(
-					'headline' => '<a href="' . get_permalink( $item->ID ) . '">' . $item->post_title . '</a>',
+					'headline' => '<a href="'.get_permalink($item->ID).'">'.$item->post_title.'</a>',
 				);
 
 				// If we have an excerpt, set it.
 				// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-				if ( 0 < $excerpt_length ) {
-					$date['text']['text'] = sprintf( '%s <a href="%s">%s</a>', get_the_excerpt(), get_permalink(), $more_link_text );
+				if (0 < $excerpt_length) {
+					$date['text']['text'] = sprintf('%s <a href="%s">%s</a>', get_the_excerpt(), get_permalink(), $more_link_text);
 				}
 
 				return $date;
@@ -261,7 +261,7 @@ 
 		);
 
 		// Finally remove the excerpt filter.
-		remove_filter( 'excerpt_length', array( $this, 'excerpt_length' ) );
+		remove_filter('excerpt_length', array($this, 'excerpt_length'));
 
 		// The JSON format is defined here: https://timeline.knightlab.com/docs/json-format.html
 		return array(
@@ -302,12 +302,12 @@ 
 	 * @return array An array containing year, month and day values.
 	 * @since 3.7.0
 	 */
-	public static function date( $value ) {
+	public static function date($value) {
 
 		return array(
-			'year'  => (int) gmdate( 'Y', $value ),
-			'month' => (int) gmdate( 'm', $value ),
-			'day'   => (int) gmdate( 'd', $value ),
+			'year'  => (int) gmdate('Y', $value),
+			'month' => (int) gmdate('m', $value),
+			'day'   => (int) gmdate('d', $value),
 
 		);
 	}
@@ -343,14 +343,14 @@ 
 			)
 		);
 
-		if ( empty( $latest_posts_ids ) ) {
+		if (empty($latest_posts_ids)) {
 			// There are no posts.
 			return array();
 		}
 
 		// Collect entities related to latest posts
 		$entity_ids = array();
-		foreach ( $latest_posts_ids as $id ) {
+		foreach ($latest_posts_ids as $id) {
 			$entity_ids = array_merge(
 				$entity_ids,
 				wl_core_get_related_entity_ids(

src/includes/cache/class-wordlift-file-cache-service.php

Indentation +214 added lines, -214 removed lines

@@ -16,232 +16,232 @@
  */
 class Wordlift_File_Cache_Service implements Wordlift_Cache_Service {
 
-	/**
-	 * The cache directory.
-	 *
-	 * @since  3.16.0
-	 * @access private
-	 * @var string $cache_dir The root cache directory (ending with a trailing slash).
-	 */
-	private $cache_dir;
-
-	/**
-	 * The file extension for cache files (e.g. `.wlcache`).
-	 *
-	 * @since  3.16.0
-	 * @access private
-	 * @var string $file_extension The file extension for cache files (e.g. `.wlcache`).
-	 */
-	private $file_extension;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.16.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * The {@link Wordlift_File_Cache_Service} registered instances.
-	 *
-	 * Each {@link Wordlift_File_Cache_Service} adds itself to the registered
-	 * instances.
-	 *
-	 * @since  3.16.3
-	 * @access private
-	 * @var array $instances An array of {@link Wordlift_File_Cache_Service} instances.
-	 */
-	private static $instances = array();
-
-	private static $instance;
-
-	/**
-	 * Create a {@link Wordlift_File_Cache_Service} instance.
-	 *
-	 * The File Cache Service requires a base cache directory (to which a unique
-	 * id for the current site will be appended) and a file extension for cache
-	 * files (by default `.wlcache`) is used.
-	 *
-	 * @param string $cache_dir The base cache directory.
-	 * @param string $file_extension The file extension, by default `.wlcache`.
-	 *
-	 * @since 3.16.0
-	 */
-	public function __construct( $cache_dir, $file_extension = '.wlcache' ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		// Set the cache directory using the base directory provided by the caller
-		// and appending a hash for the unique site id.
-		$this->cache_dir      = trailingslashit( $cache_dir ) . md5( get_site_url() ) . '/';
-		$this->file_extension = $file_extension;
-
-		// Create the cache dir.
-		if ( ! file_exists( $this->cache_dir ) ) {
-			// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-			@mkdir( $this->cache_dir, 0755, true );
-		}
-
-		// Add ourselves to the list of instances.
-		self::$instances[] = $this;
-
-		// Initialize the singleton and the ajax method.
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = $this;
-
-			add_action( 'wp_ajax_wl_file_cache__flush_all', array( 'Wordlift_File_Cache_Service', 'flush_all' ) );
-		}
-
-		$this->log->debug( "File Cache service initialized on $this->cache_dir." );
-
-	}
-
-	/**
-	 * Get the cached response for the specified `id`.
-	 *
-	 * @param int $id The cache `id`.
-	 *
-	 * @return mixed|false The cached contents or false if the cache isn't found.
-	 * @since 3.16.0
-	 */
-	public function get_cache( $id ) {
-
-		// Bail out if we don't have the cache.
-		if ( ! $this->has_cache( $id ) ) {
-			return false;
-		}
-
-		// Get the filename.
-		$filename = $this->get_filename( $id );
-
-		$this->log->trace( "Trying to get cache contents for $id from $filename..." );
-
-		// Try to decode the contents.
-		// phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
-		$contents = json_decode( file_get_contents( $filename ), true );
-
-		// Return false if decoding failed, otherwise the decoded contents.
-		return $contents ? $contents : false;
-	}
-
-	/**
-	 * Set the cache contents for the specified `id`.
-	 *
-	 * @param int $id The cache id.
-	 *
-	 * @return bool True if the `id` has a cache.
-	 * @since 3.16.0
-	 */
-	public function has_cache( $id ) {
-
-		// Get the filename.
-		$filename = $this->get_filename( $id );
-
-		// Bail out if the file doesn't exist.
-		return file_exists( $filename );
-	}
-
-	/**
-	 * @inheritdoc
-	 */
-	public function set_cache( $id, $contents ) {
-
-		$filename = $this->get_filename( $id );
-
-		$this->log->trace( "Writing cache contents for $id to $filename..." );
-
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged,WordPress.WP.AlternativeFunctions.file_system_read_file_put_contents
-		@file_put_contents( $filename, wp_json_encode( $contents ) );
-
-	}
-
-	/**
-	 * Delete the cache for the specified `id`.
-	 *
-	 * @param int $id The cache `id`.
-	 *
-	 * @since 3.16.0
-	 */
-	public function delete_cache( $id ) {
-
-		$filename = $this->get_filename( $id );
-
-		$this->log->trace( "Deleting cache contents for $id, file $filename..." );
+    /**
+     * The cache directory.
+     *
+     * @since  3.16.0
+     * @access private
+     * @var string $cache_dir The root cache directory (ending with a trailing slash).
+     */
+    private $cache_dir;
+
+    /**
+     * The file extension for cache files (e.g. `.wlcache`).
+     *
+     * @since  3.16.0
+     * @access private
+     * @var string $file_extension The file extension for cache files (e.g. `.wlcache`).
+     */
+    private $file_extension;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.16.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * The {@link Wordlift_File_Cache_Service} registered instances.
+     *
+     * Each {@link Wordlift_File_Cache_Service} adds itself to the registered
+     * instances.
+     *
+     * @since  3.16.3
+     * @access private
+     * @var array $instances An array of {@link Wordlift_File_Cache_Service} instances.
+     */
+    private static $instances = array();
+
+    private static $instance;
+
+    /**
+     * Create a {@link Wordlift_File_Cache_Service} instance.
+     *
+     * The File Cache Service requires a base cache directory (to which a unique
+     * id for the current site will be appended) and a file extension for cache
+     * files (by default `.wlcache`) is used.
+     *
+     * @param string $cache_dir The base cache directory.
+     * @param string $file_extension The file extension, by default `.wlcache`.
+     *
+     * @since 3.16.0
+     */
+    public function __construct( $cache_dir, $file_extension = '.wlcache' ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        // Set the cache directory using the base directory provided by the caller
+        // and appending a hash for the unique site id.
+        $this->cache_dir      = trailingslashit( $cache_dir ) . md5( get_site_url() ) . '/';
+        $this->file_extension = $file_extension;
+
+        // Create the cache dir.
+        if ( ! file_exists( $this->cache_dir ) ) {
+            // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+            @mkdir( $this->cache_dir, 0755, true );
+        }
+
+        // Add ourselves to the list of instances.
+        self::$instances[] = $this;
+
+        // Initialize the singleton and the ajax method.
+        if ( ! isset( self::$instance ) ) {
+            self::$instance = $this;
+
+            add_action( 'wp_ajax_wl_file_cache__flush_all', array( 'Wordlift_File_Cache_Service', 'flush_all' ) );
+        }
+
+        $this->log->debug( "File Cache service initialized on $this->cache_dir." );
+
+    }
+
+    /**
+     * Get the cached response for the specified `id`.
+     *
+     * @param int $id The cache `id`.
+     *
+     * @return mixed|false The cached contents or false if the cache isn't found.
+     * @since 3.16.0
+     */
+    public function get_cache( $id ) {
+
+        // Bail out if we don't have the cache.
+        if ( ! $this->has_cache( $id ) ) {
+            return false;
+        }
+
+        // Get the filename.
+        $filename = $this->get_filename( $id );
+
+        $this->log->trace( "Trying to get cache contents for $id from $filename..." );
+
+        // Try to decode the contents.
+        // phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
+        $contents = json_decode( file_get_contents( $filename ), true );
+
+        // Return false if decoding failed, otherwise the decoded contents.
+        return $contents ? $contents : false;
+    }
+
+    /**
+     * Set the cache contents for the specified `id`.
+     *
+     * @param int $id The cache id.
+     *
+     * @return bool True if the `id` has a cache.
+     * @since 3.16.0
+     */
+    public function has_cache( $id ) {
+
+        // Get the filename.
+        $filename = $this->get_filename( $id );
+
+        // Bail out if the file doesn't exist.
+        return file_exists( $filename );
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function set_cache( $id, $contents ) {
+
+        $filename = $this->get_filename( $id );
+
+        $this->log->trace( "Writing cache contents for $id to $filename..." );
+
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged,WordPress.WP.AlternativeFunctions.file_system_read_file_put_contents
+        @file_put_contents( $filename, wp_json_encode( $contents ) );
+
+    }
+
+    /**
+     * Delete the cache for the specified `id`.
+     *
+     * @param int $id The cache `id`.
+     *
+     * @since 3.16.0
+     */
+    public function delete_cache( $id ) {
+
+        $filename = $this->get_filename( $id );
+
+        $this->log->trace( "Deleting cache contents for $id, file $filename..." );
 
-		if ( file_exists( $filename ) ) {
-			// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-			@unlink( $filename );
-		}
-
-	}
+        if ( file_exists( $filename ) ) {
+            // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+            @unlink( $filename );
+        }
+
+    }
 
-	/**
-	 * Flush the whole cache.
-	 *
-	 * @since 3.16.0
-	 */
-	public function flush() {
+    /**
+     * Flush the whole cache.
+     *
+     * @since 3.16.0
+     */
+    public function flush() {
 
-		// Bail out if the cache dir isn't set.
-		if ( empty( $this->cache_dir ) || '/' === $this->cache_dir ) {
-			return;
-		}
+        // Bail out if the cache dir isn't set.
+        if ( empty( $this->cache_dir ) || '/' === $this->cache_dir ) {
+            return;
+        }
 
-		$this->log->trace( "Flushing cache contents from $this->cache_dir..." );
+        $this->log->trace( "Flushing cache contents from $this->cache_dir..." );
 
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		$handle = @opendir( $this->cache_dir );
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        $handle = @opendir( $this->cache_dir );
 
-		// Bail out if the directory can't be opened.
-		if ( false === $handle ) {
-			return;
-		}
-
-		// Calculate the file extension length for matching file names.
-		$file_extension_length = strlen( $this->file_extension );
-
-		// Loop into the directory to delete files.
-		while ( false !== ( $entry = readdir( $handle ) ) ) { //phpcs:ignore WordPress.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition
-			if ( substr( $entry, - $file_extension_length ) === $this->file_extension
-				 && file_exists( $this->cache_dir . $entry ) ) {
-				$this->log->trace( "Deleting file {$this->cache_dir}{$entry}..." );
+        // Bail out if the directory can't be opened.
+        if ( false === $handle ) {
+            return;
+        }
+
+        // Calculate the file extension length for matching file names.
+        $file_extension_length = strlen( $this->file_extension );
+
+        // Loop into the directory to delete files.
+        while ( false !== ( $entry = readdir( $handle ) ) ) { //phpcs:ignore WordPress.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition
+            if ( substr( $entry, - $file_extension_length ) === $this->file_extension
+                 && file_exists( $this->cache_dir . $entry ) ) {
+                $this->log->trace( "Deleting file {$this->cache_dir}{$entry}..." );
 
-				// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-				@unlink( $this->cache_dir . $entry );
-			}
-		}
+                // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+                @unlink( $this->cache_dir . $entry );
+            }
+        }
 
-		// Finally closed the directory.
-		closedir( $handle );
+        // Finally closed the directory.
+        closedir( $handle );
 
-	}
+    }
 
-	public static function flush_all() {
-
-		foreach ( self::$instances as $instance ) {
-			$instance->flush();
-		}
-
-		if ( defined( 'DOING_AJAX' ) && DOING_AJAX
-			 && isset( $_REQUEST['action'] ) && 'wl_file_cache__flush_all' === $_REQUEST['action'] ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-			wp_send_json_success();
-		}
+    public static function flush_all() {
+
+        foreach ( self::$instances as $instance ) {
+            $instance->flush();
+        }
+
+        if ( defined( 'DOING_AJAX' ) && DOING_AJAX
+             && isset( $_REQUEST['action'] ) && 'wl_file_cache__flush_all' === $_REQUEST['action'] ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+            wp_send_json_success();
+        }
 
-	}
+    }
 
-	/**
-	 * Get the filename holding the cache contents for the specified `id`.
-	 *
-	 * @param int $id The cache `id`.
-	 *
-	 * @return string The filename.
-	 * @since 3.16.0
-	 */
-	private function get_filename( $id ) {
+    /**
+     * Get the filename holding the cache contents for the specified `id`.
+     *
+     * @param int $id The cache `id`.
+     *
+     * @return string The filename.
+     * @since 3.16.0
+     */
+    private function get_filename( $id ) {
 
-		return $this->cache_dir . md5( $id ) . $this->file_extension;
-	}
+        return $this->cache_dir . md5( $id ) . $this->file_extension;
+    }
 
 }

Spacing +41 added lines, -41 removed lines

@@ -69,32 +69,32 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	public function __construct( $cache_dir, $file_extension = '.wlcache' ) {
+	public function __construct($cache_dir, $file_extension = '.wlcache') {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		// Set the cache directory using the base directory provided by the caller
 		// and appending a hash for the unique site id.
-		$this->cache_dir      = trailingslashit( $cache_dir ) . md5( get_site_url() ) . '/';
+		$this->cache_dir      = trailingslashit($cache_dir).md5(get_site_url()).'/';
 		$this->file_extension = $file_extension;
 
 		// Create the cache dir.
-		if ( ! file_exists( $this->cache_dir ) ) {
+		if ( ! file_exists($this->cache_dir)) {
 			// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-			@mkdir( $this->cache_dir, 0755, true );
+			@mkdir($this->cache_dir, 0755, true);
 		}
 
 		// Add ourselves to the list of instances.
 		self::$instances[] = $this;
 
 		// Initialize the singleton and the ajax method.
-		if ( ! isset( self::$instance ) ) {
+		if ( ! isset(self::$instance)) {
 			self::$instance = $this;
 
-			add_action( 'wp_ajax_wl_file_cache__flush_all', array( 'Wordlift_File_Cache_Service', 'flush_all' ) );
+			add_action('wp_ajax_wl_file_cache__flush_all', array('Wordlift_File_Cache_Service', 'flush_all'));
 		}
 
-		$this->log->debug( "File Cache service initialized on $this->cache_dir." );
+		$this->log->debug("File Cache service initialized on $this->cache_dir.");
 
 	}
 
@@ -106,21 +106,21 @@ 
 	 * @return mixed|false The cached contents or false if the cache isn't found.
 	 * @since 3.16.0
 	 */
-	public function get_cache( $id ) {
+	public function get_cache($id) {
 
 		// Bail out if we don't have the cache.
-		if ( ! $this->has_cache( $id ) ) {
+		if ( ! $this->has_cache($id)) {
 			return false;
 		}
 
 		// Get the filename.
-		$filename = $this->get_filename( $id );
+		$filename = $this->get_filename($id);
 
-		$this->log->trace( "Trying to get cache contents for $id from $filename..." );
+		$this->log->trace("Trying to get cache contents for $id from $filename...");
 
 		// Try to decode the contents.
 		// phpcs:ignore WordPress.WP.AlternativeFunctions.file_get_contents_file_get_contents
-		$contents = json_decode( file_get_contents( $filename ), true );
+		$contents = json_decode(file_get_contents($filename), true);
 
 		// Return false if decoding failed, otherwise the decoded contents.
 		return $contents ? $contents : false;
@@ -134,26 +134,26 @@ 
 	 * @return bool True if the `id` has a cache.
 	 * @since 3.16.0
 	 */
-	public function has_cache( $id ) {
+	public function has_cache($id) {
 
 		// Get the filename.
-		$filename = $this->get_filename( $id );
+		$filename = $this->get_filename($id);
 
 		// Bail out if the file doesn't exist.
-		return file_exists( $filename );
+		return file_exists($filename);
 	}
 
 	/**
 	 * @inheritdoc
 	 */
-	public function set_cache( $id, $contents ) {
+	public function set_cache($id, $contents) {
 
-		$filename = $this->get_filename( $id );
+		$filename = $this->get_filename($id);
 
-		$this->log->trace( "Writing cache contents for $id to $filename..." );
+		$this->log->trace("Writing cache contents for $id to $filename...");
 
 		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged,WordPress.WP.AlternativeFunctions.file_system_read_file_put_contents
-		@file_put_contents( $filename, wp_json_encode( $contents ) );
+		@file_put_contents($filename, wp_json_encode($contents));
 
 	}
 
@@ -164,15 +164,15 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	public function delete_cache( $id ) {
+	public function delete_cache($id) {
 
-		$filename = $this->get_filename( $id );
+		$filename = $this->get_filename($id);
 
-		$this->log->trace( "Deleting cache contents for $id, file $filename..." );
+		$this->log->trace("Deleting cache contents for $id, file $filename...");
 
-		if ( file_exists( $filename ) ) {
+		if (file_exists($filename)) {
 			// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-			@unlink( $filename );
+			@unlink($filename);
 		}
 
 	}
@@ -185,47 +185,47 @@ 
 	public function flush() {
 
 		// Bail out if the cache dir isn't set.
-		if ( empty( $this->cache_dir ) || '/' === $this->cache_dir ) {
+		if (empty($this->cache_dir) || '/' === $this->cache_dir) {
 			return;
 		}
 
-		$this->log->trace( "Flushing cache contents from $this->cache_dir..." );
+		$this->log->trace("Flushing cache contents from $this->cache_dir...");
 
 		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		$handle = @opendir( $this->cache_dir );
+		$handle = @opendir($this->cache_dir);
 
 		// Bail out if the directory can't be opened.
-		if ( false === $handle ) {
+		if (false === $handle) {
 			return;
 		}
 
 		// Calculate the file extension length for matching file names.
-		$file_extension_length = strlen( $this->file_extension );
+		$file_extension_length = strlen($this->file_extension);
 
 		// Loop into the directory to delete files.
-		while ( false !== ( $entry = readdir( $handle ) ) ) { //phpcs:ignore WordPress.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition
-			if ( substr( $entry, - $file_extension_length ) === $this->file_extension
-				 && file_exists( $this->cache_dir . $entry ) ) {
-				$this->log->trace( "Deleting file {$this->cache_dir}{$entry}..." );
+		while (false !== ($entry = readdir($handle))) { //phpcs:ignore WordPress.CodeAnalysis.AssignmentInCondition.FoundInWhileCondition
+			if (substr($entry, - $file_extension_length) === $this->file_extension
+				 && file_exists($this->cache_dir.$entry)) {
+				$this->log->trace("Deleting file {$this->cache_dir}{$entry}...");
 
 				// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-				@unlink( $this->cache_dir . $entry );
+				@unlink($this->cache_dir.$entry);
 			}
 		}
 
 		// Finally closed the directory.
-		closedir( $handle );
+		closedir($handle);
 
 	}
 
 	public static function flush_all() {
 
-		foreach ( self::$instances as $instance ) {
+		foreach (self::$instances as $instance) {
 			$instance->flush();
 		}
 
-		if ( defined( 'DOING_AJAX' ) && DOING_AJAX
-			 && isset( $_REQUEST['action'] ) && 'wl_file_cache__flush_all' === $_REQUEST['action'] ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		if (defined('DOING_AJAX') && DOING_AJAX
+			 && isset($_REQUEST['action']) && 'wl_file_cache__flush_all' === $_REQUEST['action']) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 			wp_send_json_success();
 		}
 
@@ -239,9 +239,9 @@ 
 	 * @return string The filename.
 	 * @since 3.16.0
 	 */
-	private function get_filename( $id ) {
+	private function get_filename($id) {
 
-		return $this->cache_dir . md5( $id ) . $this->file_extension;
+		return $this->cache_dir.md5($id).$this->file_extension;
 	}
 
 }

src/admin/class-wordlift-entity-list-service.php

Indentation +297 added lines, -297 removed lines

@@ -20,308 +20,308 @@
  */
 class Wordlift_Entity_List_Service {
 
-	/**
-	 * Size of the entity thumbnail in pixels
-	 *
-	 * @since  3.3.0
-	 */
-	const THUMB_SIZE = 50;
-
-	/**
-	 * A {@link Wordlift_Rating_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var \Wordlift_Rating_Service $rating_service A {@link Wordlift_Rating_Service} instance.
-	 */
-	private $rating_service;
-
-	/**
-	 * Create a Wordlift_Entity_List_Service.
-	 *
-	 * @param \Wordlift_Rating_Service $rating_service A {@link Wordlift_Rating_Service} instance.
-	 *
-	 * @since 3.3.0
-	 */
-	public function __construct( $rating_service ) {
-
-		$this->rating_service = $rating_service;
-
-	}
-
-	/**
-	 * Detects if the entities list admin screen is being displayed
-	 *
-	 * @return bool True if the screen is being displayed, false otherwis.
-	 *
-	 * @since 3.15.0
-	 */
-	private function is_entity_list_screen() {
-
-		// Run only on admin page.
-		if ( ! is_admin() ) {
-			return false;
-		}
-
-		// Return safely if get_current_screen() is not defined (yet).
-		if ( false === function_exists( 'get_current_screen' ) ) {
-			return false;
-		}
-
-		// Only apply on entity list page, only if this is the main query and if the wl-classification-scope query param is set.
-		$screen = get_current_screen();
-
-		// If there is any valid screen nothing to do.
-		if ( null === $screen ) {
-			return false;
-		}
-
-		if ( Wordlift_Entity_Service::TYPE_NAME !== $screen->post_type ) {
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Register custom columns for entity listing in backend.
-	 *
-	 * @see   https://codex.wordpress.org/Plugin_API/Action_Reference/manage_posts_custom_column
-	 *
-	 * @since 3.3.0
-	 *
-	 * @param array $columns the default columns.
-	 *
-	 * @return array Enhanced columns array.
-	 */
-	public function register_custom_columns( $columns ) {
-
-		// Bail out if custom columns disabled via hook
-		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( ! apply_filters( 'wl_feature__enable__custom-columns', true ) ) {
-			return $columns;
-		}
-
-		// Take away first column and keep a reference,
-		// so we can later insert the thumbnail between the first and the rest of columns.
-		$columns_cb = $columns['cb'];
-		unset( $columns['cb'] );
-
-		// Thumbnails column is inserted in second place, while the related posts on the end.
-		$columns = array_merge(
-			array( 'cb' => $columns_cb ),                      // re-add first column
-			array( 'wl_column_thumbnail' => __( 'Image', 'wordlift' ) ),        // thumb
-			$columns,                                                               // default columns (without the first)
-			array( 'wl_column_related_posts' => __( 'Related Posts', 'wordlift' ) ), // related posts
-			array( 'wl_column_rating' => __( 'Rating', 'wordlift' ) ) // related posts
-		);
-
-		return $columns;
-	}
-
-	/**
-	 * Render custom columns.
-	 *
-	 * @see   https://codex.wordpress.org/Plugin_API/Action_Reference/manage_$post_type_posts_custom_column
-	 *
-	 * @since 3.3.0
-	 *
-	 * @param string $column The current column.
-	 * @param int    $entity_id An entity post id.
-	 */
-	public function render_custom_columns( $column, $entity_id ) {
-
-		switch ( $column ) {
-
-			case 'wl_column_related_posts':
-				echo count( wl_core_get_related_post_ids( $entity_id ) );
-				break;
-
-			case 'wl_column_thumbnail':
-				$edit_link = get_edit_post_link( $entity_id );
-				$thumb     = get_the_post_thumbnail(
-					$entity_id,
-					array(
-						self::THUMB_SIZE,
-						self::THUMB_SIZE,
-					)
-				);
-
-				if ( ! $thumb ) {
-					$thumb = sprintf( '<img src="%s" width="%d">', WL_DEFAULT_THUMBNAIL_PATH, self::THUMB_SIZE );
-				}
-
-				echo wp_kses(
-					sprintf( '<a href="%s">%s</a>', esc_url( $edit_link ), $thumb ),
-					array(
-						'a'   => array( 'href' => array() ),
-						'img' => array(
-							'src'   => array(),
-							'width' => array(),
-						),
-					)
-				);
-				break;
-
-			case 'wl_column_rating':
-				$rating = $this->rating_service->get_rating_for( $entity_id );
-				echo '<i class="wl-traffic-light wl-tl-' . esc_attr( $rating['traffic_light_score'] ) . '">' . esc_html( $rating['percentage_score'] ) . '%</i>';
-				break;
-		}
-
-	}
-
-	/**
-	 * Add wl-classification-scope select box before the 'Filter' button.
-	 *
-	 * @since 3.3.0
-	 */
-	public function restrict_manage_posts_classification_scope() {
-
-		if ( ! $this->is_entity_list_screen() ) {
-			return;
-		}
-
-		// Was a W already selected?
-		$selected = isset( $_GET['wl-classification-scope'] ) ? //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-			sanitize_text_field( wp_unslash( (string) $_GET['wl-classification-scope'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-
-		// Print select box with the 4W
-		$all_w = array(
-			"All 'W'"         => __( "All 'W'", 'wordlift' ),
-			WL_WHAT_RELATION  => __( 'What', 'wordlift' ),
-			WL_WHO_RELATION   => __( 'Who', 'wordlift' ),
-			WL_WHERE_RELATION => __( 'Where', 'wordlift' ),
-			WL_WHEN_RELATION  => __( 'When', 'wordlift' ),
-		);
-		echo '<select name="wl-classification-scope" id="wl-dropdown-classification-scope">';
-		foreach ( $all_w as $v => $w ) {
-			$default = ( $selected === $v ) ? 'selected' : '';
-			echo sprintf( '<option value="%s" %s >%s</option>', esc_attr( $v ), esc_html( $default ), esc_html( $w ) );
-		}
-		echo '</select>';
-	}
-
-	/**
-	 * Server side response operations for the classification filter set in
-	 * *restrict_manage_posts_classification_scope_filter*.
-	 *
-	 * @param array $clauses WP main query clauses.
-	 *
-	 * @return array Modified clauses.
-	 * @since 3.3.0
-	 */
-	public function posts_clauses_classification_scope( $clauses ) {
-
-		if ( ! ( $this->is_entity_list_screen() && is_main_query() && isset( $_GET['wl-classification-scope'] ) ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-			return $clauses;
-		}
-
-		// Check a valid W was requested.
-		$requested_w = sanitize_text_field( wp_unslash( (string) $_GET['wl-classification-scope'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-
-		$all_w = array(
-			WL_WHAT_RELATION,
-			WL_WHO_RELATION,
-			WL_WHERE_RELATION,
-			WL_WHEN_RELATION,
-		);
-
-		if ( ! in_array( $requested_w, $all_w, true ) ) {
-			return $clauses;
-		}
-
-		global $wpdb;
-
-		// Change WP main query clauses.
-		$clauses['join']     .= "INNER JOIN {$wpdb->prefix}wl_relation_instances ON {$wpdb->posts}.ID = {$wpdb->prefix}wl_relation_instances.object_id";
-		$clauses['where']    .= $wpdb->prepare( "AND {$wpdb->prefix}wl_relation_instances.predicate = %s", $requested_w );
-		$clauses['distinct'] .= 'DISTINCT';
-
-		return $clauses;
-	}
-
-	/**
-	 * Amend the "all entities" list admin screen with entities from other
-	 * post types, not only the entities one.
-	 *
-	 * @param WP_Query $query The WP_Query instance (passed by reference).
-	 *
-	 * @since 3.15.0
-	 */
-	public function pre_get_posts( $query ) {
-
-		if ( ! ( $this->is_entity_list_screen() && $query->is_main_query() ) ) {
-			return;
-		}
-
-		// Add to the post type all the types considered to be valid post types.
-		$query->set( 'post_type', Wordlift_Entity_Service::valid_entity_post_types() );
-
-		// Do not show however entities of type `Article`.
-		$query->set(
-			'tax_query',
-			array(
-				'relation' => 'AND',
-				array(
-					'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-					'operator' => 'EXISTS',
-				),
-				array(
-					'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-					'field'    => 'slug',
-					'terms'    => 'article',
-					'operator' => 'NOT IN',
-				),
-			)
-		);
-
-	}
-
-	/**
-	 * An hack to fix wrong post type on the entities list admin screen.
-	 *
-	 * This is hooked on the admin entity list page load hook and sets the
-	 * post type to "entity" as it is expected on that page.
-	 *
-	 * @since 3.15.0
-	 */
-	public function load_edit() {
-
-		// Return safely if get_current_screen() is not defined (yet).
-		if ( false === function_exists( 'get_current_screen' ) ) {
-			return;
-		}
-
-		// Only apply on entity list page, only if this is the main query and if the wl-classification-scope query param is set.
-		$screen = get_current_screen();
-
-		// If there is any valid screen nothing to do.
-		if ( null === $screen ) {
-			return;
-		}
-
-		if ( ! ( Wordlift_Entity_Service::TYPE_NAME === $screen->post_type && is_main_query() ) ) {
-			return;
-		}
-
-		/*
+    /**
+     * Size of the entity thumbnail in pixels
+     *
+     * @since  3.3.0
+     */
+    const THUMB_SIZE = 50;
+
+    /**
+     * A {@link Wordlift_Rating_Service} instance.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var \Wordlift_Rating_Service $rating_service A {@link Wordlift_Rating_Service} instance.
+     */
+    private $rating_service;
+
+    /**
+     * Create a Wordlift_Entity_List_Service.
+     *
+     * @param \Wordlift_Rating_Service $rating_service A {@link Wordlift_Rating_Service} instance.
+     *
+     * @since 3.3.0
+     */
+    public function __construct( $rating_service ) {
+
+        $this->rating_service = $rating_service;
+
+    }
+
+    /**
+     * Detects if the entities list admin screen is being displayed
+     *
+     * @return bool True if the screen is being displayed, false otherwis.
+     *
+     * @since 3.15.0
+     */
+    private function is_entity_list_screen() {
+
+        // Run only on admin page.
+        if ( ! is_admin() ) {
+            return false;
+        }
+
+        // Return safely if get_current_screen() is not defined (yet).
+        if ( false === function_exists( 'get_current_screen' ) ) {
+            return false;
+        }
+
+        // Only apply on entity list page, only if this is the main query and if the wl-classification-scope query param is set.
+        $screen = get_current_screen();
+
+        // If there is any valid screen nothing to do.
+        if ( null === $screen ) {
+            return false;
+        }
+
+        if ( Wordlift_Entity_Service::TYPE_NAME !== $screen->post_type ) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Register custom columns for entity listing in backend.
+     *
+     * @see   https://codex.wordpress.org/Plugin_API/Action_Reference/manage_posts_custom_column
+     *
+     * @since 3.3.0
+     *
+     * @param array $columns the default columns.
+     *
+     * @return array Enhanced columns array.
+     */
+    public function register_custom_columns( $columns ) {
+
+        // Bail out if custom columns disabled via hook
+        // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+        if ( ! apply_filters( 'wl_feature__enable__custom-columns', true ) ) {
+            return $columns;
+        }
+
+        // Take away first column and keep a reference,
+        // so we can later insert the thumbnail between the first and the rest of columns.
+        $columns_cb = $columns['cb'];
+        unset( $columns['cb'] );
+
+        // Thumbnails column is inserted in second place, while the related posts on the end.
+        $columns = array_merge(
+            array( 'cb' => $columns_cb ),                      // re-add first column
+            array( 'wl_column_thumbnail' => __( 'Image', 'wordlift' ) ),        // thumb
+            $columns,                                                               // default columns (without the first)
+            array( 'wl_column_related_posts' => __( 'Related Posts', 'wordlift' ) ), // related posts
+            array( 'wl_column_rating' => __( 'Rating', 'wordlift' ) ) // related posts
+        );
+
+        return $columns;
+    }
+
+    /**
+     * Render custom columns.
+     *
+     * @see   https://codex.wordpress.org/Plugin_API/Action_Reference/manage_$post_type_posts_custom_column
+     *
+     * @since 3.3.0
+     *
+     * @param string $column The current column.
+     * @param int    $entity_id An entity post id.
+     */
+    public function render_custom_columns( $column, $entity_id ) {
+
+        switch ( $column ) {
+
+            case 'wl_column_related_posts':
+                echo count( wl_core_get_related_post_ids( $entity_id ) );
+                break;
+
+            case 'wl_column_thumbnail':
+                $edit_link = get_edit_post_link( $entity_id );
+                $thumb     = get_the_post_thumbnail(
+                    $entity_id,
+                    array(
+                        self::THUMB_SIZE,
+                        self::THUMB_SIZE,
+                    )
+                );
+
+                if ( ! $thumb ) {
+                    $thumb = sprintf( '<img src="%s" width="%d">', WL_DEFAULT_THUMBNAIL_PATH, self::THUMB_SIZE );
+                }
+
+                echo wp_kses(
+                    sprintf( '<a href="%s">%s</a>', esc_url( $edit_link ), $thumb ),
+                    array(
+                        'a'   => array( 'href' => array() ),
+                        'img' => array(
+                            'src'   => array(),
+                            'width' => array(),
+                        ),
+                    )
+                );
+                break;
+
+            case 'wl_column_rating':
+                $rating = $this->rating_service->get_rating_for( $entity_id );
+                echo '<i class="wl-traffic-light wl-tl-' . esc_attr( $rating['traffic_light_score'] ) . '">' . esc_html( $rating['percentage_score'] ) . '%</i>';
+                break;
+        }
+
+    }
+
+    /**
+     * Add wl-classification-scope select box before the 'Filter' button.
+     *
+     * @since 3.3.0
+     */
+    public function restrict_manage_posts_classification_scope() {
+
+        if ( ! $this->is_entity_list_screen() ) {
+            return;
+        }
+
+        // Was a W already selected?
+        $selected = isset( $_GET['wl-classification-scope'] ) ? //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+            sanitize_text_field( wp_unslash( (string) $_GET['wl-classification-scope'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+
+        // Print select box with the 4W
+        $all_w = array(
+            "All 'W'"         => __( "All 'W'", 'wordlift' ),
+            WL_WHAT_RELATION  => __( 'What', 'wordlift' ),
+            WL_WHO_RELATION   => __( 'Who', 'wordlift' ),
+            WL_WHERE_RELATION => __( 'Where', 'wordlift' ),
+            WL_WHEN_RELATION  => __( 'When', 'wordlift' ),
+        );
+        echo '<select name="wl-classification-scope" id="wl-dropdown-classification-scope">';
+        foreach ( $all_w as $v => $w ) {
+            $default = ( $selected === $v ) ? 'selected' : '';
+            echo sprintf( '<option value="%s" %s >%s</option>', esc_attr( $v ), esc_html( $default ), esc_html( $w ) );
+        }
+        echo '</select>';
+    }
+
+    /**
+     * Server side response operations for the classification filter set in
+     * *restrict_manage_posts_classification_scope_filter*.
+     *
+     * @param array $clauses WP main query clauses.
+     *
+     * @return array Modified clauses.
+     * @since 3.3.0
+     */
+    public function posts_clauses_classification_scope( $clauses ) {
+
+        if ( ! ( $this->is_entity_list_screen() && is_main_query() && isset( $_GET['wl-classification-scope'] ) ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+            return $clauses;
+        }
+
+        // Check a valid W was requested.
+        $requested_w = sanitize_text_field( wp_unslash( (string) $_GET['wl-classification-scope'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+
+        $all_w = array(
+            WL_WHAT_RELATION,
+            WL_WHO_RELATION,
+            WL_WHERE_RELATION,
+            WL_WHEN_RELATION,
+        );
+
+        if ( ! in_array( $requested_w, $all_w, true ) ) {
+            return $clauses;
+        }
+
+        global $wpdb;
+
+        // Change WP main query clauses.
+        $clauses['join']     .= "INNER JOIN {$wpdb->prefix}wl_relation_instances ON {$wpdb->posts}.ID = {$wpdb->prefix}wl_relation_instances.object_id";
+        $clauses['where']    .= $wpdb->prepare( "AND {$wpdb->prefix}wl_relation_instances.predicate = %s", $requested_w );
+        $clauses['distinct'] .= 'DISTINCT';
+
+        return $clauses;
+    }
+
+    /**
+     * Amend the "all entities" list admin screen with entities from other
+     * post types, not only the entities one.
+     *
+     * @param WP_Query $query The WP_Query instance (passed by reference).
+     *
+     * @since 3.15.0
+     */
+    public function pre_get_posts( $query ) {
+
+        if ( ! ( $this->is_entity_list_screen() && $query->is_main_query() ) ) {
+            return;
+        }
+
+        // Add to the post type all the types considered to be valid post types.
+        $query->set( 'post_type', Wordlift_Entity_Service::valid_entity_post_types() );
+
+        // Do not show however entities of type `Article`.
+        $query->set(
+            'tax_query',
+            array(
+                'relation' => 'AND',
+                array(
+                    'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                    'operator' => 'EXISTS',
+                ),
+                array(
+                    'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                    'field'    => 'slug',
+                    'terms'    => 'article',
+                    'operator' => 'NOT IN',
+                ),
+            )
+        );
+
+    }
+
+    /**
+     * An hack to fix wrong post type on the entities list admin screen.
+     *
+     * This is hooked on the admin entity list page load hook and sets the
+     * post type to "entity" as it is expected on that page.
+     *
+     * @since 3.15.0
+     */
+    public function load_edit() {
+
+        // Return safely if get_current_screen() is not defined (yet).
+        if ( false === function_exists( 'get_current_screen' ) ) {
+            return;
+        }
+
+        // Only apply on entity list page, only if this is the main query and if the wl-classification-scope query param is set.
+        $screen = get_current_screen();
+
+        // If there is any valid screen nothing to do.
+        if ( null === $screen ) {
+            return;
+        }
+
+        if ( ! ( Wordlift_Entity_Service::TYPE_NAME === $screen->post_type && is_main_query() ) ) {
+            return;
+        }
+
+        /*
 		 * The main wp initialization sets the post type to the post type used in the main query,
 		 * but the admin edit pages fail to handle such a situation gracefully.
 		 * Since this is exactly what we do on the entity page, we have to reset
 		 * the global $post_type variable to the "entity" value after the modifications
 		 * initialization was finished.
 		 */
-		add_action(
-			'wp',
-			function () {
-				global $post_type;
-				$post_type = Wordlift_Entity_Service::TYPE_NAME; //phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
-			},
-			10,
-			0
-		);
-
-	}
+        add_action(
+            'wp',
+            function () {
+                global $post_type;
+                $post_type = Wordlift_Entity_Service::TYPE_NAME; //phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
+            },
+            10,
+            0
+        );
+
+    }
 
 }

Spacing +46 added lines, -46 removed lines

@@ -43,7 +43,7 @@ 
 	 *
 	 * @since 3.3.0
 	 */
-	public function __construct( $rating_service ) {
+	public function __construct($rating_service) {
 
 		$this->rating_service = $rating_service;
 
@@ -59,12 +59,12 @@ 
 	private function is_entity_list_screen() {
 
 		// Run only on admin page.
-		if ( ! is_admin() ) {
+		if ( ! is_admin()) {
 			return false;
 		}
 
 		// Return safely if get_current_screen() is not defined (yet).
-		if ( false === function_exists( 'get_current_screen' ) ) {
+		if (false === function_exists('get_current_screen')) {
 			return false;
 		}
 
@@ -72,11 +72,11 @@ 
 		$screen = get_current_screen();
 
 		// If there is any valid screen nothing to do.
-		if ( null === $screen ) {
+		if (null === $screen) {
 			return false;
 		}
 
-		if ( Wordlift_Entity_Service::TYPE_NAME !== $screen->post_type ) {
+		if (Wordlift_Entity_Service::TYPE_NAME !== $screen->post_type) {
 			return false;
 		}
 
@@ -94,26 +94,26 @@ 
 	 *
 	 * @return array Enhanced columns array.
 	 */
-	public function register_custom_columns( $columns ) {
+	public function register_custom_columns($columns) {
 
 		// Bail out if custom columns disabled via hook
 		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( ! apply_filters( 'wl_feature__enable__custom-columns', true ) ) {
+		if ( ! apply_filters('wl_feature__enable__custom-columns', true)) {
 			return $columns;
 		}
 
 		// Take away first column and keep a reference,
 		// so we can later insert the thumbnail between the first and the rest of columns.
 		$columns_cb = $columns['cb'];
-		unset( $columns['cb'] );
+		unset($columns['cb']);
 
 		// Thumbnails column is inserted in second place, while the related posts on the end.
 		$columns = array_merge(
-			array( 'cb' => $columns_cb ),                      // re-add first column
-			array( 'wl_column_thumbnail' => __( 'Image', 'wordlift' ) ),        // thumb
-			$columns,                                                               // default columns (without the first)
-			array( 'wl_column_related_posts' => __( 'Related Posts', 'wordlift' ) ), // related posts
-			array( 'wl_column_rating' => __( 'Rating', 'wordlift' ) ) // related posts
+			array('cb' => $columns_cb), // re-add first column
+			array('wl_column_thumbnail' => __('Image', 'wordlift')), // thumb
+			$columns, // default columns (without the first)
+			array('wl_column_related_posts' => __('Related Posts', 'wordlift')), // related posts
+			array('wl_column_rating' => __('Rating', 'wordlift')) // related posts
 		);
 
 		return $columns;
@@ -129,16 +129,16 @@ 
 	 * @param string $column The current column.
 	 * @param int    $entity_id An entity post id.
 	 */
-	public function render_custom_columns( $column, $entity_id ) {
+	public function render_custom_columns($column, $entity_id) {
 
-		switch ( $column ) {
+		switch ($column) {
 
 			case 'wl_column_related_posts':
-				echo count( wl_core_get_related_post_ids( $entity_id ) );
+				echo count(wl_core_get_related_post_ids($entity_id));
 				break;
 
 			case 'wl_column_thumbnail':
-				$edit_link = get_edit_post_link( $entity_id );
+				$edit_link = get_edit_post_link($entity_id);
 				$thumb     = get_the_post_thumbnail(
 					$entity_id,
 					array(
@@ -147,14 +147,14 @@ 
 					)
 				);
 
-				if ( ! $thumb ) {
-					$thumb = sprintf( '<img src="%s" width="%d">', WL_DEFAULT_THUMBNAIL_PATH, self::THUMB_SIZE );
+				if ( ! $thumb) {
+					$thumb = sprintf('<img src="%s" width="%d">', WL_DEFAULT_THUMBNAIL_PATH, self::THUMB_SIZE);
 				}
 
 				echo wp_kses(
-					sprintf( '<a href="%s">%s</a>', esc_url( $edit_link ), $thumb ),
+					sprintf('<a href="%s">%s</a>', esc_url($edit_link), $thumb),
 					array(
-						'a'   => array( 'href' => array() ),
+						'a'   => array('href' => array()),
 						'img' => array(
 							'src'   => array(),
 							'width' => array(),
@@ -164,8 +164,8 @@ 
 				break;
 
 			case 'wl_column_rating':
-				$rating = $this->rating_service->get_rating_for( $entity_id );
-				echo '<i class="wl-traffic-light wl-tl-' . esc_attr( $rating['traffic_light_score'] ) . '">' . esc_html( $rating['percentage_score'] ) . '%</i>';
+				$rating = $this->rating_service->get_rating_for($entity_id);
+				echo '<i class="wl-traffic-light wl-tl-'.esc_attr($rating['traffic_light_score']).'">'.esc_html($rating['percentage_score']).'%</i>';
 				break;
 		}
 
@@ -178,26 +178,26 @@ 
 	 */
 	public function restrict_manage_posts_classification_scope() {
 
-		if ( ! $this->is_entity_list_screen() ) {
+		if ( ! $this->is_entity_list_screen()) {
 			return;
 		}
 
 		// Was a W already selected?
-		$selected = isset( $_GET['wl-classification-scope'] ) ? //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-			sanitize_text_field( wp_unslash( (string) $_GET['wl-classification-scope'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		$selected = isset($_GET['wl-classification-scope']) ? //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+			sanitize_text_field(wp_unslash((string) $_GET['wl-classification-scope'])) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 
 		// Print select box with the 4W
 		$all_w = array(
-			"All 'W'"         => __( "All 'W'", 'wordlift' ),
-			WL_WHAT_RELATION  => __( 'What', 'wordlift' ),
-			WL_WHO_RELATION   => __( 'Who', 'wordlift' ),
-			WL_WHERE_RELATION => __( 'Where', 'wordlift' ),
-			WL_WHEN_RELATION  => __( 'When', 'wordlift' ),
+			"All 'W'"         => __("All 'W'", 'wordlift'),
+			WL_WHAT_RELATION  => __('What', 'wordlift'),
+			WL_WHO_RELATION   => __('Who', 'wordlift'),
+			WL_WHERE_RELATION => __('Where', 'wordlift'),
+			WL_WHEN_RELATION  => __('When', 'wordlift'),
 		);
 		echo '<select name="wl-classification-scope" id="wl-dropdown-classification-scope">';
-		foreach ( $all_w as $v => $w ) {
-			$default = ( $selected === $v ) ? 'selected' : '';
-			echo sprintf( '<option value="%s" %s >%s</option>', esc_attr( $v ), esc_html( $default ), esc_html( $w ) );
+		foreach ($all_w as $v => $w) {
+			$default = ($selected === $v) ? 'selected' : '';
+			echo sprintf('<option value="%s" %s >%s</option>', esc_attr($v), esc_html($default), esc_html($w));
 		}
 		echo '</select>';
 	}
@@ -211,14 +211,14 @@ 
 	 * @return array Modified clauses.
 	 * @since 3.3.0
 	 */
-	public function posts_clauses_classification_scope( $clauses ) {
+	public function posts_clauses_classification_scope($clauses) {
 
-		if ( ! ( $this->is_entity_list_screen() && is_main_query() && isset( $_GET['wl-classification-scope'] ) ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		if ( ! ($this->is_entity_list_screen() && is_main_query() && isset($_GET['wl-classification-scope']))) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 			return $clauses;
 		}
 
 		// Check a valid W was requested.
-		$requested_w = sanitize_text_field( wp_unslash( (string) $_GET['wl-classification-scope'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		$requested_w = sanitize_text_field(wp_unslash((string) $_GET['wl-classification-scope'])); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 
 		$all_w = array(
 			WL_WHAT_RELATION,
@@ -227,7 +227,7 @@ 
 			WL_WHEN_RELATION,
 		);
 
-		if ( ! in_array( $requested_w, $all_w, true ) ) {
+		if ( ! in_array($requested_w, $all_w, true)) {
 			return $clauses;
 		}
 
@@ -235,7 +235,7 @@ 
 
 		// Change WP main query clauses.
 		$clauses['join']     .= "INNER JOIN {$wpdb->prefix}wl_relation_instances ON {$wpdb->posts}.ID = {$wpdb->prefix}wl_relation_instances.object_id";
-		$clauses['where']    .= $wpdb->prepare( "AND {$wpdb->prefix}wl_relation_instances.predicate = %s", $requested_w );
+		$clauses['where']    .= $wpdb->prepare("AND {$wpdb->prefix}wl_relation_instances.predicate = %s", $requested_w);
 		$clauses['distinct'] .= 'DISTINCT';
 
 		return $clauses;
@@ -249,14 +249,14 @@ 
 	 *
 	 * @since 3.15.0
 	 */
-	public function pre_get_posts( $query ) {
+	public function pre_get_posts($query) {
 
-		if ( ! ( $this->is_entity_list_screen() && $query->is_main_query() ) ) {
+		if ( ! ($this->is_entity_list_screen() && $query->is_main_query())) {
 			return;
 		}
 
 		// Add to the post type all the types considered to be valid post types.
-		$query->set( 'post_type', Wordlift_Entity_Service::valid_entity_post_types() );
+		$query->set('post_type', Wordlift_Entity_Service::valid_entity_post_types());
 
 		// Do not show however entities of type `Article`.
 		$query->set(
@@ -289,7 +289,7 @@ 
 	public function load_edit() {
 
 		// Return safely if get_current_screen() is not defined (yet).
-		if ( false === function_exists( 'get_current_screen' ) ) {
+		if (false === function_exists('get_current_screen')) {
 			return;
 		}
 
@@ -297,11 +297,11 @@ 
 		$screen = get_current_screen();
 
 		// If there is any valid screen nothing to do.
-		if ( null === $screen ) {
+		if (null === $screen) {
 			return;
 		}
 
-		if ( ! ( Wordlift_Entity_Service::TYPE_NAME === $screen->post_type && is_main_query() ) ) {
+		if ( ! (Wordlift_Entity_Service::TYPE_NAME === $screen->post_type && is_main_query())) {
 			return;
 		}
 
@@ -314,7 +314,7 @@ 
 		 */
 		add_action(
 			'wp',
-			function () {
+			function() {
 				global $post_type;
 				$post_type = Wordlift_Entity_Service::TYPE_NAME; //phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
 			},

src/admin/class-wordlift-admin-entity-type-settings.php

Indentation +201 added lines, -201 removed lines

@@ -13,7 +13,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -30,217 +30,217 @@ 
  */
 class Wordlift_Admin_Entity_Type_Settings {
 
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.14.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * Create a {@link Wordlift_Admin_Entity_Type_Settings} instance.
-	 *
-	 * @since 3.14.0
-	 */
-	public function __construct() {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Admin_Entity_Type_Settings' );
-
-	}
-
-	/**
-	 * Handle menu registration.
-	 *
-	 * The registration is required, although we do not want to actually to add
-	 * an item to the menu, in order to "whitelist" the access to the settings page in
-	 * the admin.
-	 *
-	 * @since 3.11.0
-	 */
-	public function admin_menu() {
-
-		/*
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.14.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * Create a {@link Wordlift_Admin_Entity_Type_Settings} instance.
+     *
+     * @since 3.14.0
+     */
+    public function __construct() {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Admin_Entity_Type_Settings' );
+
+    }
+
+    /**
+     * Handle menu registration.
+     *
+     * The registration is required, although we do not want to actually to add
+     * an item to the menu, in order to "whitelist" the access to the settings page in
+     * the admin.
+     *
+     * @since 3.11.0
+     */
+    public function admin_menu() {
+
+        /*
 		 * Before anything else check if an settings form was submitted.
 		 * This has to be done before any output happens in order to be able to
 		 * display proper "die" error messages and redirect.
 		 */
-		if ( isset( $_GET['page'] ) && ( 'wl_entity_type_settings' === $_GET['page'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-
-			// Validate inputs. Do not return on invalid parameters or capabilities.
-			$this->validate_proper_term();
-
-			// If proper form submission, handle it and redirect back to the settings page.
-			if ( isset( $_POST['action'] ) && ( 'wl_edit_entity_type_term' === $_POST['action'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Missing
-				$this->handle_form_submission();
-			}
-			/**
-			 * Filter: wl_feature__enable__notices.
-			 *
-			 * @param bool whether the notices needs to be enabled or not.
-			 *
-			 * @return bool
-			 * @since 3.27.6
-			 */
-			if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
-				// Register admin notices handler.
-				add_action( 'admin_notices', array( $this, 'admin_notice' ) );
-			}
-		}
-
-		/*
+        if ( isset( $_GET['page'] ) && ( 'wl_entity_type_settings' === $_GET['page'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+
+            // Validate inputs. Do not return on invalid parameters or capabilities.
+            $this->validate_proper_term();
+
+            // If proper form submission, handle it and redirect back to the settings page.
+            if ( isset( $_POST['action'] ) && ( 'wl_edit_entity_type_term' === $_POST['action'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Missing
+                $this->handle_form_submission();
+            }
+            /**
+             * Filter: wl_feature__enable__notices.
+             *
+             * @param bool whether the notices needs to be enabled or not.
+             *
+             * @return bool
+             * @since 3.27.6
+             */
+            if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
+                // Register admin notices handler.
+                add_action( 'admin_notices', array( $this, 'admin_notice' ) );
+            }
+        }
+
+        /*
 		 * Use a null parent slug to prevent the menu from actually appearing
 		 * in the admin menu.
 		 */
-		// @todo: use the new {@link Wordlift_Admin_Page}.
-		add_submenu_page(
-			null,
-			__( 'Edit Entity term', 'wordlift' ),
-			__( 'Edit Entity term', 'wordlift' ),
-			'manage_options',
-			'wl_entity_type_settings',
-			array( $this, 'render' )
-		);
-	}
-
-	/**
-	 * Output admin notices if needed, based on the message url parameter.
-	 * A value of 1 indicates that a successful save was done.
-	 *
-	 * @since 3.11.0
-	 */
-	public function admin_notice() {
-		if ( isset( $_GET['message'] ) && ( '1' === $_GET['message'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-			?>
+        // @todo: use the new {@link Wordlift_Admin_Page}.
+        add_submenu_page(
+            null,
+            __( 'Edit Entity term', 'wordlift' ),
+            __( 'Edit Entity term', 'wordlift' ),
+            'manage_options',
+            'wl_entity_type_settings',
+            array( $this, 'render' )
+        );
+    }
+
+    /**
+     * Output admin notices if needed, based on the message url parameter.
+     * A value of 1 indicates that a successful save was done.
+     *
+     * @since 3.11.0
+     */
+    public function admin_notice() {
+        if ( isset( $_GET['message'] ) && ( '1' === $_GET['message'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+            ?>
 			<div class="notice notice-success is-dismissible">
 				<p><?php esc_html_e( 'Settings saved', 'wordlift' ); ?></p>
 			</div>
 			<?php
-		}
-	}
-
-	/**
-	 * Validate the existence of the entity type indicated by the tag_ID url
-	 * parameter before doing any processing. Done before any output to mimic
-	 * the way WordPress handles same situation with "normal" term editing screens.
-	 *
-	 * @since 3.11.0
-	 */
-	public function validate_proper_term() {
-
-		// Validate capabilities.
-		if ( ! current_user_can( 'manage_options' ) ) {
-			wp_die(
-				'<h1>' . esc_html__( 'Cheatin&#8217; uh?', 'default' ) . '</h1>' .
-				'<p>' . esc_html__( 'Sorry, you are not allowed to edit this item.', 'default' ) . '</p>',
-				403
-			);
-		}
-
-		// Get the term id and the actual term.
-		$term_id = isset( $_REQUEST['tag_ID'] ) ? (int) $_REQUEST['tag_ID'] : 0; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-
-		if ( ! term_exists( $term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME ) ) {
-			wp_die( esc_html__( 'You attempted to edit an entity type term that doesn&#8217;t exist.', 'wordlift' ) );
-		}
-
-	}
-
-	/**
-	 * Handle the form submission of the settings form. On successful
-	 * handling redirect tp the setting edit page.
-	 *
-	 * @since 3.11.0
-	 */
-	public function handle_form_submission() {
-
-		$term_id = isset( $_POST['tag_ID'] ) ? (int) $_POST['tag_ID'] : 0;
-
-		// Check the nonce.
-		check_admin_referer( 'update-entity_type_term_' . $term_id );
-
-		$term = get_term( $term_id, 'wl_entity_type' );
-
-		$title       = isset( $_POST['title'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['title'] ) ) : '';
-		$description = isset( $_POST['description'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['description'] ) ) : '';
-		$this->set_setting(
-			$term_id,
-			trim( wp_unslash( $title ) ),
-			wp_unslash( $description )
-		);
-
-		// Redirect back to the term settings page and indicate a save was done.
-		$url = admin_url( "admin.php?page=wl_entity_type_settings&tag_ID=$term->term_id&message=1" );
-
-		wp_safe_redirect( $url );
-		exit();
-
-	}
-
-	/**
-	 * Render the settings page for the term.
-	 *
-	 * Access and parameter validity is assumed to be done earlier.
-	 *
-	 * @since 3.11.0
-	 */
-	public function render() {
-
-		// Set variables used by the partial
-		$term_id = isset( $_REQUEST['tag_ID'] ) ? absint( $_REQUEST['tag_ID'] ) : 0;  // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        }
+    }
+
+    /**
+     * Validate the existence of the entity type indicated by the tag_ID url
+     * parameter before doing any processing. Done before any output to mimic
+     * the way WordPress handles same situation with "normal" term editing screens.
+     *
+     * @since 3.11.0
+     */
+    public function validate_proper_term() {
+
+        // Validate capabilities.
+        if ( ! current_user_can( 'manage_options' ) ) {
+            wp_die(
+                '<h1>' . esc_html__( 'Cheatin&#8217; uh?', 'default' ) . '</h1>' .
+                '<p>' . esc_html__( 'Sorry, you are not allowed to edit this item.', 'default' ) . '</p>',
+                403
+            );
+        }
+
+        // Get the term id and the actual term.
+        $term_id = isset( $_REQUEST['tag_ID'] ) ? (int) $_REQUEST['tag_ID'] : 0; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+
+        if ( ! term_exists( $term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME ) ) {
+            wp_die( esc_html__( 'You attempted to edit an entity type term that doesn&#8217;t exist.', 'wordlift' ) );
+        }
+
+    }
+
+    /**
+     * Handle the form submission of the settings form. On successful
+     * handling redirect tp the setting edit page.
+     *
+     * @since 3.11.0
+     */
+    public function handle_form_submission() {
+
+        $term_id = isset( $_POST['tag_ID'] ) ? (int) $_POST['tag_ID'] : 0;
+
+        // Check the nonce.
+        check_admin_referer( 'update-entity_type_term_' . $term_id );
+
+        $term = get_term( $term_id, 'wl_entity_type' );
+
+        $title       = isset( $_POST['title'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['title'] ) ) : '';
+        $description = isset( $_POST['description'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['description'] ) ) : '';
+        $this->set_setting(
+            $term_id,
+            trim( wp_unslash( $title ) ),
+            wp_unslash( $description )
+        );
+
+        // Redirect back to the term settings page and indicate a save was done.
+        $url = admin_url( "admin.php?page=wl_entity_type_settings&tag_ID=$term->term_id&message=1" );
+
+        wp_safe_redirect( $url );
+        exit();
+
+    }
+
+    /**
+     * Render the settings page for the term.
+     *
+     * Access and parameter validity is assumed to be done earlier.
+     *
+     * @since 3.11.0
+     */
+    public function render() {
+
+        // Set variables used by the partial
+        $term_id = isset( $_REQUEST['tag_ID'] ) ? absint( $_REQUEST['tag_ID'] ) : 0;  // phpcs:ignore WordPress.Security.NonceVerification.Recommended
         // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		$settings = $this->get_setting( $term_id );
-
-		include plugin_dir_path( __DIR__ ) . 'admin/partials/wordlift-admin-entity-type-settings.php';
-
-	}
-
-	/**
-	 * Store the entity type term settings in the DB
-	 *
-	 * @param integer $term_id The ID of the entity type term
-	 * @param string  $title The override for the terms title.
-	 * @param string  $description The override for the terms description.
-	 *
-	 * @since 3.11.0
-	 */
-	public function set_setting( $term_id, $title, $description ) {
-
-		$settings             = get_option( 'wl_entity_type_settings', array() );
-		$settings[ $term_id ] = array(
-			'title'       => $title,
-			'description' => $description,
-		);
-		update_option( 'wl_entity_type_settings', $settings );
-
-	}
-
-	/**
-	 * Retrieve the entity type term settings from the DB
-	 *
-	 * @param integer $term_id The ID of the entity type term
-	 *
-	 * @return    null|array {
-	 *                null is returned when there are no settings otherwise
-	 *                an array is returned with following fields
-	 *
-	 * @type    string    title    The overriding title for the term
-	 * @type    string    description    The overriding description for the term
-	 *            }
-	 * @since 3.11.0
-	 */
-	public function get_setting( $term_id ) {
-
-		$settings = get_option( 'wl_entity_type_settings', array() );
-
-		if ( isset( $settings[ $term_id ] ) ) {
-			return $settings[ $term_id ];
-		}
-
-		$this->log->warn( "No settings found for term id $term_id." );
-
-		return null;
-	}
+        $settings = $this->get_setting( $term_id );
+
+        include plugin_dir_path( __DIR__ ) . 'admin/partials/wordlift-admin-entity-type-settings.php';
+
+    }
+
+    /**
+     * Store the entity type term settings in the DB
+     *
+     * @param integer $term_id The ID of the entity type term
+     * @param string  $title The override for the terms title.
+     * @param string  $description The override for the terms description.
+     *
+     * @since 3.11.0
+     */
+    public function set_setting( $term_id, $title, $description ) {
+
+        $settings             = get_option( 'wl_entity_type_settings', array() );
+        $settings[ $term_id ] = array(
+            'title'       => $title,
+            'description' => $description,
+        );
+        update_option( 'wl_entity_type_settings', $settings );
+
+    }
+
+    /**
+     * Retrieve the entity type term settings from the DB
+     *
+     * @param integer $term_id The ID of the entity type term
+     *
+     * @return    null|array {
+     *                null is returned when there are no settings otherwise
+     *                an array is returned with following fields
+     *
+     * @type    string    title    The overriding title for the term
+     * @type    string    description    The overriding description for the term
+     *            }
+     * @since 3.11.0
+     */
+    public function get_setting( $term_id ) {
+
+        $settings = get_option( 'wl_entity_type_settings', array() );
+
+        if ( isset( $settings[ $term_id ] ) ) {
+            return $settings[ $term_id ];
+        }
+
+        $this->log->warn( "No settings found for term id $term_id." );
+
+        return null;
+    }
 
 }

Spacing +38 added lines, -38 removed lines

@@ -12,7 +12,7 @@ 
  * @since      3.11.0
  */
 
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 
@@ -46,7 +46,7 @@ 
 	 */
 	public function __construct() {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Admin_Entity_Type_Settings' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Admin_Entity_Type_Settings');
 
 	}
 
@@ -66,13 +66,13 @@ 
 		 * This has to be done before any output happens in order to be able to
 		 * display proper "die" error messages and redirect.
 		 */
-		if ( isset( $_GET['page'] ) && ( 'wl_entity_type_settings' === $_GET['page'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		if (isset($_GET['page']) && ('wl_entity_type_settings' === $_GET['page'])) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 
 			// Validate inputs. Do not return on invalid parameters or capabilities.
 			$this->validate_proper_term();
 
 			// If proper form submission, handle it and redirect back to the settings page.
-			if ( isset( $_POST['action'] ) && ( 'wl_edit_entity_type_term' === $_POST['action'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Missing
+			if (isset($_POST['action']) && ('wl_edit_entity_type_term' === $_POST['action'])) { //phpcs:ignore WordPress.Security.NonceVerification.Missing
 				$this->handle_form_submission();
 			}
 			/**
@@ -83,9 +83,9 @@ 
 			 * @return bool
 			 * @since 3.27.6
 			 */
-			if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
+			if (apply_filters('wl_feature__enable__notices', true)) {
 				// Register admin notices handler.
-				add_action( 'admin_notices', array( $this, 'admin_notice' ) );
+				add_action('admin_notices', array($this, 'admin_notice'));
 			}
 		}
 
@@ -96,11 +96,11 @@ 
 		// @todo: use the new {@link Wordlift_Admin_Page}.
 		add_submenu_page(
 			null,
-			__( 'Edit Entity term', 'wordlift' ),
-			__( 'Edit Entity term', 'wordlift' ),
+			__('Edit Entity term', 'wordlift'),
+			__('Edit Entity term', 'wordlift'),
 			'manage_options',
 			'wl_entity_type_settings',
-			array( $this, 'render' )
+			array($this, 'render')
 		);
 	}
 
@@ -111,10 +111,10 @@ 
 	 * @since 3.11.0
 	 */
 	public function admin_notice() {
-		if ( isset( $_GET['message'] ) && ( '1' === $_GET['message'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		if (isset($_GET['message']) && ('1' === $_GET['message'])) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 			?>
 			<div class="notice notice-success is-dismissible">
-				<p><?php esc_html_e( 'Settings saved', 'wordlift' ); ?></p>
+				<p><?php esc_html_e('Settings saved', 'wordlift'); ?></p>
 			</div>
 			<?php
 		}
@@ -130,19 +130,19 @@ 
 	public function validate_proper_term() {
 
 		// Validate capabilities.
-		if ( ! current_user_can( 'manage_options' ) ) {
+		if ( ! current_user_can('manage_options')) {
 			wp_die(
-				'<h1>' . esc_html__( 'Cheatin&#8217; uh?', 'default' ) . '</h1>' .
-				'<p>' . esc_html__( 'Sorry, you are not allowed to edit this item.', 'default' ) . '</p>',
+				'<h1>'.esc_html__('Cheatin&#8217; uh?', 'default').'</h1>'.
+				'<p>'.esc_html__('Sorry, you are not allowed to edit this item.', 'default').'</p>',
 				403
 			);
 		}
 
 		// Get the term id and the actual term.
-		$term_id = isset( $_REQUEST['tag_ID'] ) ? (int) $_REQUEST['tag_ID'] : 0; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		$term_id = isset($_REQUEST['tag_ID']) ? (int) $_REQUEST['tag_ID'] : 0; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 
-		if ( ! term_exists( $term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME ) ) {
-			wp_die( esc_html__( 'You attempted to edit an entity type term that doesn&#8217;t exist.', 'wordlift' ) );
+		if ( ! term_exists($term_id, Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME)) {
+			wp_die(esc_html__('You attempted to edit an entity type term that doesn&#8217;t exist.', 'wordlift'));
 		}
 
 	}
@@ -155,25 +155,25 @@ 
 	 */
 	public function handle_form_submission() {
 
-		$term_id = isset( $_POST['tag_ID'] ) ? (int) $_POST['tag_ID'] : 0;
+		$term_id = isset($_POST['tag_ID']) ? (int) $_POST['tag_ID'] : 0;
 
 		// Check the nonce.
-		check_admin_referer( 'update-entity_type_term_' . $term_id );
+		check_admin_referer('update-entity_type_term_'.$term_id);
 
-		$term = get_term( $term_id, 'wl_entity_type' );
+		$term = get_term($term_id, 'wl_entity_type');
 
-		$title       = isset( $_POST['title'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['title'] ) ) : '';
-		$description = isset( $_POST['description'] ) ? sanitize_text_field( wp_unslash( (string) $_POST['description'] ) ) : '';
+		$title       = isset($_POST['title']) ? sanitize_text_field(wp_unslash((string) $_POST['title'])) : '';
+		$description = isset($_POST['description']) ? sanitize_text_field(wp_unslash((string) $_POST['description'])) : '';
 		$this->set_setting(
 			$term_id,
-			trim( wp_unslash( $title ) ),
-			wp_unslash( $description )
+			trim(wp_unslash($title)),
+			wp_unslash($description)
 		);
 
 		// Redirect back to the term settings page and indicate a save was done.
-		$url = admin_url( "admin.php?page=wl_entity_type_settings&tag_ID=$term->term_id&message=1" );
+		$url = admin_url("admin.php?page=wl_entity_type_settings&tag_ID=$term->term_id&message=1");
 
-		wp_safe_redirect( $url );
+		wp_safe_redirect($url);
 		exit();
 
 	}
@@ -188,11 +188,11 @@ 
 	public function render() {
 
 		// Set variables used by the partial
-		$term_id = isset( $_REQUEST['tag_ID'] ) ? absint( $_REQUEST['tag_ID'] ) : 0;  // phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		$term_id = isset($_REQUEST['tag_ID']) ? absint($_REQUEST['tag_ID']) : 0; // phpcs:ignore WordPress.Security.NonceVerification.Recommended
         // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		$settings = $this->get_setting( $term_id );
+		$settings = $this->get_setting($term_id);
 
-		include plugin_dir_path( __DIR__ ) . 'admin/partials/wordlift-admin-entity-type-settings.php';
+		include plugin_dir_path(__DIR__).'admin/partials/wordlift-admin-entity-type-settings.php';
 
 	}
 
@@ -205,14 +205,14 @@ 
 	 *
 	 * @since 3.11.0
 	 */
-	public function set_setting( $term_id, $title, $description ) {
+	public function set_setting($term_id, $title, $description) {
 
-		$settings             = get_option( 'wl_entity_type_settings', array() );
-		$settings[ $term_id ] = array(
+		$settings             = get_option('wl_entity_type_settings', array());
+		$settings[$term_id] = array(
 			'title'       => $title,
 			'description' => $description,
 		);
-		update_option( 'wl_entity_type_settings', $settings );
+		update_option('wl_entity_type_settings', $settings);
 
 	}
 
@@ -230,15 +230,15 @@ 
 	 *            }
 	 * @since 3.11.0
 	 */
-	public function get_setting( $term_id ) {
+	public function get_setting($term_id) {
 
-		$settings = get_option( 'wl_entity_type_settings', array() );
+		$settings = get_option('wl_entity_type_settings', array());
 
-		if ( isset( $settings[ $term_id ] ) ) {
-			return $settings[ $term_id ];
+		if (isset($settings[$term_id])) {
+			return $settings[$term_id];
 		}
 
-		$this->log->warn( "No settings found for term id $term_id." );
+		$this->log->warn("No settings found for term id $term_id.");
 
 		return null;
 	}

src/admin/class-wordlift-admin-term-adapter.php

Indentation +151 added lines, -151 removed lines

@@ -16,82 +16,82 @@ 
  */
 class Wordlift_Admin_Term_Adapter {
 
-	/**
-	 * The meta key holding the entity id.
-	 *
-	 * @since 3.20.0
-	 */
-	const META_KEY = '_wl_entity_id';
-
-	/**
-	 * Create a Wordlift_Admin_Term_Adapter instance.
-	 *
-	 * @since 3.20.0
-	 */
-	public function __construct() {
-
-		add_action( 'registered_taxonomy', array( $this, 'add_action' ) );
-		add_action( 'edit_term', array( $this, 'edit_term' ), 10 );
-		$this->add_settings();
-
-	}
-
-	/**
-	 * Hook in to WordLift admin settings and add the term page specific
-	 * settings.
-	 *
-	 * @since 3.26.1
-	 */
-	public function add_settings() {
-		add_filter(
-			'wl_admin_settings',
-			function ( $params ) {
-				$params['show_local_entities'] = true;
-
-				return $params;
-			}
-		);
-	}
-
-	/**
-	 * Add the form fields to the entity edit screen.
-	 *
-	 * @param object $tag Current taxonomy term object.
-	 *
-	 * @since 3.20.0
-	 */
-	public function edit_form_fields( $tag ) {
-
-		// If disabled via filter, return;
-		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( ! apply_filters( 'wl_feature__enable__term-entity', true ) ) {
-			return;
-		}
-
-		global $wp_version;
-
-		// Enqueue the JavaScript app.
-		if ( version_compare( $wp_version, '5.0', '>=' ) ) {
-			$term_asset = include plugin_dir_path( __DIR__ ) . 'js/dist/term.asset.php';
-			wp_enqueue_script( 'wl-term', plugin_dir_url( __DIR__ ) . 'js/dist/term.js', array_merge( array( 'wp-util' ), $term_asset['dependencies'] ), Wordlift::get_instance()->get_version(), true );
-		} else {
-			wp_enqueue_script( 'wl-term', plugin_dir_url( __DIR__ ) . 'js/dist/term.full.js', array( 'wp-util' ), Wordlift::get_instance()->get_version(), true );
-		}
-
-		wp_enqueue_style( 'wl-term', plugin_dir_url( __DIR__ ) . 'js/dist/term.css', array(), Wordlift::get_instance()->get_version() );
-
-		$values = get_term_meta( $tag->term_id, self::META_KEY );
-
-		/**
-		 * @since 3.31.3
-		 * @see https://github.com/insideout10/wordlift-plugin/issues/1446
-		 * This field should be hidden by default
-		 */
-		if ( ! $values ) {
-			return;
-		}
-
-		?>
+    /**
+     * The meta key holding the entity id.
+     *
+     * @since 3.20.0
+     */
+    const META_KEY = '_wl_entity_id';
+
+    /**
+     * Create a Wordlift_Admin_Term_Adapter instance.
+     *
+     * @since 3.20.0
+     */
+    public function __construct() {
+
+        add_action( 'registered_taxonomy', array( $this, 'add_action' ) );
+        add_action( 'edit_term', array( $this, 'edit_term' ), 10 );
+        $this->add_settings();
+
+    }
+
+    /**
+     * Hook in to WordLift admin settings and add the term page specific
+     * settings.
+     *
+     * @since 3.26.1
+     */
+    public function add_settings() {
+        add_filter(
+            'wl_admin_settings',
+            function ( $params ) {
+                $params['show_local_entities'] = true;
+
+                return $params;
+            }
+        );
+    }
+
+    /**
+     * Add the form fields to the entity edit screen.
+     *
+     * @param object $tag Current taxonomy term object.
+     *
+     * @since 3.20.0
+     */
+    public function edit_form_fields( $tag ) {
+
+        // If disabled via filter, return;
+        // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
+        if ( ! apply_filters( 'wl_feature__enable__term-entity', true ) ) {
+            return;
+        }
+
+        global $wp_version;
+
+        // Enqueue the JavaScript app.
+        if ( version_compare( $wp_version, '5.0', '>=' ) ) {
+            $term_asset = include plugin_dir_path( __DIR__ ) . 'js/dist/term.asset.php';
+            wp_enqueue_script( 'wl-term', plugin_dir_url( __DIR__ ) . 'js/dist/term.js', array_merge( array( 'wp-util' ), $term_asset['dependencies'] ), Wordlift::get_instance()->get_version(), true );
+        } else {
+            wp_enqueue_script( 'wl-term', plugin_dir_url( __DIR__ ) . 'js/dist/term.full.js', array( 'wp-util' ), Wordlift::get_instance()->get_version(), true );
+        }
+
+        wp_enqueue_style( 'wl-term', plugin_dir_url( __DIR__ ) . 'js/dist/term.css', array(), Wordlift::get_instance()->get_version() );
+
+        $values = get_term_meta( $tag->term_id, self::META_KEY );
+
+        /**
+         * @since 3.31.3
+         * @see https://github.com/insideout10/wordlift-plugin/issues/1446
+         * This field should be hidden by default
+         */
+        if ( ! $values ) {
+            return;
+        }
+
+        ?>
 		<tr class="form-field term-name-wrap">
 			<th scope="row"><label
 						for="wl-entity-id"><?php echo esc_html_x( 'Entity', 'term entity', 'wordlift' ); ?></label></th>
@@ -105,81 +105,81 @@ 
 		</tr>
 		<?php wp_nonce_field( 'wordlift_term_entity_edit', 'wordlift_term_entity_edit_nonce' ); ?>
 		<?php
-	}
-
-	/**
-	 * Bind the new fields to the edit term screen.
-	 *
-	 * @param string $taxonomy The taxonomy name.
-	 *
-	 * @since 3.20.0
-	 */
-	public function add_action( $taxonomy ) {
-		/**
-		 * Filter wl_feature__enable__taxonomy_term_entity_mapping renamed to wl_feature__enable__term-entity.
-		 */
-
-		add_action( "{$taxonomy}_edit_form_fields", array( $this, 'edit_form_fields' ), 10 );
-
-	}
-
-	/**
-	 * Hook to the edit term to handle our own custom fields.
-	 *
-	 * We turn off nonce verification here because we're responding to a WordPress hook.
-	 *
-	 * @param int $term_id The term id.
-	 *
-	 * @since 3.20.0
-	 */
-	public function edit_term( $term_id ) {
-
-		// Bail if the action isn't related to the term currently being edited.
+    }
+
+    /**
+     * Bind the new fields to the edit term screen.
+     *
+     * @param string $taxonomy The taxonomy name.
+     *
+     * @since 3.20.0
+     */
+    public function add_action( $taxonomy ) {
+        /**
+         * Filter wl_feature__enable__taxonomy_term_entity_mapping renamed to wl_feature__enable__term-entity.
+         */
+
+        add_action( "{$taxonomy}_edit_form_fields", array( $this, 'edit_form_fields' ), 10 );
+
+    }
+
+    /**
+     * Hook to the edit term to handle our own custom fields.
+     *
+     * We turn off nonce verification here because we're responding to a WordPress hook.
+     *
+     * @param int $term_id The term id.
+     *
+     * @since 3.20.0
+     */
+    public function edit_term( $term_id ) {
+
+        // Bail if the action isn't related to the term currently being edited.
         // phpcs:ignore WordPress.Security.NonceVerification.Missing
-		if ( ! isset( $_POST['tag_ID'] ) || $term_id !== (int) $_POST['tag_ID'] ) {
-			return;
-		}
-
-		// Delete.
-		// phpcs:ignore WordPress.Security.NonceVerification.Missing
-		if ( ! isset( $_POST['wl_entity_id'] ) || ! is_array( $_POST['wl_entity_id'] ) || empty( $_POST['wl_entity_id'] ) ) {
-			delete_term_meta( $term_id, self::META_KEY );
-
-			return;
-		}
-
-		// phpcs:ignore WordPress.Security.NonceVerification.Missing
-		$entity_ids = array_map( 'esc_url_raw', wp_unslash( $_POST['wl_entity_id'] ) );
-		// Update.
-		//
-		// Only use mb_* functions when mbstring is available.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/693.
-		if ( extension_loaded( 'mbstring' ) ) {
-			mb_regex_encoding( 'UTF-8' );
-
-			$merged = array_reduce(
-				$entity_ids,
-				function ( $carry, $item ) {
-					return array_merge( $carry, mb_split( "\x{2063}", wp_unslash( $item ) ) );
-				},
-				array()
-			);
-		} else {
-			$merged = array_reduce(
-				$entity_ids,
-				function ( $carry, $item ) {
-					return array_merge( $carry, preg_split( "/\x{2063}/u", wp_unslash( $item ) ) );
-				},
-				array()
-			);
-		}
-
-		delete_term_meta( $term_id, self::META_KEY );
-		foreach ( array_unique( array_filter( $merged ) ) as $single ) {
-			add_term_meta( $term_id, self::META_KEY, $single );
-		}
-
-	}
+        if ( ! isset( $_POST['tag_ID'] ) || $term_id !== (int) $_POST['tag_ID'] ) {
+            return;
+        }
+
+        // Delete.
+        // phpcs:ignore WordPress.Security.NonceVerification.Missing
+        if ( ! isset( $_POST['wl_entity_id'] ) || ! is_array( $_POST['wl_entity_id'] ) || empty( $_POST['wl_entity_id'] ) ) {
+            delete_term_meta( $term_id, self::META_KEY );
+
+            return;
+        }
+
+        // phpcs:ignore WordPress.Security.NonceVerification.Missing
+        $entity_ids = array_map( 'esc_url_raw', wp_unslash( $_POST['wl_entity_id'] ) );
+        // Update.
+        //
+        // Only use mb_* functions when mbstring is available.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/693.
+        if ( extension_loaded( 'mbstring' ) ) {
+            mb_regex_encoding( 'UTF-8' );
+
+            $merged = array_reduce(
+                $entity_ids,
+                function ( $carry, $item ) {
+                    return array_merge( $carry, mb_split( "\x{2063}", wp_unslash( $item ) ) );
+                },
+                array()
+            );
+        } else {
+            $merged = array_reduce(
+                $entity_ids,
+                function ( $carry, $item ) {
+                    return array_merge( $carry, preg_split( "/\x{2063}/u", wp_unslash( $item ) ) );
+                },
+                array()
+            );
+        }
+
+        delete_term_meta( $term_id, self::META_KEY );
+        foreach ( array_unique( array_filter( $merged ) ) as $single ) {
+            add_term_meta( $term_id, self::META_KEY, $single );
+        }
+
+    }
 
 }

Spacing +33 added lines, -33 removed lines

@@ -30,8 +30,8 @@ 
 	 */
 	public function __construct() {
 
-		add_action( 'registered_taxonomy', array( $this, 'add_action' ) );
-		add_action( 'edit_term', array( $this, 'edit_term' ), 10 );
+		add_action('registered_taxonomy', array($this, 'add_action'));
+		add_action('edit_term', array($this, 'edit_term'), 10);
 		$this->add_settings();
 
 	}
@@ -45,7 +45,7 @@ 
 	public function add_settings() {
 		add_filter(
 			'wl_admin_settings',
-			function ( $params ) {
+			function($params) {
 				$params['show_local_entities'] = true;
 
 				return $params;
@@ -60,50 +60,50 @@ 
 	 *
 	 * @since 3.20.0
 	 */
-	public function edit_form_fields( $tag ) {
+	public function edit_form_fields($tag) {
 
 		// If disabled via filter, return;
 		// phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-		if ( ! apply_filters( 'wl_feature__enable__term-entity', true ) ) {
+		if ( ! apply_filters('wl_feature__enable__term-entity', true)) {
 			return;
 		}
 
 		global $wp_version;
 
 		// Enqueue the JavaScript app.
-		if ( version_compare( $wp_version, '5.0', '>=' ) ) {
-			$term_asset = include plugin_dir_path( __DIR__ ) . 'js/dist/term.asset.php';
-			wp_enqueue_script( 'wl-term', plugin_dir_url( __DIR__ ) . 'js/dist/term.js', array_merge( array( 'wp-util' ), $term_asset['dependencies'] ), Wordlift::get_instance()->get_version(), true );
+		if (version_compare($wp_version, '5.0', '>=')) {
+			$term_asset = include plugin_dir_path(__DIR__).'js/dist/term.asset.php';
+			wp_enqueue_script('wl-term', plugin_dir_url(__DIR__).'js/dist/term.js', array_merge(array('wp-util'), $term_asset['dependencies']), Wordlift::get_instance()->get_version(), true);
 		} else {
-			wp_enqueue_script( 'wl-term', plugin_dir_url( __DIR__ ) . 'js/dist/term.full.js', array( 'wp-util' ), Wordlift::get_instance()->get_version(), true );
+			wp_enqueue_script('wl-term', plugin_dir_url(__DIR__).'js/dist/term.full.js', array('wp-util'), Wordlift::get_instance()->get_version(), true);
 		}
 
-		wp_enqueue_style( 'wl-term', plugin_dir_url( __DIR__ ) . 'js/dist/term.css', array(), Wordlift::get_instance()->get_version() );
+		wp_enqueue_style('wl-term', plugin_dir_url(__DIR__).'js/dist/term.css', array(), Wordlift::get_instance()->get_version());
 
-		$values = get_term_meta( $tag->term_id, self::META_KEY );
+		$values = get_term_meta($tag->term_id, self::META_KEY);
 
 		/**
 		 * @since 3.31.3
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/1446
 		 * This field should be hidden by default
 		 */
-		if ( ! $values ) {
+		if ( ! $values) {
 			return;
 		}
 
 		?>
 		<tr class="form-field term-name-wrap">
 			<th scope="row"><label
-						for="wl-entity-id"><?php echo esc_html_x( 'Entity', 'term entity', 'wordlift' ); ?></label></th>
+						for="wl-entity-id"><?php echo esc_html_x('Entity', 'term entity', 'wordlift'); ?></label></th>
 			<td>
-				<?php foreach ( $values as $value ) { ?>
-					<input type="text" name="wl_entity_id[]" value="<?php echo esc_attr( $value ); ?>"/>
+				<?php foreach ($values as $value) { ?>
+					<input type="text" name="wl_entity_id[]" value="<?php echo esc_attr($value); ?>"/>
 				<?php } ?>
 				<div id="wl-term-entity-id"></div>
-				<p class="description"><?php esc_html_e( 'The entity bound to the term.', 'wordlift' ); ?></p>
+				<p class="description"><?php esc_html_e('The entity bound to the term.', 'wordlift'); ?></p>
 			</td>
 		</tr>
-		<?php wp_nonce_field( 'wordlift_term_entity_edit', 'wordlift_term_entity_edit_nonce' ); ?>
+		<?php wp_nonce_field('wordlift_term_entity_edit', 'wordlift_term_entity_edit_nonce'); ?>
 		<?php
 	}
 
@@ -114,12 +114,12 @@ 
 	 *
 	 * @since 3.20.0
 	 */
-	public function add_action( $taxonomy ) {
+	public function add_action($taxonomy) {
 		/**
 		 * Filter wl_feature__enable__taxonomy_term_entity_mapping renamed to wl_feature__enable__term-entity.
 		 */
 
-		add_action( "{$taxonomy}_edit_form_fields", array( $this, 'edit_form_fields' ), 10 );
+		add_action("{$taxonomy}_edit_form_fields", array($this, 'edit_form_fields'), 10);
 
 	}
 
@@ -132,52 +132,52 @@ 
 	 *
 	 * @since 3.20.0
 	 */
-	public function edit_term( $term_id ) {
+	public function edit_term($term_id) {
 
 		// Bail if the action isn't related to the term currently being edited.
         // phpcs:ignore WordPress.Security.NonceVerification.Missing
-		if ( ! isset( $_POST['tag_ID'] ) || $term_id !== (int) $_POST['tag_ID'] ) {
+		if ( ! isset($_POST['tag_ID']) || $term_id !== (int) $_POST['tag_ID']) {
 			return;
 		}
 
 		// Delete.
 		// phpcs:ignore WordPress.Security.NonceVerification.Missing
-		if ( ! isset( $_POST['wl_entity_id'] ) || ! is_array( $_POST['wl_entity_id'] ) || empty( $_POST['wl_entity_id'] ) ) {
-			delete_term_meta( $term_id, self::META_KEY );
+		if ( ! isset($_POST['wl_entity_id']) || ! is_array($_POST['wl_entity_id']) || empty($_POST['wl_entity_id'])) {
+			delete_term_meta($term_id, self::META_KEY);
 
 			return;
 		}
 
 		// phpcs:ignore WordPress.Security.NonceVerification.Missing
-		$entity_ids = array_map( 'esc_url_raw', wp_unslash( $_POST['wl_entity_id'] ) );
+		$entity_ids = array_map('esc_url_raw', wp_unslash($_POST['wl_entity_id']));
 		// Update.
 		//
 		// Only use mb_* functions when mbstring is available.
 		//
 		// See https://github.com/insideout10/wordlift-plugin/issues/693.
-		if ( extension_loaded( 'mbstring' ) ) {
-			mb_regex_encoding( 'UTF-8' );
+		if (extension_loaded('mbstring')) {
+			mb_regex_encoding('UTF-8');
 
 			$merged = array_reduce(
 				$entity_ids,
-				function ( $carry, $item ) {
-					return array_merge( $carry, mb_split( "\x{2063}", wp_unslash( $item ) ) );
+				function($carry, $item) {
+					return array_merge($carry, mb_split("\x{2063}", wp_unslash($item)));
 				},
 				array()
 			);
 		} else {
 			$merged = array_reduce(
 				$entity_ids,
-				function ( $carry, $item ) {
-					return array_merge( $carry, preg_split( "/\x{2063}/u", wp_unslash( $item ) ) );
+				function($carry, $item) {
+					return array_merge($carry, preg_split("/\x{2063}/u", wp_unslash($item)));
 				},
 				array()
 			);
 		}
 
-		delete_term_meta( $term_id, self::META_KEY );
-		foreach ( array_unique( array_filter( $merged ) ) as $single ) {
-			add_term_meta( $term_id, self::META_KEY, $single );
+		delete_term_meta($term_id, self::META_KEY);
+		foreach (array_unique(array_filter($merged)) as $single) {
+			add_term_meta($term_id, self::META_KEY, $single);
 		}
 
 	}

src/admin/wordlift-admin-ajax-related-posts.php

Indentation +65 added lines, -65 removed lines

@@ -17,71 +17,71 @@
  */
 function wordlift_ajax_related_posts( $http_raw_data = null ) {
 
-	// Extract filtering conditions
-	if ( ! isset( $_GET['post_id'] ) || ! is_numeric( $_GET['post_id'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		wp_die( 'Post id missing or invalid!' );
-
-		return;
-	}
-
-	// Get the current post
-	$post_id = (int) $_GET['post_id']; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-	$post    = get_post( $post_id );
-
-	Wordlift_Log_Service::get_logger( 'wordlift_ajax_related_posts' )->trace( "Going to find posts related to current with post id: $post_id ..." );
-
-	// Extract filtering conditions
-	$filtering_entity_uris = empty( $http_raw_data ) ? file_get_contents( 'php://input' ) : $http_raw_data;
-	$filtering_entity_uris = json_decode( $filtering_entity_uris );
-
-	$content_service      = Wordpress_Content_Service::get_instance();
-	$filtering_entity_ids = array_filter(
-		array_map(
-			function ( $uri ) use ( $content_service ) {
-				$content = $content_service->get_by_entity_id( $uri );
-				if ( isset( $content ) && is_a( $content->get_bag(), '\WP_Post' ) ) {
-					return $content->get_bag()->ID;
-				} else {
-					return null;
-				}
-			},
-			$filtering_entity_uris
-		)
-	);
-
-	$related_posts = array();
-
-	// If the current post is an entity, related posts to the current entity are
-	// returned.
-	$entity_service = Wordlift_Entity_Service::get_instance();
-
-	if ( $entity_service->is_entity( $post->ID ) ) {
-		$filtering_entity_ids = array( $post_id );
-	}
-
-	if ( ! empty( $filtering_entity_ids ) ) {
-
-		$related_posts = Wordlift_Relation_Service::get_instance()
-												  ->get_article_subjects( $filtering_entity_ids, '*', null, 'publish', array( $post_id ), 5 );
-
-		foreach ( $related_posts as $post_obj ) {
-
-			/**
-			 * Use the thumbnail.
-			 *
-			 * @see https://github.com/insideout10/wordlift-plugin/issues/825 related issue.
-			 * @see https://github.com/insideout10/wordlift-plugin/issues/837
-			 *
-			 * @since 3.19.3 We're using the medium size image.
-			 */
-			$thumbnail           = get_the_post_thumbnail_url( $post_obj, 'medium' );
-			$post_obj->thumbnail = ( $thumbnail ) ? $thumbnail : WL_DEFAULT_THUMBNAIL_PATH;
-			$post_obj->link      = get_edit_post_link( $post_obj->ID, 'none' );
-			$post_obj->permalink = get_post_permalink( $post_obj->ID );
-		}
-	}
-
-	wl_core_send_json( $related_posts );
+    // Extract filtering conditions
+    if ( ! isset( $_GET['post_id'] ) || ! is_numeric( $_GET['post_id'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        wp_die( 'Post id missing or invalid!' );
+
+        return;
+    }
+
+    // Get the current post
+    $post_id = (int) $_GET['post_id']; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+    $post    = get_post( $post_id );
+
+    Wordlift_Log_Service::get_logger( 'wordlift_ajax_related_posts' )->trace( "Going to find posts related to current with post id: $post_id ..." );
+
+    // Extract filtering conditions
+    $filtering_entity_uris = empty( $http_raw_data ) ? file_get_contents( 'php://input' ) : $http_raw_data;
+    $filtering_entity_uris = json_decode( $filtering_entity_uris );
+
+    $content_service      = Wordpress_Content_Service::get_instance();
+    $filtering_entity_ids = array_filter(
+        array_map(
+            function ( $uri ) use ( $content_service ) {
+                $content = $content_service->get_by_entity_id( $uri );
+                if ( isset( $content ) && is_a( $content->get_bag(), '\WP_Post' ) ) {
+                    return $content->get_bag()->ID;
+                } else {
+                    return null;
+                }
+            },
+            $filtering_entity_uris
+        )
+    );
+
+    $related_posts = array();
+
+    // If the current post is an entity, related posts to the current entity are
+    // returned.
+    $entity_service = Wordlift_Entity_Service::get_instance();
+
+    if ( $entity_service->is_entity( $post->ID ) ) {
+        $filtering_entity_ids = array( $post_id );
+    }
+
+    if ( ! empty( $filtering_entity_ids ) ) {
+
+        $related_posts = Wordlift_Relation_Service::get_instance()
+                                                    ->get_article_subjects( $filtering_entity_ids, '*', null, 'publish', array( $post_id ), 5 );
+
+        foreach ( $related_posts as $post_obj ) {
+
+            /**
+             * Use the thumbnail.
+             *
+             * @see https://github.com/insideout10/wordlift-plugin/issues/825 related issue.
+             * @see https://github.com/insideout10/wordlift-plugin/issues/837
+             *
+             * @since 3.19.3 We're using the medium size image.
+             */
+            $thumbnail           = get_the_post_thumbnail_url( $post_obj, 'medium' );
+            $post_obj->thumbnail = ( $thumbnail ) ? $thumbnail : WL_DEFAULT_THUMBNAIL_PATH;
+            $post_obj->link      = get_edit_post_link( $post_obj->ID, 'none' );
+            $post_obj->permalink = get_post_permalink( $post_obj->ID );
+        }
+    }
+
+    wl_core_send_json( $related_posts );
 
 }
 

Spacing +21 added lines, -21 removed lines

@@ -15,31 +15,31 @@ 
  *
  * @since 3.0.0
  */
-function wordlift_ajax_related_posts( $http_raw_data = null ) {
+function wordlift_ajax_related_posts($http_raw_data = null) {
 
 	// Extract filtering conditions
-	if ( ! isset( $_GET['post_id'] ) || ! is_numeric( $_GET['post_id'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		wp_die( 'Post id missing or invalid!' );
+	if ( ! isset($_GET['post_id']) || ! is_numeric($_GET['post_id'])) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		wp_die('Post id missing or invalid!');
 
 		return;
 	}
 
 	// Get the current post
 	$post_id = (int) $_GET['post_id']; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-	$post    = get_post( $post_id );
+	$post    = get_post($post_id);
 
-	Wordlift_Log_Service::get_logger( 'wordlift_ajax_related_posts' )->trace( "Going to find posts related to current with post id: $post_id ..." );
+	Wordlift_Log_Service::get_logger('wordlift_ajax_related_posts')->trace("Going to find posts related to current with post id: $post_id ...");
 
 	// Extract filtering conditions
-	$filtering_entity_uris = empty( $http_raw_data ) ? file_get_contents( 'php://input' ) : $http_raw_data;
-	$filtering_entity_uris = json_decode( $filtering_entity_uris );
+	$filtering_entity_uris = empty($http_raw_data) ? file_get_contents('php://input') : $http_raw_data;
+	$filtering_entity_uris = json_decode($filtering_entity_uris);
 
 	$content_service      = Wordpress_Content_Service::get_instance();
 	$filtering_entity_ids = array_filter(
 		array_map(
-			function ( $uri ) use ( $content_service ) {
-				$content = $content_service->get_by_entity_id( $uri );
-				if ( isset( $content ) && is_a( $content->get_bag(), '\WP_Post' ) ) {
+			function($uri) use ($content_service) {
+				$content = $content_service->get_by_entity_id($uri);
+				if (isset($content) && is_a($content->get_bag(), '\WP_Post')) {
 					return $content->get_bag()->ID;
 				} else {
 					return null;
@@ -55,16 +55,16 @@ 
 	// returned.
 	$entity_service = Wordlift_Entity_Service::get_instance();
 
-	if ( $entity_service->is_entity( $post->ID ) ) {
-		$filtering_entity_ids = array( $post_id );
+	if ($entity_service->is_entity($post->ID)) {
+		$filtering_entity_ids = array($post_id);
 	}
 
-	if ( ! empty( $filtering_entity_ids ) ) {
+	if ( ! empty($filtering_entity_ids)) {
 
 		$related_posts = Wordlift_Relation_Service::get_instance()
-												  ->get_article_subjects( $filtering_entity_ids, '*', null, 'publish', array( $post_id ), 5 );
+												  ->get_article_subjects($filtering_entity_ids, '*', null, 'publish', array($post_id), 5);
 
-		foreach ( $related_posts as $post_obj ) {
+		foreach ($related_posts as $post_obj) {
 
 			/**
 			 * Use the thumbnail.
@@ -74,15 +74,15 @@ 
 			 *
 			 * @since 3.19.3 We're using the medium size image.
 			 */
-			$thumbnail           = get_the_post_thumbnail_url( $post_obj, 'medium' );
-			$post_obj->thumbnail = ( $thumbnail ) ? $thumbnail : WL_DEFAULT_THUMBNAIL_PATH;
-			$post_obj->link      = get_edit_post_link( $post_obj->ID, 'none' );
-			$post_obj->permalink = get_post_permalink( $post_obj->ID );
+			$thumbnail           = get_the_post_thumbnail_url($post_obj, 'medium');
+			$post_obj->thumbnail = ($thumbnail) ? $thumbnail : WL_DEFAULT_THUMBNAIL_PATH;
+			$post_obj->link      = get_edit_post_link($post_obj->ID, 'none');
+			$post_obj->permalink = get_post_permalink($post_obj->ID);
 		}
 	}
 
-	wl_core_send_json( $related_posts );
+	wl_core_send_json($related_posts);
 
 }
 
-add_action( 'wp_ajax_wordlift_related_posts', 'wordlift_ajax_related_posts' );
+add_action('wp_ajax_wordlift_related_posts', 'wordlift_ajax_related_posts');

src/admin/partials/wordlift-admin-news-widget.php

Indentation +3 added lines, -3 removed lines

@@ -4,9 +4,9 @@
 <div id='news_container'>
 	<?php if ( ! empty( $articles['posts_data'] ) ) { ?>
 		<?php
-		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		foreach ( $articles['posts_data'] as $key => $item ) {
-			?>
+        // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+        foreach ( $articles['posts_data'] as $key => $item ) {
+            ?>
 			<div>
 				<a target="_blank"
 				   href="<?php echo esc_url( $item['post_url'] ); ?>"><?php echo esc_html( $item['post_title'] ); ?></a>

Spacing +5 added lines, -5 removed lines

@@ -2,20 +2,20 @@
 // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
 $articles = $this->get_last_wordlift_articles(); ?>
 <div id='news_container'>
-	<?php if ( ! empty( $articles['posts_data'] ) ) { ?>
+	<?php if ( ! empty($articles['posts_data'])) { ?>
 		<?php
 		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		foreach ( $articles['posts_data'] as $key => $item ) {
+		foreach ($articles['posts_data'] as $key => $item) {
 			?>
 			<div>
 				<a target="_blank"
-				   href="<?php echo esc_url( $item['post_url'] ); ?>"><?php echo esc_html( $item['post_title'] ); ?></a>
-				<p><?php echo wp_kses( $item['post_description'], wp_kses_allowed_html( 'post' ) ); ?></p>
+				   href="<?php echo esc_url($item['post_url']); ?>"><?php echo esc_html($item['post_title']); ?></a>
+				<p><?php echo wp_kses($item['post_description'], wp_kses_allowed_html('post')); ?></p>
 			</div>
 		<?php } ?>
 	<?php } ?>
 	<div>
 		<a href="#" id="max_posts_count_3"
-		   class="wl_more_posts"><?php echo esc_html__( 'More posts', 'wordlift' ); ?></a>
+		   class="wl_more_posts"><?php echo esc_html__('More posts', 'wordlift'); ?></a>
 	</div>
 </div>