Phraseanet/lib/Alchemy/Phrasea/Vocabulary/Term.php

<?php
/*
 * This file is part of Phraseanet
 *
 * (c) 2005-2016 Alchemy
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Alchemy\Phrasea\Vocabulary;

use Alchemy\Phrasea\Vocabulary\ControlProvider\ControlProviderInterface;
use Assert\Assertion;

class Term
{
    /**
     * @var string
     */
    protected $value;

    /**
     * @var string
     */
    protected $context;

    /**
     * @var ControlProviderInterface
     */
    protected $type;

    /**
     * @var mixed
     */
    protected $id;

    /**
     * Construct a Term
     *
     * @param string                   $value   the scalar value of the Term
     * @param string                   $context A string defining the context of the Term
     * @param ControlProviderInterface $type    A Vocabulary Controller
     * @param mixed                    $id      The id of the term in the Vocabulary Controller
     */
    public function __construct($value, $context = null, ControlProviderInterface $type = null, $id = null)
    {
        Assertion::string($value, 'A Term value should be a string');

        $this->value = $value;
        $this->context = $context;
        $this->type = $type;
        $this->id = $id;
    }

    /**
     * Get the scalar value of a term
     *
     * @return string
     */
    public function getValue()
    {
        return $this->value;
    }

    /**
     * Get the content of a term
     *
     * @return string
     */
    public function getContext()
    {
        return $this->context;
    }

    /**
     * @return ControlProviderInterface
     */
    public function getType()
    {
        return $this->type;
    }

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