WBW\Library\Core\ThirdParty\OcrLad\Model\Document

Complexity

Total Complexity

14

Size/Duplication

Total Lines	127
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	addPage()	0	4	1
A	getIndex()	0	3	1
A	getNumberPages()	0	3	1
A	getPage()	0	6	4
A	getPages()	0	3	1
A	hasPages()	0	3	1
A	index()	0	10	2
A	setIndex()	0	4	1
A	setPages()	0	4	1

<?php

/*
 * This file is part of the core-library package.
 *
 * (c) 2020 WEBEWEB
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace WBW\Library\Core\ThirdParty\OcrLad\Model;

use WBW\Library\Core\Model\Attribute\StringFilenameTrait;
use WBW\Library\Core\ThirdParty\OcrLad\Model\Attribute\ArrayWordsTrait;

/**
 * Document.
 *
 * @author webeweb <https://github.com/webeweb>
 * @package WBW\Library\Core\ThirdParty\OcrLad\Model
 */
class Document {

    use ArrayWordsTrait;
    use StringFilenameTrait;

    /**
     * Index.
     *
     * @var Word[]
     */
    private $index;

    /**
     * Pages.
     *
     * @var Page[]
     */
    private $pages;

    /**
     * Constructor.
     */
    public function __construct() {
        $this->setIndex([]);
        $this->setPages([]);
        $this->setWords([]);
    }

    /**
     * Add a page.
     *
     * @param Page $page The page.
     * @return Document Returns this document.
     */
    public function addPage(Page $page) {
        $this->pages[] = $page;
        return $this;
    }

    /**
     * Get the index.
     *
     * @return Word[] Returns the index.
     */
    public function getIndex() {
        return $this->index;
    }

    /**
     * Get the number of pages.
     *
     * @return int Returns the number of pages.
     */
    public function getNumberPages() {
        return count($this->getPages());
    }

    /**
     * Get a page.
     *
     * @param int $p The page.
     * @return Page|null Returns the page in case of success, null otherwise.
     */
    public function getPage($p) {
        if (false === is_int($p) || $p < 0 || $this->getNumberPages() <= $p) {
            return null;
        }
        return $this->getPages()[$p];
    }

    /**
     * Get the pages.
     *
     * @return Page[] Returns the pages.
     */
    public function getPages() {
        return $this->pages;
    }

    /**
     * Determines if this instance has pages.
     *
     * @return bool Returns true in case of success, false otherwise.
     */
    public function hasPages() {
        return 1 <= $this->getNumberPages();
    }

    /**
     * Index a word.
     *
     * @param Word $word The word.
     * @return Document Returns this document.
     */
    public function index(Word $word) {

        if (false === array_key_exists($word->getContent(), $this->index)) {
            $this->index[$word->getContent()] = [];
        }

        $this->index[$word->getContent()][] = $word;

        return $this;
    }

    /**
     * Set the index.
     *
     * @param Word[] $index The index.
     * @return Document Returns this document.
     */
    protected function setIndex($index) {
        $this->index = $index;
        return $this;
    }

    /**
     * Set the pages.
     *
     * @param Page[] $pages The pages.
     * @return Document Returns this document.
     */
    protected function setPages(array $pages) {
        $this->pages = $pages;
        return $this;
    }
}