social/lib/Model/Client/Options/TimelineOptions.php

<?php

declare(strict_types=1);


/**
 * Nextcloud - Social Support
 *
 * This file is licensed under the Affero General Public License version 3 or
 * later. See the COPYING file.
 *
 * @author Maxence Lange <maxence@artificial-owl.com>
 * @copyright 2018, Maxence Lange <maxence@artificial-owl.com>
 * @license GNU AGPL version 3 or any later version
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 */


namespace OCA\Social\Model\Client\Options;

use JsonSerializable;
use OCA\Social\Exceptions\UnknownTimelineException;
use OCA\Social\Tools\Traits\TArrayTools;
use OCP\IRequest;

/**
 * Class TimelineOptions
 *
 * @package OCA\Social\Model\Client\Options
 */
class TimelineOptions extends CoreOptions implements JsonSerializable {
	use TArrayTools;

	public const TIMELINE_HOME = 'home';
	public const TIMELINE_PUBLIC = 'public';
	public const TIMELINE_DIRECT = 'direct';
	public const TIMELINE_ACCOUNT = 'account';
	public const TIMELINE_FAVOURITES = 'favourites';
	public const TIMELINE_HASHTAG = 'hashtag';
	public const TIMELINE_NOTIFICATIONS = 'notifications';

	private string $timeline = '';
	private bool $local = false;
	private bool $remote = false;
	private bool $onlyMedia = false;
	private int $minId = 0;
	private int $maxId = 0;
	private int $since = 0;
	private int $limit = 20;
	private bool $inverted = false;
	private string $argument = '';
	private array $types = [];
	private array $excludeTypes = [];
	private string $accountId = '';

	public static array $availableTimelines = [
		self::TIMELINE_HOME,
		self::TIMELINE_ACCOUNT,
		self::TIMELINE_PUBLIC,
		self::TIMELINE_DIRECT,
		self::TIMELINE_FAVOURITES,
		self::TIMELINE_NOTIFICATIONS
	];

	/**
	 * TimelineOptions constructor.
	 *
	 * @param IRequest|null $request
	 */
	public function __construct(IRequest $request = null) {
		if ($request !== null) {
			$this->fromArray($request->getParams());
		}
	}


	/**
	 * @return string
	 */
	public function getTimeline(): string {
		return $this->timeline;
	}

	/**
	 * @param string $timeline
	 *
	 * @return TimelineOptions
	 * @throws UnknownTimelineException
	 */
	public function setTimeline(string $timeline): self {
		$timeline = strtolower($timeline);
		if (!in_array($timeline, self::$availableTimelines)) {
			throw new UnknownTimelineException(
				'unknown timeline: ' . implode(', ', self::$availableTimelines)
			);
		}

		$this->timeline = $timeline;

		return $this;
	}


	/**
	 * @return bool
	 */
	public function isLocal(): bool {
		return $this->local;
	}

	/**
	 * @param bool $local
	 *
	 * @return TimelineOptions
	 */
	public function setLocal(bool $local): self {
		$this->local = $local;

		return $this;
	}


	/**
	 * @return bool
	 */
	public function isRemote(): bool {
		return $this->remote;
	}

	/**
	 * @param bool $remote
	 *
	 * @return TimelineOptions
	 */
	public function setRemote(bool $remote): self {
		$this->remote = $remote;

		return $this;
	}


	/**
	 * @return bool
	 */
	public function isOnlyMedia(): bool {
		return $this->onlyMedia;
	}

	/**
	 * @param bool $onlyMedia
	 *
	 * @return TimelineOptions
	 */
	public function setOnlyMedia(bool $onlyMedia): self {
		$this->onlyMedia = $onlyMedia;

		return $this;
	}


	/**
	 * @return int
	 */
	public function getMinId(): int {
		return $this->minId;
	}

	/**
	 * @param int $minId
	 *
	 * @return TimelineOptions
	 */
	public function setMinId(int $minId): self {
		$this->minId = $minId;

		return $this;
	}


	/**
	 * @return int
	 */
	public function getMaxId(): int {
		return $this->maxId;
	}

	/**
	 * @param int $maxId
	 *
	 * @return TimelineOptions
	 */
	public function setMaxId(int $maxId): self {
		$this->maxId = $maxId;

		return $this;
	}


	/**
	 * @return int
	 */
	public function getSince(): int {
		return $this->since;
	}

	/**
	 * @param int $since
	 *
	 * @return TimelineOptions
	 */
	public function setSince(int $since): self {
		$this->since = $since;

		return $this;
	}


	/**
	 * @return int
	 */
	public function getLimit(): int {
		return $this->limit;
	}

	/**
	 * @param int $limit
	 *
	 * @return TimelineOptions
	 */
	public function setLimit(int $limit): self {
		$this->limit = $limit;

		return $this;
	}


	/**
	 * @return bool
	 */
	public function isInverted(): bool {
		return $this->inverted;
	}

	/**
	 * @param bool $inverted
	 *
	 * @return TimelineOptions
	 */
	public function setInverted(bool $inverted): self {
		$this->inverted = $inverted;

		return $this;
	}


	/**
	 * @param string $argument
	 *
	 * @return TimelineOptions
	 */
	public function setArgument(string $argument): self {
		$this->argument = $argument;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getArgument(): string {
		return $this->argument;
	}


	/**
	 * @param array $types
	 *
	 * @return TimelineOptions
	 */
	public function setTypes(array $types): self {
		$this->types = $types;

		return $this;
	}

	/**
	 * @return array
	 */
	public function getTypes(): array {
		return $this->types;
	}


	/**
	 * @param array $excludeTypes
	 *
	 * @return TimelineOptions
	 */
	public function setExcludeTypes(array $excludeTypes): self {
		$this->excludeTypes = $excludeTypes;

		return $this;
	}

	/**
	 * @return array
	 */
	public function getExcludeTypes(): array {
		return $this->excludeTypes;
	}


	/**
	 * @param string $accountId
	 *
	 * @return TimelineOptions
	 */
	public function setAccountId(string $accountId): self {
		$this->accountId = $accountId;

		return $this;
	}


	/**
	 * @return string
	 */
	public function getAccountId(): string {
		return $this->accountId;
	}


	/**
	 * @param array $arr
	 *
	 * @return TimelineOptions
	 */
	public function fromArray(array $arr): self {
		$this->setLocal($this->getBool('local', $arr, $this->isLocal()));
		$this->setRemote($this->getBool('remote', $arr, $this->isRemote()));
		$this->setOnlyMedia($this->getBool('only_media', $arr, $this->isOnlyMedia()));
		$this->setMinId($this->getInt('min_id', $arr, $this->getMinId()));
		$this->setMaxId($this->getInt('max_id', $arr, $this->getMaxId()));
		$this->setSince($this->getInt('since', $arr, $this->getSince()));
		$this->setLimit($this->getInt('limit', $arr, $this->getLimit()));
		$this->setArgument($this->get('argument', $arr, $this->getArgument()));

		return $this;
	}


	/**
	 * @return array
	 */
	public function jsonSerialize(): array {
		return
			[
				'timeline' => $this->getTimeline(),
				'accountId' => $this->getAccountId(),
				'local' => $this->isLocal(),
				'remote' => $this->isRemote(),
				'only_media' => $this->isOnlyMedia(),
				'min_id' => $this->getMinId(),
				'max_id' => $this->getMaxId(),
				'since' => $this->getSince(),
				'limit' => $this->getLimit(),
				'argument' => $this->getArgument()
			];
	}
}