Soheilrt\AdobeConnectClient\Client\Filter

Complexity

Total Complexity

15

Size/Duplication

Total Lines	200
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	setFilter()	0	8	2
A	isMember()	0	5	1
A	removeField()	0	12	1
A	equals()	0	5	1
A	rows()	0	5	1
A	like()	0	5	1
A	dateBefore()	0	9	2
A	instance()	0	3	1
A	out()	0	5	1
A	start()	0	5	1
A	toArray()	0	3	1
A	dateAfter()	0	9	2

<?php

namespace Soheilrt\AdobeConnectClient\Client;

use DateTime;
use DateTimeInterface;
use Soheilrt\AdobeConnectClient\Client\Contracts\ArrayableInterface;
use Soheilrt\AdobeConnectClient\Client\Helpers\StringCaseTransform as SCT;
use Soheilrt\AdobeConnectClient\Client\Helpers\ValueTransform as VT;

/**
 * Create valid filters using Fluent Interface.
 *
 * See {@link https://helpx.adobe.com/content/help/en/adobe-connect/webservices/filter-definition.html}
 */
class Filter implements ArrayableInterface
{
    /**
     * @var array
     */
    protected $filters = [];

    /**
     * Prefix to use in filters to indicate it's filter.
     *
     * @var string
     */
    protected $prefix = 'filter';

    /**
     * Return a new Filter instance.
     *
     * @return Filter
     */
    public static function instance(): Filter
    {
        return new static();
    }

    /**
     * Returns if exactly matches.
     *
     * @param string $field The Field in camelCase
     * @param mixed  $value The Value to compare
     *
     * @return Filter Fluent Interface
     */
    public function equals($field, $value): Filter
    {
        $this->setFilter('', $field, $value);

        return $this;
    }

    /**
     * Set the Filter.
     *
     * @param string $operator
     * @param string $field
     * @param mixed  $value
     */
    protected function setFilter($operator, $field, $value): void
    {
        $filterName = $this->prefix
            . '-'
            . ($operator ? $operator . '-' : '')
            . SCT::toHyphen($field);

        $this->filters[$filterName] = VT::toString($value);
    }

    /**
     * Returns even if is not an exact match.
     *
     * @param string $field The Field in camelCase
     * @param mixed  $value The Value to compare
     *
     * @return Filter Fluent Interface
     */
    public function like($field, $value): Filter
    {
        $this->setFilter('like', $field, $value);

        return $this;
    }

    /**
     * Filters out or excludes.
     *
     * @param string $field The Field in camelCase
     * @param mixed  $value The Value to compare
     *
     * @return Filter Fluent Interface
     */
    public function out($field, $value): Filter
    {
        $this->setFilter('out', $field, $value);

        return $this;
    }

    /**
     * Limits the results to the number of rows specified.
     *
     * @param int $limit The limit rows
     *
     * @return Filter Fluent Interface
     */
    public function rows($limit): Filter
    {
        $this->setFilter('', 'rows', $limit);

        return $this;
    }

    /**
     * Starts the results at the index number specified.
     *
     * @param int $offset The initial index
     *
     * @return Filter Fluent Interface
     */
    public function start($offset): Filter
    {
        $this->setFilter('', 'start', $offset);

        return $this;
    }

    /**
     * Selects all items with a date after.
     *
     * @param string            $dateField The Date Field in camelCase
     * @param DateTimeInterface $date      The value to compare
     * @param bool              $inclusive Filter inclusive the date
     *
     * @return Filter Fluent Interface
     */
    public function dateAfter($dateField, DateTimeInterface $date, $inclusive = true): Filter
    {
        $this->setFilter(
            $inclusive ? 'gte' : 'gt',
            $dateField,
            $date->format(DateTime::W3C)
        );

        return $this;
    }

    /**
     * Selects all items with a date earlier.
     *
     * @param string            $dateField The Date Field in camelCase
     * @param DateTimeInterface $date      The value to compare
     * @param bool              $inclusive Filter inclusive the date
     *
     * @return Filter Fluent Interface
     */
    public function dateBefore($dateField, DateTimeInterface $date, $inclusive = true): Filter
    {
        $this->setFilter(
            $inclusive ? 'lte' : 'lt',
            $dateField,
            $date->format(DateTime::W3C)
        );

        return $this;
    }

    /**
     * Selects all principals that are members of a group, specified in a separate parameter.
     *
     * @param mixed $value The value to compare
     *
     * @return Filter Fluent Interface
     */
    public function isMember($value): Filter
    {
        $this->setFilter('', 'ismember', $value);

        return $this;
    }

    /**
     * Remove all filters using the Field.
     *
     * @param string $field The Field in camelCase
     *
     * @return Filter
     */
    public function removeField($field): Filter
    {
        $field = SCT::toHyphen($field);
        $this->filters = array_filter(
            $this->filters,
            static function ($filter) use ($field) {
                return mb_strpos($filter, $field) === false;
            },
            ARRAY_FILTER_USE_KEY
        );

        return $this;
    }

    /**
     * Retrieves all not null attributes in an associative array.
     *
     * The keys in hash style: Ex: is-member
     * The values as string
     *
     * @return string[]
     */
    public function toArray(): array
    {
        return $this->filters;
    }
}