src/Dto/SearchOptions.php line 15

Open in your IDE?
  1. <?php
  2. /*
  3.  * Author: Dominik Piekarski <code@dompie.de>
  4.  * Created at: 2020/10/13 12:23
  5.  */
  6. declare(strict_types=1);
  8. namespace App\Dto;
  10. use App\Dictionary\Content;
  11. use App\Dictionary\SearchType;
  12. use App\Form\Search\GlobalSearch;
  13. use Symfony\Component\HttpFoundation\InputBag;
  15. class SearchOptions
  16. {
  17.     private const DEFAULT_SUGGEST_SEARCH = false;
  18.     private const DEFAULT_SEARCH_TYPE = SearchType::ALL;
  19.     private const DEFAULT_PAGE = 1;
  20.     private const DEFAULT_PER_PAGE = 9;
  21.     public const DEFAULT_REGION = SearchType::ALL;
  22.     public const DEFAULT_AGE = SearchType::ALL;
  23.     public const DEFAULT_MIN_AGE = 18;
  24.     public const DEFAULT_MAX_AGE = 127;
  25.     public const DEFAULT_ONLINE = SearchType::ALL;
  26.     public const ONLINE_ONLY = 'on';
  27.     public const ONLINE_LIVECAM = 'livecam';
  28.     public const DEFAULT_GENDER = SearchType::ALL;
  29.     public const DEFAULT_MEMBER_TYPE = SearchType::ALL;
  30.     public const MEMBER_TYPE_AMATEUR = 'amateur';
  31.     public const MEMBER_TYPE_MEMBER = 'member';
  32.     private const DEFAULT_TERM = '';
  33.     public const DEFAULT_VIDEO_RESOLUTION = 0;
  34.     public const DEFAULT_SINCE = 0;
  35.     public const DEFAULT_MIN_RATING = 0.0;
  36.     public const DEFAULT_MAX_RATING = 5.0;
  37.     public const DEFAULT_MIN_DURATION = 0;
  38.     public const DEFAULT_MAX_DURATION = 32000;
  39.     private const MAX_PER_PAGE = 200;
  40.     private const MAX_TERM_LENGTH = 200;
  41.     public const DEFAULT_MIN_IMAGES = 10;
  42.     public const DEFAULT_MAX_IMAGES = 300;
  44.     public array $options = [];
  46.     public function __construct()
  47.     {
  48.         $this->initDefaults();
  49.     }
  51.     public function setSuggestSearch(bool $do = self::DEFAULT_SUGGEST_SEARCH): self
  52.     {
  53.         $this->options['isSuggest'] = $do;
  54.         return $this;
  55.     }
  57.     public function isSuggestSearch(): bool
  58.     {
  59.         return $this->options['isSuggest'] ?? self::DEFAULT_SUGGEST_SEARCH;
  60.     }
  62.     public function getOnline(): string
  63.     {
  64.         return $this->options['online'] ?? self::DEFAULT_ONLINE;
  65.     }
  67.     public function isOnlineOnly(): bool
  68.     {
  69.         return $this->getOnline() === self::ONLINE_ONLY;
  70.     }
  72.     public function isWebcamOnly(): bool
  73.     {
  74.         return $this->getOnline() === self::ONLINE_LIVECAM;
  75.     }
  77.     public function setOnline(string $online): self
  78.     {
  79.         $this->options['online'] = $online;
  80.         return $this;
  81.     }
  83.     public function hasOnlineFilter(): bool
  84.     {
  85.         return $this->getOnline() !== self::DEFAULT_ONLINE;
  86.     }
  88.     public function setProfilePhotoOnly(string $value): self
  89.     {
  90.         $this->options['withProfilePhotoOnly'] = true;
  91.         return $this;
  92.     }
  94.     public function getProfilePhotoOnly(): bool
  95.     {
  96.         return $this->options['withProfilePhotoOnly'] ?? false;
  97.     }
  99.     public function isProfilePhotoOnly(): bool
  100.     {
  101.         return $this->getProfilePhotoOnly();
  102.     }
  104.     public function getTerm(bool $lowercase = true): string
  105.     {
  106.         $term = $this->options['term'] ?? self::DEFAULT_TERM;
  107.         if ($lowercase) {
  108.             return mb_strtolower($term);
  109.         }
  110.         return $term;
  111.     }
  113.     public function setTerm($term = ''): self
  114.     {
  115.         $this->options['term'] = mb_substr((string)$term, 0, self::MAX_TERM_LENGTH);
  116.         return $this;
  117.     }
  119.     public function getSearchType(): string
  120.     {
  121.         return $this->options['searchType'] ?? self::DEFAULT_SEARCH_TYPE;
  122.     }
  124.     public function setSearchType(string $searchType = self::DEFAULT_SEARCH_TYPE): self
  125.     {
  126.         $this->options['searchType'] = $searchType;
  127.         return $this;
  128.     }
  130.     public function getMemberType(): string
  131.     {
  132.         return $this->options['memberType'] ?? self::DEFAULT_MEMBER_TYPE;
  133.     }
  135.     public function setMemberType(string $memberType = self::DEFAULT_MEMBER_TYPE): self
  136.     {
  137.         $this->options['memberType'] = $memberType;
  138.         return $this;
  139.     }
  141.     public function hasMemberTypeFilter(): bool
  142.     {
  143.         return $this->getMemberType() !== self::DEFAULT_MEMBER_TYPE;
  144.     }
  146.     public function isAmateurOnly(): bool
  147.     {
  148.         return $this->getMemberType() === self::MEMBER_TYPE_AMATEUR;
  149.     }
  151.     public function getMemberSex(): string
  152.     {
  153.         return $this->options['memberSex'] ?? self::DEFAULT_GENDER;
  154.     }
  156.     public function setMemberSex(string $memberSex = self::DEFAULT_GENDER): self
  157.     {
  158.         $this->options['memberSex'] = $memberSex;
  159.         return $this;
  160.     }
  162.     public function hasMemberSexFilter(): bool
  163.     {
  164.         return $this->getMemberSex() !== self::DEFAULT_GENDER;
  165.     }
  167.     public function getRegion(): string
  168.     {
  169.         return $this->options['region'] ?? self::DEFAULT_REGION;
  170.     }
  172.     public function setRegion(?string $region): self
  173.     {
  174.         $this->options['region'] = $region;
  175.         return $this;
  176.     }
  178.     public function hasRegionFilter(): bool
  179.     {
  180.         return $this->getRegion() !== self::DEFAULT_REGION;
  181.     }
  183.     public function setPage(int $page): self
  184.     {
  185.         $this->options['page'] = $page;
  186.         return $this;
  187.     }
  189.     public function getPage(): int
  190.     {
  191.         return $this->options['page'] ?? self::DEFAULT_PAGE;
  192.     }
  194.     public function setPerPage(int $perPage = self::DEFAULT_PER_PAGE): self
  195.     {
  196.         $this->options['perPage'] = $perPage > self::MAX_PER_PAGE ? self::MAX_PER_PAGE : $perPage;
  197.         return $this;
  198.     }
  200.     public function getPerPage(): int
  201.     {
  202.         return $this->options['perPage'] ?? self::DEFAULT_PER_PAGE;
  203.     }
  205.     public function fromGlobalSearch(InputBag $bag): void
  206.     {
  207.         $formBlockPrefix = GlobalSearch::BLOCK_PREFIX;
  208.         if (!$bag->has($formBlockPrefix)) {
  209.             $this->initDefaults();
  210.             return;
  211.         }
  213.         $params = $bag->get($formBlockPrefix);
  214.         $searchType = self::DEFAULT_SEARCH_TYPE;
  215.         if (isset($params['searchType']) && in_array((string)$params['searchType'], [SearchType::IMAGESET, SearchType::VIDEO, SearchType::MEMBER, SearchType::ALL], true)) {
  216.             $searchType = (string)$params['searchType'];
  217.         }
  218.         $this->setPage($bag->getInt('page', self::DEFAULT_PAGE));
  219.         $this->setPerPage($bag->getInt('perPage', self::DEFAULT_PER_PAGE));
  220.         $this->setSearchType($searchType);
  221.         $this->setTerm($params['term'] ?? self::DEFAULT_TERM);
  222.     }
  224.     public function fromQuery(InputBag $bag): void
  225.     {
  226.         $params = $bag->all();
  227.         $searchType = self::DEFAULT_SEARCH_TYPE;
  228.         if (isset($params['searchType']) && in_array((string)$params['searchType'], [SearchType::IMAGESET, SearchType::VIDEO, SearchType::MEMBER, SearchType::ALL], true)) {
  229.             $searchType = (string)$params['searchType'];
  230.         }
  231.         $this->pageFromQuery($bag);
  232.         $this->setPerPage($bag->getInt('perPage', self::DEFAULT_PER_PAGE));
  233.         $this->setSearchType($searchType);
  234.         $this->setTerm($params['term'] ?? self::DEFAULT_TERM);
  235.     }
  237.     public function pageFromQuery(InputBag $bag): void
  238.     {
  239.         $this->setPage($bag->getInt('page', self::DEFAULT_PAGE));
  240.     }
  242.     public function applySorting(InputBag $bag): self
  243.     {
  244.         switch ($bag->get('o')) {
  245.             case 'newest':
  246.                 $this->setOrderByNewest('desc');
  247.                 break;
  248.             case 'rating':
  249.                 $this->setOrderByRating('desc');
  250.                 break;
  251.             case 'duration':
  252.                 $this->setOrderByDuration('asc');
  253.                 break;
  254.             case 'daily':
  255.                 $this->setOrderByDaily();
  256.                 break;
  257.         }
  259.         return $this;
  260.     }
  262.     /*
  263.      * Video resolution
  264.      */
  265.     public function getResolution(): int
  266.     {
  267.         return $this->options['resolution'] ?? self::DEFAULT_VIDEO_RESOLUTION;
  268.     }
  270.     public function setResolution(int $resolution): self
  271.     {
  272.         $this->options['resolution'] = $resolution;
  274.         return $this;
  275.     }
  277.     public function isResolution360p(): bool
  278.     {
  279.         return $this->getResolution() === Content::VIDEO_360;
  280.     }
  282.     public function isResolution720p(): bool
  283.     {
  284.         return $this->getResolution() === Content::VIDEO_720;
  285.     }
  287.     public function isResolution1080p(): bool
  288.     {
  289.         return $this->getResolution() === Content::VIDEO_1080;
  290.     }
  292.     public function getSince(): int
  293.     {
  294.         return $this->options['since'] ?? self::DEFAULT_SINCE;
  295.     }
  297.     public function setSince(int $since): self
  298.     {
  299.         $this->options['since'] = $since;
  301.         return $this;
  302.     }
  304.     public function hasSinceFilter(): bool
  305.     {
  306.         return $this->getSince() !== self::DEFAULT_SINCE;
  307.     }
  309.     public function setMinRating(?float $rating): self
  310.     {
  311.         $this->options['minRating'] = $rating;
  312.         return $this;
  313.     }
  315.     public function getMinRating(): ?float
  316.     {
  317.         return $this->options['minRating'] ?? self::DEFAULT_MIN_RATING;
  318.     }
  320.     public function setMaxRating(?float $rating): self
  321.     {
  322.         $this->options['maxRating'] = $rating;
  323.         return $this;
  324.     }
  326.     public function getMaxRating(): ?float
  327.     {
  328.         return $this->options['maxRating'] ?? self::DEFAULT_MAX_RATING;
  329.     }
  331.     public function hasRatingFilter(): bool
  332.     {
  333.         return $this->getMinRating() !== self::DEFAULT_MIN_RATING || $this->getMaxRating() !== self::DEFAULT_MAX_RATING;
  334.     }
  336.     public function setMinAge(int $age): self
  337.     {
  338.         $this->options['minAge'] = $age < self::DEFAULT_MIN_AGE ? self::DEFAULT_MIN_AGE : $age;
  339.         return $this;
  340.     }
  342.     public function getMinAge(): int
  343.     {
  344.         if (!isset($this->options['minAge']) || $this->options['minAge'] < self::DEFAULT_MIN_AGE) {
  345.             return self::DEFAULT_MIN_AGE;
  346.         }
  347.         return $this->options['minAge'];
  348.     }
  350.     public function setMaxAge(int $age): self
  351.     {
  352.         $this->options['maxAge'] = $age > self::DEFAULT_MAX_AGE ? self::DEFAULT_MAX_AGE : $age;
  353.         return $this;
  354.     }
  356.     public function getMaxAge(): int
  357.     {
  358.         return $this->options['maxAge'] ?? self::DEFAULT_MAX_AGE;
  359.     }
  361.     public function hasAgeFilter(): bool
  362.     {
  363.         return $this->getMinAge() !== self::DEFAULT_MIN_AGE || $this->getMaxAge() !== self::DEFAULT_MAX_AGE;
  364.     }
  366.     public function setMinLength(?int $length): self
  367.     {
  368.         $this->options['minLength'] = $length;
  370.         return $this;
  371.     }
  373.     public function getMinLength(): int
  374.     {
  375.         return $this->options['minLength'] ?? self::DEFAULT_MIN_DURATION;
  376.     }
  378.     public function setMaxLength(int $length): self
  379.     {
  380.         $this->options['maxLength'] = $length > self::DEFAULT_MAX_DURATION ? self::DEFAULT_MAX_DURATION : $length;
  382.         return $this;
  383.     }
  385.     public function getMaxLength(): ?int
  386.     {
  387.         return $this->options['maxLength'] ?? self::DEFAULT_MAX_DURATION;
  388.     }
  390.     public function hasLengthFilter(): bool
  391.     {
  392.         return $this->getMinLength() !== self::DEFAULT_MIN_DURATION || $this->getMaxLength() !== self::DEFAULT_MAX_DURATION;
  393.     }
  395.     public function getMinImages(): int
  396.     {
  397.         return $this->options['minImages'] ?? self::DEFAULT_MIN_IMAGES;
  398.     }
  400.     public function setMinImages(int $minImages): self
  401.     {
  402.         $this->options['minImages'] = $minImages;
  403.         return $this;
  404.     }
  406.     public function hasImagesFilter(): bool
  407.     {
  408.         return $this->getMinImages() >= self::DEFAULT_MIN_IMAGES || $this->getMaxImages() !== self::DEFAULT_MAX_IMAGES;
  409.     }
  411.     public function getMaxImages(): int
  412.     {
  413.         return $this->options['maxImages'] ?? self::DEFAULT_MAX_IMAGES;
  414.     }
  416.     public function setMaxImages(int $maxImages): self
  417.     {
  418.         $this->options['maxImages'] = $maxImages;
  419.         return $this;
  420.     }
  422.     public function initDefaults(): self
  423.     {
  424.         $this->options = [];
  425.         $this->setTerm(self::DEFAULT_TERM);
  427.         return $this;
  428.     }
  430.     public function setOrderByNewest(?string $direction): self
  431.     {
  432.         if ($direction) {
  433.             $this->options['orderBy']['since'] = $direction === 'asc' ? 'asc' : 'desc';
  434.         }
  436.         return $this;
  437.     }
  439.     public function getOrderByNewest(): ?string
  440.     {
  441.         return $this->options['orderBy']['since'] ?? null;
  442.     }
  444.     public function setOrderByRating(?string $direction): self
  445.     {
  446.         if ($direction) {
  447.             $this->options['orderBy']['rating'] = $direction === 'asc' ? 'asc' : 'desc';
  448.         }
  450.         return $this;
  451.     }
  453.     public function getOrderByRating(): ?string
  454.     {
  455.         return $this->options['orderBy']['rating'] ?? null;
  456.     }
  458.     public function setOrderByDuration(?string $direction = 'asc'): self
  459.     {
  460.         if ($direction) {
  461.             $this->options['orderBy']['duration'] = $direction === 'desc' ? 'desc' : 'asc';
  462.         }
  464.         return $this;
  465.     }
  467.     public function getOrderByDuration(): ?string
  468.     {
  469.         return $this->options['orderBy']['duration'] ?? null;
  470.     }
  472.     public function getOrderByDefault(): bool
  473.     {
  474.         return $this->getOrderByDaily() === false &&
  475.             is_string($this->getOrderByRating()) === false &&
  476.             is_string($this->getOrderByNewest()) === false &&
  477.             is_string($this->getOrderByDuration()) === false;
  478.     }
  480.     /**
  481.      * Every day another random order
  482.      * @return $this
  483.      */
  484.     public function setOrderByDaily(): self
  485.     {
  486.         $this->options['orderBy']['daily'] = true;
  488.         return $this;
  489.     }
  491.     public function getOrderByDaily(): bool
  492.     {
  493.         return $this->options['orderBy']['daily'] ?? false;
  494.     }
  495. }