ONGR\ElasticsearchBundle\Document\DocumentTrait

Complexity

Total Complexity

10

Size/Duplication

Total Lines	144
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__clone()	0	4	1
A	setId()	0	6	1
A	getId()	0	4	1
A	setScore()	0	6	1
A	getScore()	0	4	1
A	setParent()	0	6	1
A	getParent()	0	4	1
A	hasParent()	0	4	1
A	setTtl()	0	6	1
A	getTtl()	0	4	1

<?php

/*
 * This file is part of the ONGR package.
 *
 * (c) NFQ Technologies UAB <info@nfq.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ONGR\ElasticsearchBundle\Document;

use ONGR\ElasticsearchBundle\Annotation as ES;

/**
 * This trait provides support for main Elasticsearch meta fields.
 */
trait DocumentTrait
{
    /**
     * @var string
     *
     * @ES\MetaField(name="_id")
     */
    public $id;

    /**
     * @var string
     *
     * @ES\MetaField(name="_score")
     */
    public $score;

    /**
     * @var string
     *
     * @ES\MetaField(name="_parent")
     */
    public $parent;

    /**
     * @var string
     *
     * @ES\MetaField(name="_ttl")
     */
    public $ttl;

    /**
     * When document is cloned id is set to null.
     */
    public function __clone()
    {
        $this->setId(null);
    }

    /**
     * Sets document unique id.
     *
     * @param string $documentId
     *
     * @return $this
     */
    public function setId($documentId)
    {
        $this->id = $documentId;

        return $this;
    }

    /**
     * Returns document id.
     *
     * @return string
     */
    public function getId()
    {
        return $this->id;
    }

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

        return $this;
    }

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

    /**
     * Sets parent document id.
     *
     * @param string $parent
     *
     * @return $this
     */
    public function setParent($parent)
    {
        $this->parent = $parent;

        return $this;
    }

    /**
     * Returns parent document id.
     *
     * @return null|string
     */
    public function getParent()
    {
        return $this->parent;
    }

    /**
     * Checks if document has a parent.
     *
     * @return bool
     */
    public function hasParent()
    {
        return $this->parent !== null;
    }

    /**
     * Sets time to live timestamp.
     *
     * @param string $ttl
     *
     * @return $this
     */
    public function setTtl($ttl)
    {
        $this->ttl = $ttl;

        return $this;
    }

    /**
     * Returns time to live value.
     *
     * @return int
     */
    public function getTtl()
    {
        return $this->ttl;
    }
}