Add/new listings importer

includes/importer/class-abstract-callable-post-create.php

@@ -0,0 +1,42 @@
+<?php
+/**
+ * Custom implementation which provides a mechanism for users to tie into the Newspack Listings Import process.
+ *
+ * @package Newspack_Listings.
+ */
+
+namespace Newspack_Listings\Importer;
+
+use Newspack_Listings\Contracts\Importer_Mode;
+use WP_Post;
+
+/**
+ * Abstract Class which establishes that a callable must be defined and returned.
+ */
+abstract class Abstract_Callable_Post_Create {
+
+	/**
+	 * Constructor to prevent initialization.
+	 */
+	final public function __construct() {
+		// Prevent instantiation.
+	}
+
+	/**
+	 * Abstract function, forcing the child class to create a user-defined function.
+	 *
+	 * @return callable
+	 */
+	abstract protected function get_callable(): callable;
+
+	/**
+	 * Automatically execute Abstract_Callable_Post_create class when instantiated.
+	 *
+	 * @param WP_Post       $listing Newspack Listing Post.
+	 * @param Importer_Mode $importer_mode Newspack Listing Import Mode.
+	 * @param array         $row Row of data from import file.
+	 */
+	public function __invoke( WP_Post $listing, Importer_Mode $importer_mode, array $row = [] ) {
+		$this->get_callable()( $listing, $importer_mode, $row );
+	}
+}

includes/importer/class-abstract-callable-pre-create.php

@@ -0,0 +1,40 @@
+<?php
+/**
+ * Custom implementation which provides a mechanism for users to tie into the Newspack Listings Import process.
+ *
+ * @package Newspack_Listings.
+ */
+
+namespace Newspack_Listings\Importer;
+
+use Newspack_Listings\Contracts\Importer_Mode;
+
+/**
+ * Abstract Class which establishes that a callable must be defined and returned.
+ */
+abstract class Abstract_Callable_Pre_Create {
+
+	/**
+	 * Constructor.
+	 */
+	final public function __construct() {
+		// Prevent instantiation.
+	}
+
+	/**
+	 * Abstract function, forcing the child class to create a user-defined function.
+	 *
+	 * @return callable
+	 */
+	abstract protected function get_callable(): callable;
+
+	/**
+	 * Automatically execute Abstract_Callable_Pre_Create class when instantiated.
+	 *
+	 * @param array         $row Row of data from import file.
+	 * @param Importer_Mode $importer_mode Newspack Listing Import Mode.
+	 */
+	public function __invoke( array &$row, Importer_Mode $importer_mode ) {
+		$this->get_callable()( $row, $importer_mode );
+	}
+}

includes/importer/class-abstract-file.php

@@ -0,0 +1,112 @@
+<?php
+/**
+ * Abstract class definition of File.
+ *
+ * @package Newspack_Listings
+ */
+
+namespace Newspack_Listings;
+
+use Exception;
+
+/**
+ * Abstract File class, handles low level loading of file and basic functions.
+ */
+abstract class Abstract_File implements Contracts\File {
+
+	/**
+	 * File's full path.
+	 *
+	 * @var string $path
+	 */
+	protected string $path;
+
+	/**
+	 * The file resource handle.
+	 *
+	 * @var resource $handle
+	 */
+	protected $handle = null;
+
+	/**
+	 * File's name, including file extension.
+	 *
+	 * @var string $name
+	 */
+	protected string $name;
+
+	/**
+	 * File's size in MB.
+	 *
+	 * @var int $size
+	 */
+	protected int $size;
+
+	/**
+	 * Constructor. For now this class expects the file to exist on the system.
+	 *
+	 * @param string $path Full file path.
+	 * @throws Exception If file does not exist.
+	 */
+	public function __construct( string $path ) {
+		if ( ! file_exists( $path ) ) {
+			throw new Exception( 'File does not exist!' );
+		}
+
+		$this->path = $path;
+		$parts = explode( '/', $path );
+		$this->name = array_pop( $parts );
+		$this->size = filesize( $this->path ) / 1024;
+	}
+
+	/**
+	 * Returns the file's full path.
+	 *
+	 * @inheritDoc
+	 */
+	public function get_path(): string {
+		return $this->path;
+	}
+
+
+	/**
+	 * Returns a resource stream to the open file.
+	 *
+	 * @return resource
+	 */
+	public function get_handle() {
+		if ( is_null( $this->handle ) ) {
+			$this->handle = fopen( $this->get_path(), 'r' );
+		}
+
+		return $this->handle;
+	}
+
+	/**
+	 * Returns the file's name, with file extension.
+	 *
+	 * @inheritDoc
+	 */
+	public function get_name(): string {
+		return $this->name;
+	}
+
+	/**
+	 * Returns the file's size, in MB.
+	 *
+	 * @inheritDoc
+	 */
+	public function get_size(): int {
+		return $this->size;
+	}
+
+	/**
+	 * Destructor.
+	 */
+	public function __destruct() {
+		if ( is_resource( $this->handle ) ) {
+			// phpcs:ignore WordPress.WP.AlternativeFunctions.file_system_read_fclose
+			fclose( $this->handle );
+		}
+	}
+}

includes/importer/class-abstract-iterable-file.php

@@ -0,0 +1,83 @@
+<?php
+/**
+ * Abstract implementation of Iterable_File.
+ *
+ * @package Newspack_Listings
+ */
+
+namespace Newspack_Listings;
+
+use Exception;
+use Newspack_Listings\Contracts\Iterable_File;
+
+/**
+ * Abstract implementation of Iterable File contract.
+ */
+abstract class Abstract_Iterable_File extends Abstract_File implements Contracts\Iterable_File {
+
+	/**
+	 * The row/line the iteration should begin at.
+	 *
+	 * @var int $start Default to 0 for first row/line.
+	 */
+	protected int $start = 0;
+
+	/**
+	 * The row/line at which the iteration should terminate.
+	 *
+	 * @var int $end Default value max integer.
+	 */
+	protected int $end = PHP_INT_MAX;
+
+	/**
+	 * Setter for $start.
+	 *
+	 * @param int $start Row/line to start iteration at.
+	 * @returns Iterable_File
+	 * @throws Exception Thrown if $start is greater than $end.
+	 */
+	public function set_start( int $start = 0 ): Iterable_File {
+		if ( $start > $this->end ) {
+			throw new Exception( 'Start cannot be greater than End.' );
+		}
+
+		$this->start = $start;
+
+		return $this;
+	}
+
+	/**
+	 * Returns the integer value representing the row/line at which iteration should begin.
+	 *
+	 * @returns int
+	 */
+	public function get_start(): int {
+		return $this->start;
+	}
+
+	/**
+	 * Setter for $end.
+	 *
+	 * @param int $end Row/line to end iteration at.
+	 * @returns Iterable_File
+	 * @throws Exception Thrown if $end is less than $start.
+	 */
+	public function set_end( int $end = PHP_INT_MAX ): Iterable_File {
+		if ( $end < $this->start ) {
+			throw new Exception( 'End cannot be less than Start.' );
+		}
+
+		$this->end = $end;
+
+		return $this;
+	}
+
+	/**
+	 * Returns the integer value representing the row/line at which iteration should end.
+	 *
+	 * @returns integer
+	 */
+	public function get_end(): int {
+		return $this->end;
+	}
+}