<?php
/**
 * Elastica Mapping object
 *
 * @category Xodoa
 * @package Elastica
 * @author Nicolas Ruflin <hide@address.com>
 * @link http://www.elasticsearch.org/guide/reference/mapping/
 */
class Elastica_Type_Mapping
{
    /**
     * Mapping
     *
     * @var array Mapping
     */
    protected $_mapping = array();

    /**
     * Type
     *
     * @var Elastica_Type Type object
     */
    protected $_type = null;

    /**
     * Construct Mapping
     *
     * @param Elastica_Type $type       OPTIONAL Type object
     * @param array         $properties OPTIONAL Properties
     */
    public function __construct(Elastica_Type $type = null, array $properties = array())
    {
        if ($type) {
            $this->setType($type);
        }

        if (!empty($properties)) {
            $this->setProperties($properties);
        }
    }

    /**
     * Sets the mapping type
     * Enter description here ...
     * @param  Elastica_Type         $type Type object
     * @return Elastica_Type_Mapping Current object
     */
    public function setType(Elastica_Type $type)
    {
        $this->_type = $type;

        return $this;
    }

    /**
     * Sets the mapping properites
     *
     * @param  array                 $properties Prpoerties
     * @return Elastica_Type_Mapping Mapping object
     */
    public function setProperties(array $properties)
    {
        return $this->setParam('properties', $properties);
    }

    /**
     * Returns mapping type
     *
     * @return Elastica_Type Type
     */
    public function getType()
    {
        return $this->_type;
    }

    /**
     * Sets source values
     *
     * To disable source, argument is
     * array('enabled' => false)
     *
     * @param  array                 $source Source array
     * @return Elastica_Type_Mapping Current object
     * @link http://www.elasticsearch.org/guide/reference/mapping/source-field.html
     */
    public function setSource(array $source)
    {
        return $this->setParam('_source', $source);
    }

    /**
     * Disables the source in the index
     *
     * Param can be set to true to enable again
     *
     * @param  bool                  $enabled OPTIONAL (default = false)
     * @return Elastica_Type_Mapping Current object
     */
    public function disableSource($enabled = false)
    {
        return $this->setSource(array('enabled' => $enabled));
    }

    /**
     * Sets raw parameters
     *
     * Possible options:
     * _uid
     * _id
     * _type
     * _source
     * _all
     * _analyzer
     * _boost
     * _parent
     * _routing
     * _index
     * _size
     * properties
     *
     * @param  string                $key   Key name
     * @param  mixed                 $value Key value
     * @return Elastica_Type_Mapping Current object
     */
    public function setParam($key, $value)
    {
        $this->_mapping[$key] = $value;

        return $this;
    }

    /**
     * Set TTL
     *
     * @param  array                 $params TTL Params (enabled, default, ...)
     * @return Elastica_Type_Mapping
     */
    public function setTtl(array $params)
    {
        return $this->setParam('_ttl', $params);

    }

    /**
     * Enables TTL for all documens in this type
     *
     * @param  bool                  $enabled OPTIONAL (default = true)
     * @return Elastica_Type_Mapping
     */
    public function enableTtl($enabled = true)
    {
        return $this->setTTL(array('enabled' => $enabled));
    }

    /**
     * Converts the mapping to an array
     *
     * @return array Mapping as array
     */
    public function toArray()
    {
        $type = $this->getType();

        if (empty($type)) {
            throw new Elastica_Exception_Invalid('Type has to be set');
        }

        return array($type->getType() => $this->_mapping);
    }

    /**
     * Submits the mapping and sends it to the server
     *
     * @return Elastica_Response Response object
     */
    public function send()
    {
        $path = '_mapping';

        return $this->getType()->request($path, Elastica_Request::PUT, $this->toArray());
    }

    /**
     * Creates a mapping object
     *
     * @param  array|Elastica_Type_Mapping $mapping Mapping object or properties array
     * @return Elastica_Type_Mapping       Mapping object
     * @throws Elastica_Exception_Invalid  If invalid type
     */
    public static function create($mapping)
    {
        if (is_array($mapping)) {
            $mappingObject = new Elastica_Type_Mapping();
            $mappingObject->setProperties($mapping);
        } else {
            $mappingObject = $mapping;
        }

        if (!$mappingObject instanceof Elastica_Type_Mapping) {
            throw new Elastica_Exception_Invalid('Invalid object type');
        }

        return $mappingObject;
    }
}