OCA\FullTextSearch\Model\IndexDocument

Complexity

Total Complexity

48

Size/Duplication

Total Lines	510
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes	3
Bugs	0	Features	0

43 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setId()	0	5	1
A	getId()	0	3	1
A	setProviderId()	0	5	1
A	getProviderId()	0	3	1
A	setIndex()	0	3	1
A	getIndex()	0	3	1
A	setModifiedTime()	0	5	1
A	getModifiedTime()	0	3	1
A	isOlderThan()	0	3	1
A	setAccess()	0	5	1
A	getAccess()	0	3	1
A	setTags()	0	5	1
A	getTags()	0	3	1
A	addTag()	0	5	1
A	getSource()	0	3	1
A	setSource()	0	5	1
A	setTitle()	0	5	1
A	getTitle()	0	3	1
A	setContent()	0	6	1
A	getContent()	0	3	1
A	initHash()	0	9	3
A	setHash()	0	5	1
A	getHash()	0	3	1
A	addPart()	0	5	1
A	setParts()	0	5	1
A	getParts()	0	3	1
A	isContentEncoded()	0	3	1
A	setLink()	0	5	1
A	getLink()	0	3	1
A	setMore()	0	5	1
A	getMore()	0	3	1
A	setExcerpts()	0	7	1
A	getExcerpts()	0	3	1
A	addExcerpt()	0	5	1
A	cleanExcerpt()	0	10	1
A	setScore()	0	5	1
A	getScore()	0	3	1
A	setInfo()	0	5	1
A	getInfo()	0	7	2
A	getInfoAll()	0	13	3
A	__destruct()	0	17	1
A	jsonSerialize()	0	17	1

<?php
/**
 * FullTextSearch - Full text search framework for Nextcloud
 *
 * 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
 * @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\FullTextSearch\Model;

class IndexDocument implements \JsonSerializable {

	const NOT_ENCODED = 0;
	const ENCODED_BASE64 = 1;

	/** @var string|int */
	public $id;

	/** @var string */
	public $providerId;

	/** @var DocumentAccess */
	public $access;

	/** @var Index */
	public $index;

	/** @var int */
	public $modifiedTime = 0;

	/** @var array */
	public $tags = [];

	// TODO: do we really need it in the base class ?
	/** @var string */
	public $source = '';

	/** @var string */
	public $title = '';

	/** @var string */
	public $content = null;

	/** @var string */
	public $hash = '';

	/** @var array */
	public $parts = [];

	/** @var string */
	public $link = '';

	/** @var array */
	public $more = [];

	/** @var array */
	public $excerpts = [];

	/** @var string */
	public $score;

	/** @var array */
	public $info = [];

	/** @var int */
	public $contentEncoded;


	public function __construct($providerId, $id) {
		$this->providerId = $providerId;
		$this->id = $id;
	}


	/**
	 * @param string|integer $id
	 *
	 * @return $this
	 */
	public function setId($id) {
		$this->id = $id;

		return $this;
	}

	/**
	 * @return string|integer
	 */
	public function getId() {
		return $this->id;
	}


	/**
	 * @param string $providerId
	 *
	 * @return $this
	 */
	public function setProviderId($providerId) {
		$this->providerId = $providerId;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getProviderId() {
		return $this->providerId;
	}


	/**
	 * @param Index $index
	 */
	public function setIndex(Index $index) {
		$this->index = $index;
	}

	/**
	 * @return Index
	 */
	public function getIndex() {
		return $this->index;
	}


	/**
	 * @param int $modifiedTime
	 *
	 * @return $this
	 */
	public function setModifiedTime($modifiedTime) {
		$this->modifiedTime = $modifiedTime;

		return $this;
	}

	/**
	 * @return int
	 */
	public function getModifiedTime() {
		return $this->modifiedTime;
	}

	/**
	 * @param int $time
	 *
	 * @return bool
	 */
	public function isOlderThan($time) {
		return ($this->modifiedTime < $time);
	}


	/**
	 * @param DocumentAccess $access
	 *
	 * @return $this
	 */
	public function setAccess(DocumentAccess $access) {
		$this->access = $access;

		return $this;
	}

	/**
	 * @return DocumentAccess
	 */
	public function getAccess() {
		return $this->access;
	}


	/**
	 * @param array $tags
	 *
	 * @return $this
	 */
	public function setTags($tags) {
		$this->tags = $tags;

		return $this;
	}

	/**
	 * @return array
	 */
	public function getTags() {
		return $this->tags;
	}

	/**
	 * @param $tag
	 *
	 * @return $this
	 */
	public function addTag($tag) {
		$this->tags[] = $tag;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getSource() {
		return $this->source;
	}

	/**
	 * @param string $source
	 *
	 * @return $this
	 */
	public function setSource($source) {
		$this->source = $source;

		return $this;
	}


	/**
	 * @param string $title
	 *
	 * @return $this
	 */
	public function setTitle($title) {
		$this->title = $title;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getTitle() {
		return $this->title;
	}


	/**
	 * @param string $content
	 * @param int $encoded
	 *
	 * @return $this
	 */
	public function setContent($content, $encoded = 0) {
		$this->content = $content;
		$this->contentEncoded = $encoded;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getContent() {
		return $this->content;
	}


	/**
	 * @return $this
	 */
	public function initHash() {
		if ($this->getContent() === '' || is_null($this->getContent())) {
			return $this;
		}

		$this->hash = hash("md5", $this->getContent());

		return $this;
	}

	/**
	 * @param $hash
	 *
	 * @return $this
	 */
	public function setHash($hash) {
		$this->hash = $hash;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getHash() {
		return $this->hash;
	}


	/**
	 * @param string $part
	 * @param string $content
	 *
	 * @return $this
	 */
	public function addPart($part, $content) {
		$this->parts[$part] = $content;

		return $this;
	}

	/**
	 * @param array $parts
	 *
	 * @return $this
	 */
	public function setParts($parts) {
		$this->parts = $parts;

		return $this;
	}

	/**
	 * @return array
	 */
	public function getParts() {
		return $this->parts;
	}


	/**
	 * @return int
	 */
	public function isContentEncoded() {
		return $this->contentEncoded;
	}


	/**
	 * @param string $link
	 *
	 * @return $this
	 */
	public function setLink($link) {
		$this->link = $link;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getLink() {
		return $this->link;
	}


	/**
	 * @param array $more
	 *
	 * @return $this
	 */
	public function setMore($more) {
		$this->more = $more;

		return $this;
	}

	/**
	 * @return array
	 */
	public function getMore() {
		return $this->more;
	}


	/**
	 * @param array $excerpts
	 *
	 * @return $this
	 */
	public function setExcerpts($excerpts) {
		$excerpts = array_map([$this, 'cleanExcerpt'], $excerpts);

		$this->excerpts = $excerpts;

		return $this;
	}

	/**
	 * @return array
	 */
	public function getExcerpts() {
		return $this->excerpts;
	}

	/**
	 * @param string $excerpt
	 */
	public function addExcerpt($excerpt) {
		$excerpt = $this->cleanExcerpt($excerpt);

		$this->excerpts[] = $excerpt;
	}

	/**
	 * @param $excerpt
	 *
	 * @return mixed
	 */
	public function cleanExcerpt($excerpt) {
		$excerpt = str_replace("\\n", ' ', $excerpt);
		$excerpt = str_replace("\\r", ' ', $excerpt);
		$excerpt = str_replace("\\t", ' ', $excerpt);
		$excerpt = str_replace("\n", ' ', $excerpt);
		$excerpt = str_replace("\r", ' ', $excerpt);
		$excerpt = str_replace("\t", ' ', $excerpt);

		return $excerpt;
	}

	/**
	 * @param string $score
	 *
	 * @return $this
	 */
	public function setScore($score) {
		$this->score = $score;

		return $this;
	}

	/**
	 * @return string
	 */
	public function getScore() {
		return $this->score;
	}


	/**
	 * @param string $info
	 * @param mixed $value
	 *
	 * @return $this
	 */
	public function setInfo($info, $value) {
		$this->info[$info] = $value;

		return $this;
	}

	/**
	 * @param string $info
	 * @param mixed $default
	 *
	 * @return mixed
	 */
	public function getInfo($info, $default = '') {
		if (!key_exists($info, $this->info)) {
			return $default;
		}

		return $this->info[$info];
	}


	/**
	 * @return array
	 */
	public function getInfoAll() {

		$info = [];
		foreach ($this->info as $k => $v) {
			if (substr($k, 0, 1) === '_') {
				continue;
			}

			$info[$k] = $v;
		}

		return $info;
	}


	public function __destruct() {
		unset($this->id);
		unset($this->providerId);
		unset($this->access);
		unset($this->modifiedTime);
		unset($this->title);
		unset($this->content);
		unset($this->hash);
		unset($this->link);
		unset($this->source);
		unset($this->tags);
		unset($this->more);
		unset($this->excerpts);
		unset($this->score);
		unset($this->info);
		unset($this->contentEncoded);
	}

	/**
	 * @return array<string,string|integer|DocumentAccess|array>
	 */
	public function jsonSerialize() {
		return [
			'id'           => $this->getId(),
			'providerId'   => $this->getProviderId(),
			'access'       => $this->getAccess(),
			'modifiedTime' => $this->getModifiedTime(),
			'title'        => $this->getTitle(),
			'link'         => $this->getLink(),
			'source'       => $this->getSource(),
			'info'         => $this->getInfoAll(),
			'hash'         => $this->getHash(),
			'tags'         => $this->getTags(),
			'more'         => $this->getMore(),
			'excerpts'     => $this->getExcerpts(),
			'score'        => $this->getScore()
		];
	}

}