<?php
/**
 * Содержит класс BreadCrumbs
 *
 * @package energine
 * @author dr.Pavka
 * @copyright ColoCall 2006
 * @version $Id: BreadCrumbs.class.php,v 1.10 2007/12/17 14:16:14 pavka Exp $
 */

//require_once('core/modules/share/components/DataSet.class.php');

/**
 * "Хлебные крошки"
 *
 * @package energine
 * @subpackage share
 * @final
 */
final class BreadCrumbs extends DataSet {
    /**
     * Список дополнительных элементов
     * Необходим для того чтобы другие компоненты могли добавлять хлебные крошки
     * @var array
     * @access private
     */
    private $additionalCrumbs = array();

    /**
     * Конструктор класса
     *
     * @return void
     */
    public function __construct($name, $module, Document $document,  array $params = null) {
        parent::__construct($name, $module, $document,  $params);
        $this->setType(self::COMPONENT_TYPE_LIST);
    }

    /**
     * Поскольку изменение перечня полей невозможно, принудительно выставляем необходимые значения
     *
     * @return DataDescription
     * @access protected
     */

    protected function createDataDescription() {
        $result = new DataDescription();
        $field = new FieldDescription('Id');
        $field->setType(FieldDescription::FIELD_TYPE_INT);
        $field->addProperty('key', true);
        $result->addFieldDescription($field);

        $field = new FieldDescription('Name');
        $field->setType(FieldDescription::FIELD_TYPE_STRING);
        $result->addFieldDescription($field);

        $field = new FieldDescription('Segment');
        $field->setType(FieldDescription::FIELD_TYPE_STRING);
        $result->addFieldDescription($field);

        return $result;
    }
    /**
     * Переопределенный метод загрузки данных
     *
     * @return mixed
     * @access protected
     */
    protected function loadData() {
        $sitemap = Sitemap::getInstance();
        $result = array();
        $parents = $sitemap->getParents($this->document->getID());
        foreach ($parents as $id => $current) {
            $result[] = array(
            'Id' => $id,
            'Name' => $current['Name'],
            'Segment' => $current['Segment']
            );
        }
        $docInfo = $sitemap->getDocumentInfo($this->document->getID());
        $result[] = array(
        'Id' => $this->document->getID(),
        'Name' => $docInfo['Name'],
        'Segment' => $sitemap->getURLByID($this->document->getID())
        );
        if (!empty($this->additionalCrumbs)) {
            $result = array_merge($result, $this->additionalCrumbs);
        }


        // добавляем информацию о главной странице в начало
        $defaultID = $sitemap->getDefault();
        if (($this->document->getID() != $defaultID) && (isset($result[0]) && ($result[0]['Id'] != $defaultID))) {
            $docInfo = $sitemap->getDocumentInfo($defaultID);
            $result = array_push_before(
            $result,
            array(
            array(
            'Id' => $defaultID,
            'Name' => $docInfo['Name'],
            'Segment' => ''//$sitemap->getURLByID($defaultID)
            )
            ),
            0
            );
        }

        return $result;
    }

    /**
      * Метод добавляющий хлебную крошку
      * Если приходят пустые параметры, то эта крошка не выводится, а предыдущая хлебная крошка будет ссылкой
      *
      * @param int
      * @param string
      * @param segment
      * @return void
      * @access public
      */

    public function addCrumb($smapID = '', $smapName = '', $smapSegment = '') {
        $this->additionalCrumbs[] = array(
        'Id' => $smapID,
        'Name' => $smapName,
        'Segment' => $smapSegment
        );
    }
}