ModelQueryBuilder.php 2.76 KB
<?php
/**
 * @license GPL-3.0-or-later
 *
 * Modified by learndash on 20-September-2023 using Strauss.
 * @see https://github.com/BrianHenryIE/strauss
 */

namespace StellarWP\Learndash\StellarWP\Models;

use InvalidArgumentException;
use StellarWP\Learndash\StellarWP\DB\DB;
use StellarWP\Learndash\StellarWP\DB\QueryBuilder\QueryBuilder;
use StellarWP\Learndash\StellarWP\DB\QueryBuilder\Clauses\RawSQL;
use StellarWP\Learndash\StellarWP\Models\Model;

/**
 * @since 1.0.0
 */
class ModelQueryBuilder extends QueryBuilder {
	/**
	 * @var class-string<Model>
	 */
	protected $model;

	/**
	 * @param class-string<Model> $modelClass
	 */
	public function __construct( string $modelClass ) {
		if ( ! is_subclass_of( $modelClass, Model::class ) ) {
			throw new InvalidArgumentException( "$modelClass must be an instance of " . Model::class );
		}

		$this->model = $modelClass;
	}

	/**
	 * Returns the number of rows returned by a query
	 *
	 * @since 1.0.0
	 *
	 * @param null|string $column
	 */
	public function count( $column = null ) : int {
		$column = ( ! $column || $column === '*' ) ? '1' : trim( $column );

		if ( '1' === $column ) {
			$this->selects = [];
		}
		$this->selects[] = new RawSQL( 'SELECT COUNT(%1s) AS count', $column );

		return +parent::get()->count;
	}

	/**
	 * Get row
	 *
	 * @since 1.0.0
	 *
	 * @param string $output
	 *
	 * @return Model|null
	 */
	public function get( $output = OBJECT ) : ?Model {
		$row = DB::get_row( $this->getSQL(), OBJECT );

		if ( ! $row ) {
			return null;
		}

		return $this->getRowAsModel( $row );
	}

	/**
	 * Get results
	 *
	 * @since 1.0.0
	 *
	 * @return Model[]|null
	 */
	public function getAll( $output = OBJECT ) : ?array {
		$results = DB::get_results( $this->getSQL(), OBJECT );

		if ( ! $results ) {
			return null;
		}

		if ( isset( $this->model ) ) {
			return $this->getAllAsModel( $results );
		}

		return $results;
	}

	/**
	 * Get row as model
	 *
	 * @since 1.0.0
	 *
	 * @param object|null $row
	 *
	 * @return Model|null
	 */
	protected function getRowAsModel( $row ) {
		$model = $this->model;

		if ( ! method_exists( $model, 'fromQueryBuilderObject' ) ) {
			throw new InvalidArgumentException( "fromQueryBuilderObject missing from $model" );
		}

		return $model::fromQueryBuilderObject( $row );
	}

	/**
	 * Get results as models
	 *
	 * @since 1.0.0
	 *
	 * @param object[] $results
	 *
	 * @return Model[]|null
	 */
	protected function getAllAsModel( array $results ) {
		/** @var Contracts\ModelCrud $model */
		$model = $this->model;

		if ( ! method_exists( $model, 'fromQueryBuilderObject' ) ) {
			throw new InvalidArgumentException( "fromQueryBuilderObject missing from $model" );
		}

		return array_map( static function( $object ) use ( $model ) {
			return $model::fromQueryBuilderObject( $object );
		}, $results );
	}
}