<?php
    /*********************************************************************************
     * Zurmo is a customer relationship management program developed by
     * Zurmo, Inc. Copyright (C) 2012 Zurmo Inc.
     *
     * Zurmo is free software; you can redistribute it and/or modify it under
     * the terms of the GNU General Public License version 3 as published by the
     * Free Software Foundation with the addition of the following permission added
     * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
     * IN WHICH THE COPYRIGHT IS OWNED BY ZURMO, ZURMO DISCLAIMS THE WARRANTY
     * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
     *
     * Zurmo is distributed in the hope that it will be useful, but WITHOUT
     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
     * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
     * details.
     *
     * You should have received a copy of the GNU General Public License along with
     * this program; if not, see http://www.gnu.org/licenses or write to the Free
     * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
     * 02110-1301 USA.
     *
     * You can contact Zurmo, Inc. with a mailing address at 113 McHenry Road Suite 207,
     * Buffalo Grove, IL 60089, USA. or at email address contact@zurmo.com.
     ********************************************************************************/

    /**
     * Base class for related item forms. This form is used by ModelElements and its interface
     * mimics if a CActiveForm was used. Extend as needed.
     */
    abstract class RelatedItemForm extends CFormModel
    {
        protected $relationModel;

        public function __construct($relationModel)
        {
            assert('$relationModel instanceof RedBeanModel');
            $this->relationModel = $relationModel;
        }

        /**
         * Override to handle use case of $name == 'id' and the reference to the relationModel that will be called upon.
         * As this form does not have an 'id', it will return null;
         * @see RelatedItemsElement - to see a example of where this is instantiated from.
         * @see ModelElement.  This form is used by ModelElement for example
         * and ModelElement expects the model to have an 'id' value.
         */
        public function __get($name)
        {
            if ($name == 'id')
            {
                return null;
            }
            else
            {
                if ($name == get_class($this->relationModel))
                {
                    return $this->relationModel;
                }
            }
            throw new NotSupportedException();
        }

        public function getAttributeLabel($attributeName)
        {
            if ($attributeName == get_class($this->relationModel))
            {
                return $this->relationModel->getModelLabelByTypeAndLanguage('Singular');
            }
            throw new NotSupportedException();
        }
    }
?>