application/include/AM/Model/Db/Term.php

<?php
/**
 * @file
 * AM_Model_Db_Term class definition.
 *
 * LICENSE
 *
 * This software is governed by the CeCILL-C  license under French law and
 * abiding by the rules of distribution of free software.  You can  use,
 * modify and/ or redistribute the software under the terms of the CeCILL-C
 * license as circulated by CEA, CNRS and INRIA at the following URL
 * "http://www.cecill.info".
 *
 * As a counterpart to the access to the source code and  rights to copy,
 * modify and redistribute granted by the license, users are provided only
 * with a limited warranty  and the software's author,  the holder of the
 * economic rights,  and the successive licensors  have only  limited
 * liability.
 *
 * In this respect, the user's attention is drawn to the risks associated
 * with loading,  using,  modifying and/or developing or reproducing the
 * software by the user in light of its specific status of free software,
 * that may mean  that it is complicated to manipulate,  and  that  also
 * therefore means  that it is reserved for developers  and  experienced
 * professionals having in-depth computer knowledge. Users are therefore
 * encouraged to load and test the software's suitability as regards their
 * requirements in conditions enabling the security of their systems and/or
 * data to be ensured and,  more generally, to use and operate it in the
 * same conditions as regards security.
 *
 * The fact that you are presently reading this means that you have had
 * knowledge of the CeCILL-C license and that you accept its terms.
 *
 * @author Copyright (c) PadCMS (http://www.padcms.net)
 * @version $DOXY_VERSION
 */

/**
 * Term model class
 * @ingroup AM_Model
 */
class AM_Model_Db_Term extends AM_Model_Db_Base_NestedSet
{
    /** @var AM_Model_Db_Vocabulary */
    protected $_oVocabulary = null; /**< @type AM_Model_Db_Vocabulary */
    /** @var AM_Model_Db_Term_Data_Resource */
    protected $_oResources  = null; /**< @type AM_Model_Db_Term_Data_Resource */
    /** @var AM_Model_Db_Rowset_Page */
    protected $_oPages      = null; /**< @type AM_Model_Db_Rowset_Page */

    /**
     * Check if term is tag
     * @return bool
     */
    protected function _isTag()
    {
        $oVocabulary = $this->getVocabulary();
        if (0 == $oVocabulary->has_hierarchy && 1 == $oVocabulary->multiple) {
            return true;
        }

        return false;
    }

    /**
     * Check if term is TOC
     * @return bool
     */
    protected function _isToc()
    {
        $oVocabulary = $this->getVocabulary();
        if (1 == $oVocabulary->has_hierarchy && 0 == $oVocabulary->multiple) {
            return true;
        }

        return false;
    }

    /**
     * Move term data from one revision to other
     * @param AM_Model_Db_Revision $oRevisionTo
     * @return AM_Model_Db_Term
     */
    public function moveToRevision(AM_Model_Db_Revision $oRevisionTo)
    {
        $oTocVocabulary = $oRevisionTo->getVocabularyToc();

        $bNeedToUpdate = false;

        //@todo: change tags and TOC architecture
        //We use this method during moving revision to other issue
        //In this case we have to move only terms used by this revision
        //And we can't move any tags -they aren't assigned to revision

        if ($this->_isToc() && !empty($this->revision) && $oRevisionTo->id == $this->revision) {
            //Check vacabulary of term & new revision
            if ($oTocVocabulary->id != $this->vocabulary) {
                $this->vocabulary = $oTocVocabulary->id;
                $bNeedToUpdate    = true;
            }
        }

        if ($bNeedToUpdate) {
            $this->save();
        }

        return $this;
    }

    /**
     * Copy term data from one revision to other
     * @param AM_Model_Db_Revision $oRevisionTo
     * @return AM_Model_Db_Term
     */
    public function copyToRevision(AM_Model_Db_Revision $oRevisionTo, AM_Model_Db_Revision $oRevisionFrom)
    {
        $oTocVocabulary = $oRevisionTo->getVocabularyToc();

        if($this->_isToc()  && !empty($this->revision ) && $oRevisionFrom->id == $this->revision) {
            $oResources = $this->getResources();

            $this->vocabulary = $oTocVocabulary->id;
            $this->revision   = $oRevisionTo->id;

            $aData               = array();
            $aData['updated']    = null;
            $aData['vocabulary'] = $this->vocabulary;
            $aData['revision']   = $this->revision;


            $this->copy($aData);
            $oResources->copy();
        }
        return $this;
    }

    /**
     * Set resources
     * @param AM_Model_Db_Term_Data_Resource $oResources
     * @return AM_Model_Db_Term
     */
    public function setResources(AM_Model_Db_Term_Data_Resource $oResources)
    {
        $this->_oResources = $oResources;

        return $this;
    }

    /**
     * Get resources of term
     * @return AM_Model_Db_Term_Data_Resource
     */
    public function getResources()
    {
        if (is_null($this->_oResources)){
            $this->fetchResources();
        }

        return $this->_oResources;
    }

    /**
     * Fetch resources of term
     * @return AM_Model_Db_Term
     */
    public function fetchResources()
    {
        $this->_oResources = new AM_Model_Db_Term_Data_Resource($this);

        return $this;
    }

    /**
     * Update parent term id
     * @return AM_Model_Db_Term
     */
    public function updateReletations()
    {
        $oParent = $this->getParent();
        if (!empty($oParent)) {
            if ($this->parent_term != $oParent->id) {
                $this->parent_term = $oParent->id;
                $this->save();
            }
        }

        return $this;
    }

    /**
     * Save page and term relations
     * @param AM_Model_Db_Page $oPage
     * @return AM_Model_Db_Term
     */
    public function saveToPage(AM_Model_Db_Page $oPage)
    {
        $oTermPage = AM_Model_Db_Table_Abstract::factory('term_page')->findOneBy(array('page' => $oPage->id, 'term' => $this->id));

        if (is_null($oTermPage)) {
            $oTermPage       = new AM_Model_Db_TermPage();
            $oTermPage->page = $oPage->id;
            $oTermPage->term = $this->id;
            $oTermPage->save();

            if ($this->_isToc()) {
                $oPage->toc = $this->id;
                $oPage->save();
            }
        }

        return $this;
    }

    /**
     * Set vocabulary
     * @return AM_Model_Db_Term
     */
    public function setVocabulary(AM_Model_Db_Vocabulary $oVocabulary)
    {
        $this->_oVocabulary = $oVocabulary;

        return $this;
    }

    /**
     * Get vocabulary
     * @return AM_Model_Db_Vocabulary
     */
    public function getVocabulary()
    {
        if (is_null($this->_oVocabulary)) {
            $this->fetchVocabulary();
        }

        return $this->_oVocabulary;
    }

    /**
     * Fetch vocabulary
     * @return AM_Model_Db_Term
     */
    public function fetchVocabulary()
    {
        $this->_oVocabulary = AM_Model_Db_Table_Abstract::factory('vocabulary')->findOneBy('id', $this->vocabulary);

        if (is_null($this->_oVocabulary)) {
            throw new AM_Model_Db_Exception(sprintf('Term "%s" has no vocabulary', $this->id));
        }

        return $this;
    }

    /**
     * Get terms pages
     * @return AM_Model_Db_Rowset_Page
     */
    public function getPages()
    {
        if (is_null($this->_oPages)) {
            $this->fetchPages();
        }

        return $this->_oPages;
    }

    /**
     * Fetch terms pages
     * @return AM_Model_Db_Term
     */
    public function fetchPages()
    {
        $this->_oPages = AM_Model_Db_Table_Abstract::factory('term_page')
                ->findPagesByTermId($this->id);

        return $this;
    }

    /**
     * Filter title value
     *
     * @param string $sValue
     * @return string
     */
    public function preSetTitle($sValue)
    {
        $sValue = AM_Tools::filter_xss($sValue);

        return $sValue;
    }

    /**
     * Filter description value
     *
     * @param string $sValue
     * @return string
     */
    public function preSetDescription($sValue)
    {
        $sValue = AM_Tools::filter_xss($sValue);

        return $sValue;
    }

    /**
     * Filter color value
     *
     * @param string $sValue
     * @return string
     */
    public function preSetColor($sValue)
    {
        if (!empty($sValue) && (!preg_match('/^#?+([0-9a-f]{3}(?:[0-9a-f]{3})?)$/iD', $sValue, $aMatches) || count($aMatches) < 2)) {
            throw new AM_Model_Db_Exception('Error. Invalid color');
        }

        return $sValue;
    }

    /**
     * Move the term to the given parent term, set position and change position of the terms on the same nesting level
     * @param int $iTocTermParentId
     * @param int $iPosition
     * @return AM_Model_Db_Term
     */
    public function moveToTerm($iTocTermParentId, $iPosition)
    {
        AM_Model_Db_Table_Abstract::factory('term')->moveTerm($this, $iTocTermParentId, $iPosition);

        return $this;
    }
}