mrcnpdlk/mojepanstwo-api

<?php
/**
 * MOJEPANSTWO-API
 *
 * Copyright © 2017 pudelek.org.pl
 *
 * @license MIT License (MIT)
 *
 * For the full copyright and license information, please view source file
 * that is bundled with this package in the file LICENSE
 *
 * @author  Marcin Pudełek <marcin@pudelek.org.pl>
 */
declare (strict_types=1);

namespace mrcnpdlk\MojePanstwo;


use mrcnpdlk\MojePanstwo\Model\ModelAbstract;
use mrcnpdlk\MojePanstwo\Model\SearchResponse;
use mrcnpdlk\MojePanstwo\Model\SearchResponseItem;
use mrcnpdlk\MojePanstwo\Model\SearchResponseLinks;

class QueryBuilder
{
    /**
     * @var array
     */
    private $query = [];
    /**
     * @var string
     */
    private $sContext;
    /**
     * @var string
     */
    private $sPrefixedContext;
    /**
     * @var string|null
     */
    private $sReturnedClass;

    /**
     * QueryBuilder constructor.
     *
     * @param string|null $returnedClass
     *
     * @throws \mrcnpdlk\MojePanstwo\Exception
     */
    private function __construct(string $returnedClass)
    {
        if (!class_exists($returnedClass)) {
            throw new Exception(sprintf('Cannot create QueryBuilder instance. Class [%s] not defined', $returnedClass));
        }
        $reflectionA = new \ReflectionClass($returnedClass);
        if (!$reflectionA->isSubclassOf(ModelAbstract::class)) {
            throw new Exception(sprintf('Cannot create QueryBuilder instance. Class [%s] not extend ModelAbstract', $returnedClass));
        }

        $this->query['conditions'] = [];
        $this->query['order']      = null;
        $this->query['page']       = null;
        $this->query['limit']      = null;
        $this->sReturnedClass      = $returnedClass;
        /** @noinspection PhpUndefinedFieldInspection */
        $this->sContext         = $returnedClass::CONTEXT;
        $this->sPrefixedContext = '/dane/' . $this->sContext;
    }

    /**
     * @param string|null $returnedClass
     *
     * @return \mrcnpdlk\MojePanstwo\QueryBuilder
     */
    public static function create(string $returnedClass): QueryBuilder
    {
        return new QueryBuilder($returnedClass);
    }

    /**
     * @param string $layerName
     *
     * @return $this
     */
    public function addLayer(string $layerName)
    {
        $this->query['layers'][] = $layerName;

        return $this;
    }

    /**
     * Find object having ID
     *
     * @param string|int $id
     *
     * @return mixed
     * @throws \mrcnpdlk\MojePanstwo\Exception
     */
    public function find($id)
    {
        $res = Api::getInstance()
                  ->getClient()
                  ->request($this->sPrefixedContext, (string)$id, $this)
        ;

        return new $this->sReturnedClass($res->data ?? null, $res->layers ?? null);
    }

    /**
     * Search result
     *
     * @return SearchResponse
     * @throws \mrcnpdlk\MojePanstwo\Exception
     */
    public function get(): SearchResponse
    {

        $res    = Api::getInstance()
                     ->getClient()
                     ->request($this->sPrefixedContext, null, $this)
        ;
        $oLinks = new SearchResponseLinks(
            $res->Links->self ?? null,
            $res->Links->first ?? $res->Links->self ?? null,
            $res->Links->next ?? null,
            $res->Links->last ?? null,
            $res->Links->prev ?? null
        );
        $items  = [];
        foreach ((array)$res->Dataobject as $i) {
            $oItem             = new SearchResponseItem();
            $oItem->id         = (int)$i->id;
            $oItem->dataset    = $i->dataset;
            $oItem->url        = $i->url;
            $oItem->mp_url     = $i->mp_url;
            $oItem->schema_url = $i->schema_url;
            $oItem->global_id  = (int)$i->global_id;
            $oItem->slug       = $i->slug;
            $oItem->score      = $i->score;
            $oItem->data       = new $this->sReturnedClass($i->data ?? null);
            $items[]           = $oItem;
        }

        return new SearchResponse($res->Count, $res->Took, $oLinks, $items);
    }

    /**
     * Return params as formatted string
     *
     * @return string
     */
    public function getQuery(): string
    {
        if (empty($this->query['order'])) {
            unset($this->query['order']);
        }
        if (empty($this->query['page'])) {
            unset($this->query['page']);
        }
        if (empty($this->query['limit'])) {
            unset($this->query['limit']);
        }

        return http_build_query($this->query);

    }

    /**
     * @param int $limit
     *
     * @return $this
     */
    public function limit(int $limit = 50)
    {
        $this->query['limit'] = $limit;

        return $this;
    }

    /**
     * Order by option settings
     *
     * @param string $property
     * @param string $order
     *
     * @return $this
     */
    public function orderBy(string $property, string $order = 'asc')
    {
        if (empty($this->sContext)) {
            $this->query['order'] = $property . ' ' . $order;
        } else {
            $this->query['order'] = $this->sContext . '.' . $property . ' ' . $order;
        }


        return $this;
    }

    /**
     * Get page number
     *
     * @param int $page
     *
     * @return $this
     */
    public function page(int $page = 1)
    {
        $this->query['page'] = $page < 1 ? 1 : $page;

        return $this;
    }

    /**
     * Where option settings
     *
     * @param string $property
     * @param        $value
     *
     * @return $this
     */
    public function where(string $property = null, $value)
    {
        if (null === $property || 'q' === $property) {
            return $this->whereQ($value);
        }
        if (empty($this->sContext)) {
            $this->query['conditions'][$property] = $value;
        } else {
            $this->query['conditions'][sprintf('%s.%s', $this->sContext, $property)] = $value;
        }


        return $this;
    }

    /**
     * Full text search WHERE
     *
     * @param $value
     *
     * @return $this
     */
    public function whereQ($value)
    {
        $this->query['conditions']['q'] = $value;

        return $this;
    }

}