insideout10 / wordlift-plugin

src/wordlift/images-licenses/admin/class-image-license-page.php

Doc Comments +1 added lines

@@ -87,6 +87,7 @@
 
 	/**
 	 * @param array $image
+	 * @param integer $idx
 	 */
 	private function render_image( $image, $idx ) {
 

Indentation +101 added lines, -101 removed lines

@@ -9,41 +9,41 @@ 
 
 class Image_License_Page extends Submenu_Page_Base {
 
-	/**
-	 * @var array
-	 */
-	private $data;
-
-	/**
-	 * @var string
-	 */
-	private $version;
-
-	/**
-	 * Image_License_Page constructor.
-	 *
-	 * @param array $data
-	 * @param string $version
-	 */
-	public function __construct( $data, $version ) {
-		$count = count( $data );
-
-		// Display the page in the menu only if there's something to do.
-		if ( 0 === $count ) {
-			return;
-		}
-		$menu_title = __( 'License Compliance', 'wordlift' ) .
-		              sprintf( '<span class="update-plugins count-%1$d"><span class="license-compliance-count">%1$d</span></span>', $count );
-
-		parent::__construct( 'wl_image_license_page', __( 'License Compliance', 'wordlift' ), 'manage_options', 'wl_admin_menu', $menu_title );
-
-		$this->data    = $data;
-		$this->version = $version;
-
-	}
-
-	public function render() {
-		?>
+    /**
+     * @var array
+     */
+    private $data;
+
+    /**
+     * @var string
+     */
+    private $version;
+
+    /**
+     * Image_License_Page constructor.
+     *
+     * @param array $data
+     * @param string $version
+     */
+    public function __construct( $data, $version ) {
+        $count = count( $data );
+
+        // Display the page in the menu only if there's something to do.
+        if ( 0 === $count ) {
+            return;
+        }
+        $menu_title = __( 'License Compliance', 'wordlift' ) .
+                        sprintf( '<span class="update-plugins count-%1$d"><span class="license-compliance-count">%1$d</span></span>', $count );
+
+        parent::__construct( 'wl_image_license_page', __( 'License Compliance', 'wordlift' ), 'manage_options', 'wl_admin_menu', $menu_title );
+
+        $this->data    = $data;
+        $this->version = $version;
+
+    }
+
+    public function render() {
+        ?>
         <h1><?php esc_html_e( 'License Compliance', 'wordlift' ); ?></h1>
 
         <p><?php esc_html_e( 'By choosing "Remove All Images" you will ', 'wordlift' ); ?>
@@ -79,40 +79,40 @@ 
             </tr>
             </thead>
 			<?php
-			$images = $this->data;
+            $images = $this->data;
 
-			for ( $i = 0; $i < count( $images ); $i ++ ) {
-				$this->render_image( $images[ $i ], $i );
-			}
-			?>
+            for ( $i = 0; $i < count( $images ); $i ++ ) {
+                $this->render_image( $images[ $i ], $i );
+            }
+            ?>
         </table>
 		<?php
-	}
+    }
 
-	/**
-	 * @param array $image
-	 */
-	private function render_image( $image, $idx ) {
+    /**
+     * @param array $image
+     */
+    private function render_image( $image, $idx ) {
 
-		$attachment_id = $image['attachment_id'];
+        $attachment_id = $image['attachment_id'];
 
-		// Skip if the post doesn't exist anymore or has been fixed.
-		if ( ! $this->exists( $attachment_id ) ) {
-			return;
-		}
+        // Skip if the post doesn't exist anymore or has been fixed.
+        if ( ! $this->exists( $attachment_id ) ) {
+            return;
+        }
 
-		$author = html_entity_decode( $image['author'] );
+        $author = html_entity_decode( $image['author'] );
 
-		$more_info_link_esc = esc_url( $image['more_info_link'] );
+        $more_info_link_esc = esc_url( $image['more_info_link'] );
 
-		$is_unknown_license = '#N/A' === $image['license'];
+        $is_unknown_license = '#N/A' === $image['license'];
 
-		$caption_builder  = new Caption_Builder( $image );
-		$proposed_caption = $caption_builder->build();
+        $caption_builder  = new Caption_Builder( $image );
+        $proposed_caption = $caption_builder->build();
 
-		$script_id = "wl-image-$idx";
-		$row_id    = "wl-row-$idx";
-		?>
+        $script_id = "wl-image-$idx";
+        $row_id    = "wl-row-$idx";
+        ?>
         <tr id="<?php echo $row_id; ?>">
             <td><?php echo wp_get_attachment_image( $attachment_id, array( 100, ) ); ?></td>
             <td><?php echo esc_html( $image['filename'] ); ?></td>
@@ -125,9 +125,9 @@ 
             </td>
             <td>
 				<?php
-				$this->partial_used_in_posts( $image['posts_ids_as_featured_image'], __( 'Used as featured image in %d post(s):', 'wordlift' ) );
-				$this->partial_used_in_posts( $image['posts_ids_as_embed'], __( 'Embedded in %d post(s):', 'wordlift' ) );
-				?>
+                $this->partial_used_in_posts( $image['posts_ids_as_featured_image'], __( 'Used as featured image in %d post(s):', 'wordlift' ) );
+                $this->partial_used_in_posts( $image['posts_ids_as_embed'], __( 'Embedded in %d post(s):', 'wordlift' ) );
+                ?>
             </td>
             <td>
                 <script type="application/json"
@@ -149,44 +149,44 @@ 
             </td>
         </tr>
 		<?php
-	}
+    }
 
-	private function partial_used_in_posts( $data, $label ) {
+    private function partial_used_in_posts( $data, $label ) {
 
-		// Bail out if there's not data.
-		$count = count( $data );
-		if ( 0 === $count ) {
-			return;
-		}
+        // Bail out if there's not data.
+        $count = count( $data );
+        if ( 0 === $count ) {
+            return;
+        }
 
-		echo esc_html( sprintf( $label, $count ) );
-		foreach ( $data as $post_id ) {
-			$post = get_post( $post_id ); ?>
+        echo esc_html( sprintf( $label, $count ) );
+        foreach ( $data as $post_id ) {
+            $post = get_post( $post_id ); ?>
             <a href="<?php echo get_permalink( $post_id ); ?>"><?php echo esc_html( $post->post_title ); ?></a>
 			<?php
-		}
-	}
-
-	function enqueue_scripts() {
-
-		wp_enqueue_script( $this->get_menu_slug(), plugin_dir_url( __FILE__ ) . 'assets/image-license.js', array( 'wp-util' ), $this->version, true );
-		wp_localize_script( $this->get_menu_slug(), '_wlImageLicensePageSettings', array(
-			'_ajax_nonce' => array(
-				Add_License_Caption_Or_Remove_Task::MENU_SLUG . '__single' => wp_create_nonce( Add_License_Caption_Or_Remove_Task::MENU_SLUG ),
-				Remove_All_Images_Task::MENU_SLUG . '__single'             => wp_create_nonce( Remove_All_Images_Task::MENU_SLUG ),
-			),
-			'l10n'        => array(
-				'Done'              => __( 'Done', 'wordlift' ),
-				'An error occurred' => __( 'An error occurred', 'wordlift' ),
-			)
-		) );
-	}
-
-	private function exists( $attachment_id ) {
-		global $wpdb;
-
-		$sql =
-			"
+        }
+    }
+
+    function enqueue_scripts() {
+
+        wp_enqueue_script( $this->get_menu_slug(), plugin_dir_url( __FILE__ ) . 'assets/image-license.js', array( 'wp-util' ), $this->version, true );
+        wp_localize_script( $this->get_menu_slug(), '_wlImageLicensePageSettings', array(
+            '_ajax_nonce' => array(
+                Add_License_Caption_Or_Remove_Task::MENU_SLUG . '__single' => wp_create_nonce( Add_License_Caption_Or_Remove_Task::MENU_SLUG ),
+                Remove_All_Images_Task::MENU_SLUG . '__single'             => wp_create_nonce( Remove_All_Images_Task::MENU_SLUG ),
+            ),
+            'l10n'        => array(
+                'Done'              => __( 'Done', 'wordlift' ),
+                'An error occurred' => __( 'An error occurred', 'wordlift' ),
+            )
+        ) );
+    }
+
+    private function exists( $attachment_id ) {
+        global $wpdb;
+
+        $sql =
+            "
             SELECT COUNT( 1 )
             FROM {$wpdb->postmeta} pm1
             LEFT OUTER JOIN {$wpdb->postmeta} pm2
@@ -197,12 +197,12 @@ 
               AND pm2.meta_value IS NULL
             ";
 
-		return $wpdb->get_var( $wpdb->prepare(
-			$sql,
-			'_wl_image_license_fixed',
-			$attachment_id,
-			'_wp_attached_file'
-		) );
-	}
+        return $wpdb->get_var( $wpdb->prepare(
+            $sql,
+            '_wl_image_license_fixed',
+            $attachment_id,
+            '_wp_attached_file'
+        ) );
+    }
 
 }

Spacing +61 added lines, -61 removed lines

@@ -25,17 +25,17 @@ 
 	 * @param array $data
 	 * @param string $version
 	 */
-	public function __construct( $data, $version ) {
-		$count = count( $data );
+	public function __construct($data, $version) {
+		$count = count($data);
 
 		// Display the page in the menu only if there's something to do.
-		if ( 0 === $count ) {
+		if (0 === $count) {
 			return;
 		}
-		$menu_title = __( 'License Compliance', 'wordlift' ) .
-		              sprintf( '<span class="update-plugins count-%1$d"><span class="license-compliance-count">%1$d</span></span>', $count );
+		$menu_title = __('License Compliance', 'wordlift').
+		              sprintf('<span class="update-plugins count-%1$d"><span class="license-compliance-count">%1$d</span></span>', $count);
 
-		parent::__construct( 'wl_image_license_page', __( 'License Compliance', 'wordlift' ), 'manage_options', 'wl_admin_menu', $menu_title );
+		parent::__construct('wl_image_license_page', __('License Compliance', 'wordlift'), 'manage_options', 'wl_admin_menu', $menu_title);
 
 		$this->data    = $data;
 		$this->version = $version;
@@ -44,45 +44,45 @@ 
 
 	public function render() {
 		?>
-        <h1><?php esc_html_e( 'License Compliance', 'wordlift' ); ?></h1>
+        <h1><?php esc_html_e('License Compliance', 'wordlift'); ?></h1>
 
-        <p><?php esc_html_e( 'By choosing "Remove All Images" you will ', 'wordlift' ); ?>
-            <strong><?php esc_html_e( 'remove from your website all images that do not have a Public Domain or CC0 license', 'wordlift' ); ?></strong>.
-			<?php esc_html_e( 'Alternatively, WordLift can write the terms of the detected license in the caption of each image. Make sure
+        <p><?php esc_html_e('By choosing "Remove All Images" you will ', 'wordlift'); ?>
+            <strong><?php esc_html_e('remove from your website all images that do not have a Public Domain or CC0 license', 'wordlift'); ?></strong>.
+			<?php esc_html_e('Alternatively, WordLift can write the terms of the detected license in the caption of each image. Make sure
             that attribution, when required, is visible to your readers. You can also selectively choose from the list
-            of images below if removing or adding the license for each of the images.', 'wordlift' ); ?></p>
-        <p><span class="dashicons dashicons-warning"></span> <?php esc_html_e( 'As site owner you are ultimately responsible for the images
-            being published on your website.', 'wordlift' ); ?></p>
+            of images below if removing or adding the license for each of the images.', 'wordlift'); ?></p>
+        <p><span class="dashicons dashicons-warning"></span> <?php esc_html_e('As site owner you are ultimately responsible for the images
+            being published on your website.', 'wordlift'); ?></p>
 
         <p class="top">
             <a class="button"
-               href="<?php echo admin_url( 'admin.php?page=wl_images_licenses__reload_data' ); ?>"><?php esc_html_e( 'Reload data', 'wordlift' ); ?></a>
+               href="<?php echo admin_url('admin.php?page=wl_images_licenses__reload_data'); ?>"><?php esc_html_e('Reload data', 'wordlift'); ?></a>
             <a class="button"
-               href="<?php echo admin_url( 'admin.php?page=wl_images_licenses__remove_all_images' ); ?>"><?php esc_html_e( 'Remove all images', 'wordlift' ); ?></a>
+               href="<?php echo admin_url('admin.php?page=wl_images_licenses__remove_all_images'); ?>"><?php esc_html_e('Remove all images', 'wordlift'); ?></a>
             <a class="button"
-               href="<?php echo admin_url( 'admin.php?page=wl_images_licenses__add_license_caption_or_remove' ); ?>"><?php esc_html_e( 'Add license caption to images and remove those with unknown license', 'wordlift' ); ?></a>
+               href="<?php echo admin_url('admin.php?page=wl_images_licenses__add_license_caption_or_remove'); ?>"><?php esc_html_e('Add license caption to images and remove those with unknown license', 'wordlift'); ?></a>
         </p>
 
-        <h2 class="screen-reader-text"><?php esc_html_e( 'Images', 'wordlift' ); ?></h2>
+        <h2 class="screen-reader-text"><?php esc_html_e('Images', 'wordlift'); ?></h2>
 
         <table class="wp-list-table widefat fixed striped">
             <thead>
             <tr>
-                <th><?php esc_html_e( 'Thumbnail', 'wordlift' ); ?></th>
-                <th><?php esc_html_e( 'Filename', 'wordlift' ); ?></th>
-                <th><?php esc_html_e( 'License', 'wordlift' ); ?></th>
-                <th><?php esc_html_e( 'Author', 'wordlift' ); ?></th>
-                <th><?php esc_html_e( 'Proposed Caption', 'wordlift' ); ?></th>
-                <th><?php esc_html_e( 'More Info', 'wordlift' ); ?></th>
-                <th><?php esc_html_e( 'Posts', 'wordlift' ); ?></th>
-                <th><?php esc_html_e( 'Actions', 'wordlift' ); ?></th>
+                <th><?php esc_html_e('Thumbnail', 'wordlift'); ?></th>
+                <th><?php esc_html_e('Filename', 'wordlift'); ?></th>
+                <th><?php esc_html_e('License', 'wordlift'); ?></th>
+                <th><?php esc_html_e('Author', 'wordlift'); ?></th>
+                <th><?php esc_html_e('Proposed Caption', 'wordlift'); ?></th>
+                <th><?php esc_html_e('More Info', 'wordlift'); ?></th>
+                <th><?php esc_html_e('Posts', 'wordlift'); ?></th>
+                <th><?php esc_html_e('Actions', 'wordlift'); ?></th>
             </tr>
             </thead>
 			<?php
 			$images = $this->data;
 
-			for ( $i = 0; $i < count( $images ); $i ++ ) {
-				$this->render_image( $images[ $i ], $i );
+			for ($i = 0; $i < count($images); $i++) {
+				$this->render_image($images[$i], $i);
 			}
 			?>
         </table>
@@ -92,97 +92,97 @@ 
 	/**
 	 * @param array $image
 	 */
-	private function render_image( $image, $idx ) {
+	private function render_image($image, $idx) {
 
 		$attachment_id = $image['attachment_id'];
 
 		// Skip if the post doesn't exist anymore or has been fixed.
-		if ( ! $this->exists( $attachment_id ) ) {
+		if ( ! $this->exists($attachment_id)) {
 			return;
 		}
 
-		$author = html_entity_decode( $image['author'] );
+		$author = html_entity_decode($image['author']);
 
-		$more_info_link_esc = esc_url( $image['more_info_link'] );
+		$more_info_link_esc = esc_url($image['more_info_link']);
 
 		$is_unknown_license = '#N/A' === $image['license'];
 
-		$caption_builder  = new Caption_Builder( $image );
+		$caption_builder  = new Caption_Builder($image);
 		$proposed_caption = $caption_builder->build();
 
 		$script_id = "wl-image-$idx";
 		$row_id    = "wl-row-$idx";
 		?>
         <tr id="<?php echo $row_id; ?>">
-            <td><?php echo wp_get_attachment_image( $attachment_id, array( 100, ) ); ?></td>
-            <td><?php echo esc_html( $image['filename'] ); ?></td>
-            <td><?php echo esc_html( $image['license'] ); ?></td>
+            <td><?php echo wp_get_attachment_image($attachment_id, array(100,)); ?></td>
+            <td><?php echo esc_html($image['filename']); ?></td>
+            <td><?php echo esc_html($image['license']); ?></td>
             <td><?php echo $author; ?></td>
             <td><?php echo $proposed_caption; ?></td>
             <td>
                 <a href="<?php echo $more_info_link_esc; ?>"
-                   target="_blank"><?php esc_html_e( 'More information', 'wordlift' ); ?></a>
+                   target="_blank"><?php esc_html_e('More information', 'wordlift'); ?></a>
             </td>
             <td>
 				<?php
-				$this->partial_used_in_posts( $image['posts_ids_as_featured_image'], __( 'Used as featured image in %d post(s):', 'wordlift' ) );
-				$this->partial_used_in_posts( $image['posts_ids_as_embed'], __( 'Embedded in %d post(s):', 'wordlift' ) );
+				$this->partial_used_in_posts($image['posts_ids_as_featured_image'], __('Used as featured image in %d post(s):', 'wordlift'));
+				$this->partial_used_in_posts($image['posts_ids_as_embed'], __('Embedded in %d post(s):', 'wordlift'));
 				?>
             </td>
             <td>
                 <script type="application/json"
-                        id="<?php echo $script_id; ?>"><?php echo json_encode( $image ); ?></script>
+                        id="<?php echo $script_id; ?>"><?php echo json_encode($image); ?></script>
                 <button data-id="<?php echo $script_id; ?>"
                         data-row-id="<?php echo $row_id; ?>"
                         data-action="wl_remove_all_images_task__single"
-                        class="button wl-action-btn"><?php esc_html_e( 'Remove image', 'wordlift' ); ?></button>
-				<?php if ( ! $is_unknown_license ) { ?>
+                        class="button wl-action-btn"><?php esc_html_e('Remove image', 'wordlift'); ?></button>
+				<?php if ( ! $is_unknown_license) { ?>
                     <button data-id="<?php echo $script_id; ?>"
                             data-row-id="<?php echo $row_id; ?>"
                             data-action="wl_add_license_caption_or_remove__single"
-                            class="button wl-action-btn"><?php esc_html_e( 'Add license caption', 'wordlift' ); ?></button>
+                            class="button wl-action-btn"><?php esc_html_e('Add license caption', 'wordlift'); ?></button>
 				<?php } ?>
                 <a class="button"
-                   href=" <?php echo get_edit_post_link( $attachment_id ); ?>"
-                   target="_blank"><?php esc_html_e( 'Edit image', 'wordlift' ); ?> <span
+                   href=" <?php echo get_edit_post_link($attachment_id); ?>"
+                   target="_blank"><?php esc_html_e('Edit image', 'wordlift'); ?> <span
                             class="dashicons dashicons-external"></span></a>
             </td>
         </tr>
 		<?php
 	}
 
-	private function partial_used_in_posts( $data, $label ) {
+	private function partial_used_in_posts($data, $label) {
 
 		// Bail out if there's not data.
-		$count = count( $data );
-		if ( 0 === $count ) {
+		$count = count($data);
+		if (0 === $count) {
 			return;
 		}
 
-		echo esc_html( sprintf( $label, $count ) );
-		foreach ( $data as $post_id ) {
-			$post = get_post( $post_id ); ?>
-            <a href="<?php echo get_permalink( $post_id ); ?>"><?php echo esc_html( $post->post_title ); ?></a>
+		echo esc_html(sprintf($label, $count));
+		foreach ($data as $post_id) {
+			$post = get_post($post_id); ?>
+            <a href="<?php echo get_permalink($post_id); ?>"><?php echo esc_html($post->post_title); ?></a>
 			<?php
 		}
 	}
 
 	function enqueue_scripts() {
 
-		wp_enqueue_script( $this->get_menu_slug(), plugin_dir_url( __FILE__ ) . 'assets/image-license.js', array( 'wp-util' ), $this->version, true );
-		wp_localize_script( $this->get_menu_slug(), '_wlImageLicensePageSettings', array(
+		wp_enqueue_script($this->get_menu_slug(), plugin_dir_url(__FILE__).'assets/image-license.js', array('wp-util'), $this->version, true);
+		wp_localize_script($this->get_menu_slug(), '_wlImageLicensePageSettings', array(
 			'_ajax_nonce' => array(
-				Add_License_Caption_Or_Remove_Task::MENU_SLUG . '__single' => wp_create_nonce( Add_License_Caption_Or_Remove_Task::MENU_SLUG ),
-				Remove_All_Images_Task::MENU_SLUG . '__single'             => wp_create_nonce( Remove_All_Images_Task::MENU_SLUG ),
+				Add_License_Caption_Or_Remove_Task::MENU_SLUG.'__single' => wp_create_nonce(Add_License_Caption_Or_Remove_Task::MENU_SLUG),
+				Remove_All_Images_Task::MENU_SLUG.'__single'             => wp_create_nonce(Remove_All_Images_Task::MENU_SLUG),
 			),
 			'l10n'        => array(
-				'Done'              => __( 'Done', 'wordlift' ),
-				'An error occurred' => __( 'An error occurred', 'wordlift' ),
+				'Done'              => __('Done', 'wordlift'),
+				'An error occurred' => __('An error occurred', 'wordlift'),
 			)
-		) );
+		));
 	}
 
-	private function exists( $attachment_id ) {
+	private function exists($attachment_id) {
 		global $wpdb;
 
 		$sql =
@@ -197,12 +197,12 @@ 
               AND pm2.meta_value IS NULL
             ";
 
-		return $wpdb->get_var( $wpdb->prepare(
+		return $wpdb->get_var($wpdb->prepare(
 			$sql,
 			'_wl_image_license_fixed',
 			$attachment_id,
 			'_wp_attached_file'
-		) );
+		));
 	}
 
 }

src/wordlift/images-licenses/class-cached-image-license-service.php

Unused Use Statements -1 removed lines

@@ -5,7 +5,6 @@
 
 namespace Wordlift\Images_Licenses;
 
-use Wordlift\Api\Api_Service;
 use Wordlift\Cache\Ttl_Cache;
 
 class Cached_Image_License_Service extends Image_License_Service {

Indentation +48 added lines, -48 removed lines

@@ -10,53 +10,53 @@
 
 class Cached_Image_License_Service extends Image_License_Service {
 
-	const GET_NON_PUBLIC_DOMAIN_IMAGES = 'get_non_public_domain_images';
-
-	/**
-	 * @var Ttl_Cache
-	 */
-	private $cache_service;
-
-	/**
-	 * @var Image_License_Service
-	 */
-	private $image_license_service;
-
-	/**
-	 * Images_Licenses_Service constructor.
-	 *
-	 * @param Image_License_Service $image_license_service
-	 * @param Ttl_Cache $cache_service
-	 */
-	public function __construct( $image_license_service, $cache_service ) {
-
-		$this->image_license_service = $image_license_service;
-		$this->cache_service         = $cache_service;
-
-		$that = $this;
-		add_action( 'wp_ajax_wl_cached_image_license_service__get_non_public_domain_images', function () use ( $that ) {
-			wp_send_json_success( $that->get_non_public_domain_images() );
-		} );
-
-	}
-
-	/**
-	 * @return array
-	 */
-	public function get_non_public_domain_images() {
-
-		// Return the cached data if available.
-		$cache = $this->cache_service->get( self::GET_NON_PUBLIC_DOMAIN_IMAGES );
-		if ( ! is_null( $cache ) ) {
-			return $cache;
-		}
-
-		$data = $this->image_license_service->get_non_public_domain_images();
-
-		// Store the cached data.
-		$this->cache_service->put( self::GET_NON_PUBLIC_DOMAIN_IMAGES, $data );
-
-		return $data;
-	}
+    const GET_NON_PUBLIC_DOMAIN_IMAGES = 'get_non_public_domain_images';
+
+    /**
+     * @var Ttl_Cache
+     */
+    private $cache_service;
+
+    /**
+     * @var Image_License_Service
+     */
+    private $image_license_service;
+
+    /**
+     * Images_Licenses_Service constructor.
+     *
+     * @param Image_License_Service $image_license_service
+     * @param Ttl_Cache $cache_service
+     */
+    public function __construct( $image_license_service, $cache_service ) {
+
+        $this->image_license_service = $image_license_service;
+        $this->cache_service         = $cache_service;
+
+        $that = $this;
+        add_action( 'wp_ajax_wl_cached_image_license_service__get_non_public_domain_images', function () use ( $that ) {
+            wp_send_json_success( $that->get_non_public_domain_images() );
+        } );
+
+    }
+
+    /**
+     * @return array
+     */
+    public function get_non_public_domain_images() {
+
+        // Return the cached data if available.
+        $cache = $this->cache_service->get( self::GET_NON_PUBLIC_DOMAIN_IMAGES );
+        if ( ! is_null( $cache ) ) {
+            return $cache;
+        }
+
+        $data = $this->image_license_service->get_non_public_domain_images();
+
+        // Store the cached data.
+        $this->cache_service->put( self::GET_NON_PUBLIC_DOMAIN_IMAGES, $data );
+
+        return $data;
+    }
 
 }

Spacing +6 added lines, -6 removed lines

@@ -28,14 +28,14 @@ 
 	 * @param Image_License_Service $image_license_service
 	 * @param Ttl_Cache $cache_service
 	 */
-	public function __construct( $image_license_service, $cache_service ) {
+	public function __construct($image_license_service, $cache_service) {
 
 		$this->image_license_service = $image_license_service;
 		$this->cache_service         = $cache_service;
 
 		$that = $this;
-		add_action( 'wp_ajax_wl_cached_image_license_service__get_non_public_domain_images', function () use ( $that ) {
-			wp_send_json_success( $that->get_non_public_domain_images() );
+		add_action('wp_ajax_wl_cached_image_license_service__get_non_public_domain_images', function() use ($that) {
+			wp_send_json_success($that->get_non_public_domain_images());
 		} );
 
 	}
@@ -46,15 +46,15 @@ 
 	public function get_non_public_domain_images() {
 
 		// Return the cached data if available.
-		$cache = $this->cache_service->get( self::GET_NON_PUBLIC_DOMAIN_IMAGES );
-		if ( ! is_null( $cache ) ) {
+		$cache = $this->cache_service->get(self::GET_NON_PUBLIC_DOMAIN_IMAGES);
+		if ( ! is_null($cache)) {
 			return $cache;
 		}
 
 		$data = $this->image_license_service->get_non_public_domain_images();
 
 		// Store the cached data.
-		$this->cache_service->put( self::GET_NON_PUBLIC_DOMAIN_IMAGES, $data );
+		$this->cache_service->put(self::GET_NON_PUBLIC_DOMAIN_IMAGES, $data);
 
 		return $data;
 	}

src/wordlift/tasks/admin/class-tasks-page-base.php

Unused Use Statements -1 removed lines

@@ -14,7 +14,6 @@
 
 use Wordlift\Tasks\Task_Ajax_Adapters_Registry;
 use Wordlift\Wordpress\Submenu_Page_Base;
-use Wordlift\Wordpress\Page;
 
 abstract class Tasks_Page_Base extends Submenu_Page_Base {
 

Indentation +57 added lines, -57 removed lines

@@ -18,71 +18,71 @@
 
 abstract class Tasks_Page_Base extends Submenu_Page_Base {
 
-	/**
-	 * The ID of this admin page.
-	 *
-	 * @since    1.0.0
-	 * @access   private
-	 * @var      string $menu_slug The ID of this page.
-	 */
-	private $menu_slug;
+    /**
+     * The ID of this admin page.
+     *
+     * @since    1.0.0
+     * @access   private
+     * @var      string $menu_slug The ID of this page.
+     */
+    private $menu_slug;
 
-	/**
-	 * @var Task_Ajax_Adapters_Registry
-	 */
-	private $task_ajax_adapters_registry;
+    /**
+     * @var Task_Ajax_Adapters_Registry
+     */
+    private $task_ajax_adapters_registry;
 
-	/**
-	 * @var string
-	 */
-	private $version;
+    /**
+     * @var string
+     */
+    private $version;
 
-	/**
-	 * Define the {@link Wordlift_Admin_Page} constructor.
-	 *
-	 * @param Task_Ajax_Adapters_Registry $task_ajax_adapters_registry
-	 *
-	 * @param string $version
-	 * @param string $menu_slug
-	 * @param string $page_title
-	 * @param string $capability
-	 * @param string|null $parent_slug
-	 * @param string|null $menu_title
-	 *
-	 * @since 1.0.0
-	 */
-	public function __construct( $task_ajax_adapters_registry, $version, $menu_slug, $page_title, $capability = 'manage_options', $parent_slug = null, $menu_title = null ) {
-		parent::__construct( $menu_slug, $page_title, $capability, $parent_slug, $menu_title );
+    /**
+     * Define the {@link Wordlift_Admin_Page} constructor.
+     *
+     * @param Task_Ajax_Adapters_Registry $task_ajax_adapters_registry
+     *
+     * @param string $version
+     * @param string $menu_slug
+     * @param string $page_title
+     * @param string $capability
+     * @param string|null $parent_slug
+     * @param string|null $menu_title
+     *
+     * @since 1.0.0
+     */
+    public function __construct( $task_ajax_adapters_registry, $version, $menu_slug, $page_title, $capability = 'manage_options', $parent_slug = null, $menu_title = null ) {
+        parent::__construct( $menu_slug, $page_title, $capability, $parent_slug, $menu_title );
 
-		$this->task_ajax_adapters_registry = $task_ajax_adapters_registry;
-		$this->version                     = $version;
-		$this->menu_slug                   = $menu_slug;
+        $this->task_ajax_adapters_registry = $task_ajax_adapters_registry;
+        $this->version                     = $version;
+        $this->menu_slug                   = $menu_slug;
 
-	}
+    }
 
-	/**
-	 * Register the stylesheets and scripts for the admin area.
-	 *
-	 * @since    1.0.0
-	 */
-	public function enqueue_scripts() {
-		wp_enqueue_style( $this->menu_slug, plugin_dir_url( __FILE__ ) . 'assets/tasks-page.css', array(), $this->version, 'all' );
-		wp_enqueue_script( $this->menu_slug, plugin_dir_url( __FILE__ ) . 'assets/tasks-page.js', array(
-			'jquery',
-			'wp-util'
-		), $this->version, true );
-	}
+    /**
+     * Register the stylesheets and scripts for the admin area.
+     *
+     * @since    1.0.0
+     */
+    public function enqueue_scripts() {
+        wp_enqueue_style( $this->menu_slug, plugin_dir_url( __FILE__ ) . 'assets/tasks-page.css', array(), $this->version, 'all' );
+        wp_enqueue_script( $this->menu_slug, plugin_dir_url( __FILE__ ) . 'assets/tasks-page.js', array(
+            'jquery',
+            'wp-util'
+        ), $this->version, true );
+    }
 
-	/**
-	 * Render the page.
-	 *
-	 * @since 1.0.0
-	 */
-	public function render() {
+    /**
+     * Render the page.
+     *
+     * @since 1.0.0
+     */
+    public function render() {
 
-		// Include the partial.
-		include( plugin_dir_path( __FILE__ ) . 'assets/tasks-page.php' );
+        // Include the partial.
+        include( plugin_dir_path( __FILE__ ) . 'assets/tasks-page.php' );
 
-	}
+    }
 
 }

Spacing +6 added lines, -6 removed lines

@@ -51,8 +51,8 @@ 
 	 *
 	 * @since 1.0.0
 	 */
-	public function __construct( $task_ajax_adapters_registry, $version, $menu_slug, $page_title, $capability = 'manage_options', $parent_slug = null, $menu_title = null ) {
-		parent::__construct( $menu_slug, $page_title, $capability, $parent_slug, $menu_title );
+	public function __construct($task_ajax_adapters_registry, $version, $menu_slug, $page_title, $capability = 'manage_options', $parent_slug = null, $menu_title = null) {
+		parent::__construct($menu_slug, $page_title, $capability, $parent_slug, $menu_title);
 
 		$this->task_ajax_adapters_registry = $task_ajax_adapters_registry;
 		$this->version                     = $version;
@@ -66,11 +66,11 @@ 
 	 * @since    1.0.0
 	 */
 	public function enqueue_scripts() {
-		wp_enqueue_style( $this->menu_slug, plugin_dir_url( __FILE__ ) . 'assets/tasks-page.css', array(), $this->version, 'all' );
-		wp_enqueue_script( $this->menu_slug, plugin_dir_url( __FILE__ ) . 'assets/tasks-page.js', array(
+		wp_enqueue_style($this->menu_slug, plugin_dir_url(__FILE__).'assets/tasks-page.css', array(), $this->version, 'all');
+		wp_enqueue_script($this->menu_slug, plugin_dir_url(__FILE__).'assets/tasks-page.js', array(
 			'jquery',
 			'wp-util'
-		), $this->version, true );
+		), $this->version, true);
 	}
 
 	/**
@@ -81,7 +81,7 @@ 
 	public function render() {
 
 		// Include the partial.
-		include( plugin_dir_path( __FILE__ ) . 'assets/tasks-page.php' );
+		include(plugin_dir_path(__FILE__).'assets/tasks-page.php');
 
 	}
 

src/wordlift/tasks/admin/class-tasks-page.php

Unused Use Statements -1 removed lines

@@ -14,7 +14,6 @@
 
 use Wordlift\Tasks\Task_Ajax_Adapters_Registry;
 use Wordlift\Wordpress\Submenu_Page_Base;
-use Wordlift\Wordpress\Page;
 
 class Tasks_Page extends Submenu_Page_Base {
 

Indentation +52 added lines, -52 removed lines

@@ -18,66 +18,66 @@
 
 class Tasks_Page extends Submenu_Page_Base {
 
-	/**
-	 * The ID of this admin page.
-	 *
-	 * @since    1.0.0
-	 * @access   private
-	 * @var      string $menu_slug The ID of this page.
-	 */
-	private $menu_slug = 'wl_tasks_page';
+    /**
+     * The ID of this admin page.
+     *
+     * @since    1.0.0
+     * @access   private
+     * @var      string $menu_slug The ID of this page.
+     */
+    private $menu_slug = 'wl_tasks_page';
 
-	/**
-	 * Used when enqueueing styles or scripts as the version string.
-	 *
-	 * @since  1.0.0
-	 * @access private
-	 * @var    string
-	 */
-	private $asset_version = '1.0.0';
+    /**
+     * Used when enqueueing styles or scripts as the version string.
+     *
+     * @since  1.0.0
+     * @access private
+     * @var    string
+     */
+    private $asset_version = '1.0.0';
 
-	/**
-	 * @var Task_Ajax_Adapters_Registry
-	 */
-	private $task_ajax_adapters_registry;
+    /**
+     * @var Task_Ajax_Adapters_Registry
+     */
+    private $task_ajax_adapters_registry;
 
-	/**
-	 * Define the {@link Wordlift_Admin_Page} constructor.
-	 *
-	 * @param Task_Ajax_Adapters_Registry $task_ajax_adapters_registry
-	 *
-	 * @since 1.0.0
-	 */
-	public function __construct( $task_ajax_adapters_registry ) {
-		parent::__construct( $this->menu_slug, __( 'Tasks', 'wordlift-framework' ), 'manage_options', 'wl_admin_menu', __( 'Tasks', 'wordlift-framework' ) );
+    /**
+     * Define the {@link Wordlift_Admin_Page} constructor.
+     *
+     * @param Task_Ajax_Adapters_Registry $task_ajax_adapters_registry
+     *
+     * @since 1.0.0
+     */
+    public function __construct( $task_ajax_adapters_registry ) {
+        parent::__construct( $this->menu_slug, __( 'Tasks', 'wordlift-framework' ), 'manage_options', 'wl_admin_menu', __( 'Tasks', 'wordlift-framework' ) );
 
-		$this->task_ajax_adapters_registry = $task_ajax_adapters_registry;
+        $this->task_ajax_adapters_registry = $task_ajax_adapters_registry;
 
-	}
+    }
 
-	/**
-	 * Register the stylesheets and scripts for the admin area.
-	 *
-	 * @since    1.0.0
-	 */
-	public function enqueue_scripts() {
-		wp_enqueue_style( $this->menu_slug, plugin_dir_url( __FILE__ ) . 'assets/tasks-page.css', array(), $this->asset_version, 'all' );
-		wp_enqueue_script( $this->menu_slug, plugin_dir_url( __FILE__ ) . 'assets/tasks-page.js', array(
-			'jquery',
-			'wp-util'
-		), $this->asset_version, true );
-	}
+    /**
+     * Register the stylesheets and scripts for the admin area.
+     *
+     * @since    1.0.0
+     */
+    public function enqueue_scripts() {
+        wp_enqueue_style( $this->menu_slug, plugin_dir_url( __FILE__ ) . 'assets/tasks-page.css', array(), $this->asset_version, 'all' );
+        wp_enqueue_script( $this->menu_slug, plugin_dir_url( __FILE__ ) . 'assets/tasks-page.js', array(
+            'jquery',
+            'wp-util'
+        ), $this->asset_version, true );
+    }
 
-	/**
-	 * Render the page.
-	 *
-	 * @since 1.0.0
-	 */
-	public function render() {
+    /**
+     * Render the page.
+     *
+     * @since 1.0.0
+     */
+    public function render() {
 
-		// Include the partial.
-		include( plugin_dir_path( __FILE__ ) . 'assets/tasks-page.php' );
+        // Include the partial.
+        include( plugin_dir_path( __FILE__ ) . 'assets/tasks-page.php' );
 
-	}
+    }
 
 }

Spacing +6 added lines, -6 removed lines

@@ -48,8 +48,8 @@ 
 	 *
 	 * @since 1.0.0
 	 */
-	public function __construct( $task_ajax_adapters_registry ) {
-		parent::__construct( $this->menu_slug, __( 'Tasks', 'wordlift-framework' ), 'manage_options', 'wl_admin_menu', __( 'Tasks', 'wordlift-framework' ) );
+	public function __construct($task_ajax_adapters_registry) {
+		parent::__construct($this->menu_slug, __('Tasks', 'wordlift-framework'), 'manage_options', 'wl_admin_menu', __('Tasks', 'wordlift-framework'));
 
 		$this->task_ajax_adapters_registry = $task_ajax_adapters_registry;
 
@@ -61,11 +61,11 @@ 
 	 * @since    1.0.0
 	 */
 	public function enqueue_scripts() {
-		wp_enqueue_style( $this->menu_slug, plugin_dir_url( __FILE__ ) . 'assets/tasks-page.css', array(), $this->asset_version, 'all' );
-		wp_enqueue_script( $this->menu_slug, plugin_dir_url( __FILE__ ) . 'assets/tasks-page.js', array(
+		wp_enqueue_style($this->menu_slug, plugin_dir_url(__FILE__).'assets/tasks-page.css', array(), $this->asset_version, 'all');
+		wp_enqueue_script($this->menu_slug, plugin_dir_url(__FILE__).'assets/tasks-page.js', array(
 			'jquery',
 			'wp-util'
-		), $this->asset_version, true );
+		), $this->asset_version, true);
 	}
 
 	/**
@@ -76,7 +76,7 @@ 
 	public function render() {
 
 		// Include the partial.
-		include( plugin_dir_path( __FILE__ ) . 'assets/tasks-page.php' );
+		include(plugin_dir_path(__FILE__).'assets/tasks-page.php');
 
 	}
 

src/wordlift/tasks/class-task-single-instance-task-runner.php

Doc Comments +1 added lines, -1 removed lines

@@ -72,7 +72,7 @@
 	 *
 	 * @param Task $task The {@link Task} instance.
 	 * @param bool $force Whether to force starting a task even if another instance of the task is already running, default `false`.
-	 * @param array $callbacks An array of {@link Wordlift_For_Bungalowparkoverzicht_Progress}.
+	 * @param Task_Ajax_Progress[] $callbacks An array of {@link Wordlift_For_Bungalowparkoverzicht_Progress}.
 	 *
 	 * @since 1.0.0
 	 */

Indentation +190 added lines, -190 removed lines

@@ -24,195 +24,195 @@
  */
 class Task_Single_Instance_Task_Runner {
 
-	/**
-	 * Define the transient prefix.
-	 *
-	 * @since 1.0.0
-	 */
-	const IS_RUNNING_PREFIX = '_wf_task_runner__';
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since 1.0.0
-	 * @var Wordlift_Log_Service A {@link Wordlift_Log_Service} instance.
-	 * @access private
-	 */
-	private $log;
-
-	/**
-	 * The {@link Task} to execute.
-	 *
-	 * @since 1.0.0
-	 * @var Task $task The {@link Task} to execute.
-	 * @access private
-	 */
-	private $task;
-
-	/**
-	 * One or more callbacks to call to update about the task progress.
-	 *
-	 * @since 1.0.0
-	 * @var Task_Progress[] $callbacks An array of {@link Wordlift_For_Bungalowparkoverzicht_Progress}.
-	 * @access private
-	 */
-	private $callbacks;
-
-	/**
-	 * Whether to force starting a task even if another instance of the task is already running.
-	 *
-	 * @since 1.0.0
-	 * @var bool $force Whether to force starting a task even if another instance of the task is already running.
-	 * @access private
-	 */
-	private $force;
-
-	/**
-	 * Create a {@link Task_Single_Instance_Task_Runner} instance.
-	 *
-	 * @param Task $task The {@link Task} instance.
-	 * @param bool $force Whether to force starting a task even if another instance of the task is already running, default `false`.
-	 * @param array $callbacks An array of {@link Wordlift_For_Bungalowparkoverzicht_Progress}.
-	 *
-	 * @since 1.0.0
-	 */
-	public function __construct( $task, $force = false, $callbacks = array() ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		$this->task      = $task;
-		$this->force     = $force;
-		$this->callbacks = $callbacks;
-
-	}
-
-	/**
-	 * Get the transient name for running flag.
-	 *
-	 * @return string The transient name.
-	 * @since 1.0.0
-	 */
-	private function get_running_transient() {
-
-		return self::IS_RUNNING_PREFIX . $this->task->get_id();
-	}
-
-	/**
-	 * Check whether a task is running.
-	 *
-	 * @return bool
-	 * @since 1.0.0
-	 */
-	public function is_running() {
-		return 'yes' === get_transient( $this->get_running_transient() );
-	}
-
-	/**
-	 * Set whether the task is running or not.
-	 *
-	 * @param bool $value Whether the task is running or not.
-	 *
-	 * @since 1.0.0
-	 */
-	public function set_running( $value ) {
-		set_transient( $this->get_running_transient(), $value ? 'yes' : 'no' );
-	}
-
-	/**
-	 * Start the task.
-	 *
-	 * @param int $limit The maximum number of items to process.
-	 * @param int $offset The starting offset.
-	 *
-	 * @throws Task_Another_Instance_Is_Running_Exception if the task is already running.
-	 * @since 1.0.0
-	 */
-	public function start( $limit = 0, $offset = 0 ) {
-
-		// Bail out if the task is already running.
-		if ( ! $this->force && $this->is_running() ) {
-			throw new Task_Another_Instance_Is_Running_Exception();
-		}
-
-		// Set the task as running.
-		$this->set_running( true );
-
-		// List the chunk of elements to process.
-		$items = $this->task->list_items( $limit, $offset );
-
-		for ( $i = 0; $i < count( $items ); $i ++ ) {
-			// Process the item.
-			$this->task->process_item( $items[ $i ] );
-
-			// Update the progress.
-			$this->set_progress( $offset + $i, $items[ $i ] );
-		}
-
-		// Set the total number of elements to process.
-		$this->set_count( $this->task->count_items() );
-
-		// Unset the running flag.
-		$this->set_running( false );
-
-		// Set the task to complete.
-		$this->finish();
-
-	}
-
-	/**
-	 * Set the total number of items to process.
-	 *
-	 * @param int $value The total number of items to process.
-	 *
-	 * @since 1.0.0
-	 */
-	private function set_count( $value ) {
-
-		if ( empty( $this->callbacks ) ) {
-			return;
-		}
-
-		foreach ( $this->callbacks as $callback ) {
-			call_user_func( array( $callback, 'set_count' ), $value );
-		}
-
-	}
-
-	/**
-	 * Set the task progress.
-	 *
-	 * @param int $index The current item index.
-	 * @param mixed $item The current item.
-	 *
-	 * @since 1.0.0
-	 */
-	private function set_progress( $index, $item ) {
-
-		if ( empty( $this->callbacks ) ) {
-			return;
-		}
-
-		foreach ( $this->callbacks as $callback ) {
-			call_user_func( array( $callback, 'set_progress' ), $index, $item );
-		}
-
-	}
-
-	/**
-	 * Inform the callbacks that the task completed.
-	 *
-	 * @since 1.0.0
-	 */
-	private function finish() {
-
-		if ( empty( $this->callbacks ) ) {
-			return;
-		}
-
-		foreach ( $this->callbacks as $callback ) {
-			call_user_func( array( $callback, 'finish' ) );
-		}
-
-	}
+    /**
+     * Define the transient prefix.
+     *
+     * @since 1.0.0
+     */
+    const IS_RUNNING_PREFIX = '_wf_task_runner__';
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since 1.0.0
+     * @var Wordlift_Log_Service A {@link Wordlift_Log_Service} instance.
+     * @access private
+     */
+    private $log;
+
+    /**
+     * The {@link Task} to execute.
+     *
+     * @since 1.0.0
+     * @var Task $task The {@link Task} to execute.
+     * @access private
+     */
+    private $task;
+
+    /**
+     * One or more callbacks to call to update about the task progress.
+     *
+     * @since 1.0.0
+     * @var Task_Progress[] $callbacks An array of {@link Wordlift_For_Bungalowparkoverzicht_Progress}.
+     * @access private
+     */
+    private $callbacks;
+
+    /**
+     * Whether to force starting a task even if another instance of the task is already running.
+     *
+     * @since 1.0.0
+     * @var bool $force Whether to force starting a task even if another instance of the task is already running.
+     * @access private
+     */
+    private $force;
+
+    /**
+     * Create a {@link Task_Single_Instance_Task_Runner} instance.
+     *
+     * @param Task $task The {@link Task} instance.
+     * @param bool $force Whether to force starting a task even if another instance of the task is already running, default `false`.
+     * @param array $callbacks An array of {@link Wordlift_For_Bungalowparkoverzicht_Progress}.
+     *
+     * @since 1.0.0
+     */
+    public function __construct( $task, $force = false, $callbacks = array() ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        $this->task      = $task;
+        $this->force     = $force;
+        $this->callbacks = $callbacks;
+
+    }
+
+    /**
+     * Get the transient name for running flag.
+     *
+     * @return string The transient name.
+     * @since 1.0.0
+     */
+    private function get_running_transient() {
+
+        return self::IS_RUNNING_PREFIX . $this->task->get_id();
+    }
+
+    /**
+     * Check whether a task is running.
+     *
+     * @return bool
+     * @since 1.0.0
+     */
+    public function is_running() {
+        return 'yes' === get_transient( $this->get_running_transient() );
+    }
+
+    /**
+     * Set whether the task is running or not.
+     *
+     * @param bool $value Whether the task is running or not.
+     *
+     * @since 1.0.0
+     */
+    public function set_running( $value ) {
+        set_transient( $this->get_running_transient(), $value ? 'yes' : 'no' );
+    }
+
+    /**
+     * Start the task.
+     *
+     * @param int $limit The maximum number of items to process.
+     * @param int $offset The starting offset.
+     *
+     * @throws Task_Another_Instance_Is_Running_Exception if the task is already running.
+     * @since 1.0.0
+     */
+    public function start( $limit = 0, $offset = 0 ) {
+
+        // Bail out if the task is already running.
+        if ( ! $this->force && $this->is_running() ) {
+            throw new Task_Another_Instance_Is_Running_Exception();
+        }
+
+        // Set the task as running.
+        $this->set_running( true );
+
+        // List the chunk of elements to process.
+        $items = $this->task->list_items( $limit, $offset );
+
+        for ( $i = 0; $i < count( $items ); $i ++ ) {
+            // Process the item.
+            $this->task->process_item( $items[ $i ] );
+
+            // Update the progress.
+            $this->set_progress( $offset + $i, $items[ $i ] );
+        }
+
+        // Set the total number of elements to process.
+        $this->set_count( $this->task->count_items() );
+
+        // Unset the running flag.
+        $this->set_running( false );
+
+        // Set the task to complete.
+        $this->finish();
+
+    }
+
+    /**
+     * Set the total number of items to process.
+     *
+     * @param int $value The total number of items to process.
+     *
+     * @since 1.0.0
+     */
+    private function set_count( $value ) {
+
+        if ( empty( $this->callbacks ) ) {
+            return;
+        }
+
+        foreach ( $this->callbacks as $callback ) {
+            call_user_func( array( $callback, 'set_count' ), $value );
+        }
+
+    }
+
+    /**
+     * Set the task progress.
+     *
+     * @param int $index The current item index.
+     * @param mixed $item The current item.
+     *
+     * @since 1.0.0
+     */
+    private function set_progress( $index, $item ) {
+
+        if ( empty( $this->callbacks ) ) {
+            return;
+        }
+
+        foreach ( $this->callbacks as $callback ) {
+            call_user_func( array( $callback, 'set_progress' ), $index, $item );
+        }
+
+    }
+
+    /**
+     * Inform the callbacks that the task completed.
+     *
+     * @since 1.0.0
+     */
+    private function finish() {
+
+        if ( empty( $this->callbacks ) ) {
+            return;
+        }
+
+        foreach ( $this->callbacks as $callback ) {
+            call_user_func( array( $callback, 'finish' ) );
+        }
+
+    }
 
 }

Spacing +26 added lines, -26 removed lines

@@ -76,9 +76,9 @@ 
 	 *
 	 * @since 1.0.0
 	 */
-	public function __construct( $task, $force = false, $callbacks = array() ) {
+	public function __construct($task, $force = false, $callbacks = array()) {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		$this->task      = $task;
 		$this->force     = $force;
@@ -94,7 +94,7 @@ 
 	 */
 	private function get_running_transient() {
 
-		return self::IS_RUNNING_PREFIX . $this->task->get_id();
+		return self::IS_RUNNING_PREFIX.$this->task->get_id();
 	}
 
 	/**
@@ -104,7 +104,7 @@ 
 	 * @since 1.0.0
 	 */
 	public function is_running() {
-		return 'yes' === get_transient( $this->get_running_transient() );
+		return 'yes' === get_transient($this->get_running_transient());
 	}
 
 	/**
@@ -114,8 +114,8 @@ 
 	 *
 	 * @since 1.0.0
 	 */
-	public function set_running( $value ) {
-		set_transient( $this->get_running_transient(), $value ? 'yes' : 'no' );
+	public function set_running($value) {
+		set_transient($this->get_running_transient(), $value ? 'yes' : 'no');
 	}
 
 	/**
@@ -127,32 +127,32 @@ 
 	 * @throws Task_Another_Instance_Is_Running_Exception if the task is already running.
 	 * @since 1.0.0
 	 */
-	public function start( $limit = 0, $offset = 0 ) {
+	public function start($limit = 0, $offset = 0) {
 
 		// Bail out if the task is already running.
-		if ( ! $this->force && $this->is_running() ) {
+		if ( ! $this->force && $this->is_running()) {
 			throw new Task_Another_Instance_Is_Running_Exception();
 		}
 
 		// Set the task as running.
-		$this->set_running( true );
+		$this->set_running(true);
 
 		// List the chunk of elements to process.
-		$items = $this->task->list_items( $limit, $offset );
+		$items = $this->task->list_items($limit, $offset);
 
-		for ( $i = 0; $i < count( $items ); $i ++ ) {
+		for ($i = 0; $i < count($items); $i++) {
 			// Process the item.
-			$this->task->process_item( $items[ $i ] );
+			$this->task->process_item($items[$i]);
 
 			// Update the progress.
-			$this->set_progress( $offset + $i, $items[ $i ] );
+			$this->set_progress($offset + $i, $items[$i]);
 		}
 
 		// Set the total number of elements to process.
-		$this->set_count( $this->task->count_items() );
+		$this->set_count($this->task->count_items());
 
 		// Unset the running flag.
-		$this->set_running( false );
+		$this->set_running(false);
 
 		// Set the task to complete.
 		$this->finish();
@@ -166,14 +166,14 @@ 
 	 *
 	 * @since 1.0.0
 	 */
-	private function set_count( $value ) {
+	private function set_count($value) {
 
-		if ( empty( $this->callbacks ) ) {
+		if (empty($this->callbacks)) {
 			return;
 		}
 
-		foreach ( $this->callbacks as $callback ) {
-			call_user_func( array( $callback, 'set_count' ), $value );
+		foreach ($this->callbacks as $callback) {
+			call_user_func(array($callback, 'set_count'), $value);
 		}
 
 	}
@@ -186,14 +186,14 @@ 
 	 *
 	 * @since 1.0.0
 	 */
-	private function set_progress( $index, $item ) {
+	private function set_progress($index, $item) {
 
-		if ( empty( $this->callbacks ) ) {
+		if (empty($this->callbacks)) {
 			return;
 		}
 
-		foreach ( $this->callbacks as $callback ) {
-			call_user_func( array( $callback, 'set_progress' ), $index, $item );
+		foreach ($this->callbacks as $callback) {
+			call_user_func(array($callback, 'set_progress'), $index, $item);
 		}
 
 	}
@@ -205,12 +205,12 @@ 
 	 */
 	private function finish() {
 
-		if ( empty( $this->callbacks ) ) {
+		if (empty($this->callbacks)) {
 			return;
 		}
 
-		foreach ( $this->callbacks as $callback ) {
-			call_user_func( array( $callback, 'finish' ) );
+		foreach ($this->callbacks as $callback) {
+			call_user_func(array($callback, 'finish'));
 		}
 
 	}

src/wordlift/tasks/admin/assets/tasks-page.php

Indentation +5 added lines, -5 removed lines

@@ -13,9 +13,9 @@ 
 	<h1><?php esc_html_e( 'Tasks', 'wordlift-framework' ); ?></h1>
 
 	<?php
-	foreach ( $this->task_ajax_adapters_registry->get_task_ajax_adapters() as $task_ajax_adapter ) {
-		$task = $task_ajax_adapter->get_task();
-		?>
+    foreach ( $this->task_ajax_adapters_registry->get_task_ajax_adapters() as $task_ajax_adapter ) {
+        $task = $task_ajax_adapter->get_task();
+        ?>
 		<div class="wl-task">
 			<h2><?php esc_html_e( $task->get_label() ); ?></h2>
 			<div class="wl-task__progress" style="border: 1px solid #23282D; height: 20px; margin: 8px 0;">
@@ -32,7 +32,7 @@ 
 
 		</div>
 		<?php
-	}
-	?>
+    }
+    ?>
 
 </div>

Spacing +6 added lines, -6 removed lines

@@ -10,14 +10,14 @@ 
 
 ?>
 <div class="wrap">
-	<h1><?php esc_html_e( 'Tasks', 'wordlift-framework' ); ?></h1>
+	<h1><?php esc_html_e('Tasks', 'wordlift-framework'); ?></h1>
 
 	<?php
-	foreach ( $this->task_ajax_adapters_registry->get_task_ajax_adapters() as $task_ajax_adapter ) {
+	foreach ($this->task_ajax_adapters_registry->get_task_ajax_adapters() as $task_ajax_adapter) {
 		$task = $task_ajax_adapter->get_task();
 		?>
 		<div class="wl-task">
-			<h2><?php esc_html_e( $task->get_label() ); ?></h2>
+			<h2><?php esc_html_e($task->get_label()); ?></h2>
 			<div class="wl-task__progress" style="border: 1px solid #23282D; height: 20px; margin: 8px 0;">
 				<div class="wl-task__progress__bar"
 				     style="width:0;background: #0073AA; text-align: center; height: 100%; color: #fff;"></div>
@@ -26,9 +26,9 @@ 
 			<button
 				type="button"
 				class="button button-large button-primary"
-				data-action="<?php echo esc_attr( $task->get_id() ); ?>"
-				data-nonce="<?php echo esc_attr( wp_create_nonce( $task->get_id() ) ); ?>"
-			><?php esc_html_e( 'Start', 'wordlift-framework' ); ?></button>
+				data-action="<?php echo esc_attr($task->get_id()); ?>"
+				data-nonce="<?php echo esc_attr(wp_create_nonce($task->get_id())); ?>"
+			><?php esc_html_e('Start', 'wordlift-framework'); ?></button>
 
 		</div>
 		<?php

src/wordlift/tasks/class-task-progress.php

Indentation +23 added lines, -23 removed lines

@@ -16,30 +16,30 @@
  */
 interface Task_Progress {
 
-	/**
-	 * The total number of elements to process.
-	 *
-	 * @param int $value The total number of elements to process.
-	 *
-	 * @since 1.0.0
-	 */
-	function set_count( $value );
+    /**
+     * The total number of elements to process.
+     *
+     * @param int $value The total number of elements to process.
+     *
+     * @since 1.0.0
+     */
+    function set_count( $value );
 
-	/**
-	 * Set the current processed item.
-	 *
-	 * @param int $counter The current item.
-	 * @param mixed $item The current item.
-	 *
-	 * @since 1.0.0
-	 */
-	function set_progress( $counter, $item );
+    /**
+     * Set the current processed item.
+     *
+     * @param int $counter The current item.
+     * @param mixed $item The current item.
+     *
+     * @since 1.0.0
+     */
+    function set_progress( $counter, $item );
 
-	/**
-	 * Set the operation as complete.
-	 *
-	 * @since 1.0.0
-	 */
-	function finish();
+    /**
+     * Set the operation as complete.
+     *
+     * @since 1.0.0
+     */
+    function finish();
 
 }

Spacing +2 added lines, -2 removed lines

@@ -23,7 +23,7 @@ 
 	 *
 	 * @since 1.0.0
 	 */
-	function set_count( $value );
+	function set_count($value);
 
 	/**
 	 * Set the current processed item.
@@ -33,7 +33,7 @@ 
 	 *
 	 * @since 1.0.0
 	 */
-	function set_progress( $counter, $item );
+	function set_progress($counter, $item);
 
 	/**
 	 * Set the operation as complete.

src/wordlift/tasks/class-task-ajax-adapters-registry.php

Indentation +16 added lines, -16 removed lines

@@ -4,29 +4,29 @@
 
 class Task_Ajax_Adapters_Registry {
 
-	private $task_ajax_adapters = array();
+    private $task_ajax_adapters = array();
 
-	public function __construct( $adapters = array() ) {
+    public function __construct( $adapters = array() ) {
 
-		$this->task_ajax_adapters = is_array( $adapters ) ? $adapters : array( $adapters );
+        $this->task_ajax_adapters = is_array( $adapters ) ? $adapters : array( $adapters );
 
-	}
+    }
 
-	/**
-	 * @param Task_Ajax_Adapter $task_ajax_adapter
-	 */
-	public function register( $task_ajax_adapter ) {
+    /**
+     * @param Task_Ajax_Adapter $task_ajax_adapter
+     */
+    public function register( $task_ajax_adapter ) {
 
-		$this->task_ajax_adapters[] = $task_ajax_adapter;
+        $this->task_ajax_adapters[] = $task_ajax_adapter;
 
-	}
+    }
 
-	/**
-	 * @return Task_Ajax_Adapter[]
-	 */
-	public function get_task_ajax_adapters() {
+    /**
+     * @return Task_Ajax_Adapter[]
+     */
+    public function get_task_ajax_adapters() {
 
-		return $this->task_ajax_adapters;
-	}
+        return $this->task_ajax_adapters;
+    }
 
 }

Spacing +3 added lines, -3 removed lines

@@ -6,16 +6,16 @@
 
 	private $task_ajax_adapters = array();
 
-	public function __construct( $adapters = array() ) {
+	public function __construct($adapters = array()) {
 
-		$this->task_ajax_adapters = is_array( $adapters ) ? $adapters : array( $adapters );
+		$this->task_ajax_adapters = is_array($adapters) ? $adapters : array($adapters);
 
 	}
 
 	/**
 	 * @param Task_Ajax_Adapter $task_ajax_adapter
 	 */
-	public function register( $task_ajax_adapter ) {
+	public function register($task_ajax_adapter) {
 
 		$this->task_ajax_adapters[] = $task_ajax_adapter;
 

src/wordlift/tasks/class-task-ajax-progress.php

Indentation +79 added lines, -79 removed lines

@@ -18,84 +18,84 @@
  */
 class Task_Ajax_Progress implements Task_Progress {
 
-	/**
-	 * The AJAX action, used to generate new nonces.
-	 *
-	 * @since 1.0.0
-	 * @access private
-	 * @var string $action The AJAX action.
-	 */
-	private $action;
-
-	/**
-	 * The total number of items to process.
-	 *
-	 * @since 1.0.0
-	 * @access private
-	 * @var int The total number of items to process.
-	 */
-	private $count;
-
-	/**
-	 * The current item index.
-	 *
-	 * @since 1.0.0
-	 * @access private
-	 * @var int $index The current item index.
-	 */
-	private $index;
-
-	/**
-	 * @var Wordlift_Log_Service
-	 */
-	private $log;
-
-	/**
-	 * Create a Task_Ajax_Progress instance with the specified
-	 * AJAX action.
-	 *
-	 * @param string $action The AJAX action.
-	 *
-	 * @since 1.0.0
-	 *
-	 */
-	public function __construct( $action ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		$this->action = $action;
-
-	}
-
-	/**
-	 * {@inheritDoc}
-	 */
-	function set_count( $value ) {
-
-		$this->log->debug( "New count $value for action $this->action..." );
-
-		$this->count = $value;
-
-	}
-
-	/**
-	 * {@inheritDoc}
-	 */
-	function set_progress( $index, $item ) {
-		$this->index = $index;
-	}
-
-	/**
-	 * {@inheritDoc}
-	 */
-	function finish() {
-		wp_send_json_success( array(
-			'count'    => $this->count,
-			'index'    => $this->index,
-			// $this->index is zero based.
-			'complete' => $this->index >= $this->count - 1,
-			'nonce'    => wp_create_nonce( $this->action ),
-		) );
-	}
+    /**
+     * The AJAX action, used to generate new nonces.
+     *
+     * @since 1.0.0
+     * @access private
+     * @var string $action The AJAX action.
+     */
+    private $action;
+
+    /**
+     * The total number of items to process.
+     *
+     * @since 1.0.0
+     * @access private
+     * @var int The total number of items to process.
+     */
+    private $count;
+
+    /**
+     * The current item index.
+     *
+     * @since 1.0.0
+     * @access private
+     * @var int $index The current item index.
+     */
+    private $index;
+
+    /**
+     * @var Wordlift_Log_Service
+     */
+    private $log;
+
+    /**
+     * Create a Task_Ajax_Progress instance with the specified
+     * AJAX action.
+     *
+     * @param string $action The AJAX action.
+     *
+     * @since 1.0.0
+     *
+     */
+    public function __construct( $action ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        $this->action = $action;
+
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    function set_count( $value ) {
+
+        $this->log->debug( "New count $value for action $this->action..." );
+
+        $this->count = $value;
+
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    function set_progress( $index, $item ) {
+        $this->index = $index;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    function finish() {
+        wp_send_json_success( array(
+            'count'    => $this->count,
+            'index'    => $this->index,
+            // $this->index is zero based.
+            'complete' => $this->index >= $this->count - 1,
+            'nonce'    => wp_create_nonce( $this->action ),
+        ) );
+    }
 
 }

Spacing +8 added lines, -8 removed lines

@@ -59,9 +59,9 @@ 
 	 * @since 1.0.0
 	 *
 	 */
-	public function __construct( $action ) {
+	public function __construct($action) {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		$this->action = $action;
 
@@ -70,9 +70,9 @@ 
 	/**
 	 * {@inheritDoc}
 	 */
-	function set_count( $value ) {
+	function set_count($value) {
 
-		$this->log->debug( "New count $value for action $this->action..." );
+		$this->log->debug("New count $value for action $this->action...");
 
 		$this->count = $value;
 
@@ -81,7 +81,7 @@ 
 	/**
 	 * {@inheritDoc}
 	 */
-	function set_progress( $index, $item ) {
+	function set_progress($index, $item) {
 		$this->index = $index;
 	}
 
@@ -89,13 +89,13 @@ 
 	 * {@inheritDoc}
 	 */
 	function finish() {
-		wp_send_json_success( array(
+		wp_send_json_success(array(
 			'count'    => $this->count,
 			'index'    => $this->index,
 			// $this->index is zero based.
 			'complete' => $this->index >= $this->count - 1,
-			'nonce'    => wp_create_nonce( $this->action ),
-		) );
+			'nonce'    => wp_create_nonce($this->action),
+		));
 	}
 
 }