<?php
    /*********************************************************************************
     * Zurmo is a customer relationship management program developed by
     * Zurmo, Inc. Copyright (C) 2013 Zurmo Inc.
     *
     * Zurmo is free software; you can redistribute it and/or modify it under
     * the terms of the GNU Affero 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 Affero General Public License for more
     * details.
     *
     * You should have received a copy of the GNU Affero 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 27 North Wacker Drive
     * Suite 370 Chicago, IL 60606. or at email address contact@zurmo.com.
     *
     * The interactive user interfaces in original and modified versions
     * of this program must display Appropriate Legal Notices, as required under
     * Section 5 of the GNU Affero General Public License version 3.
     *
     * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
     * these Appropriate Legal Notices must retain the display of the Zurmo
     * logo and Zurmo copyright notice. If the display of the logo is not reasonably
     * feasible for technical reasons, the Appropriate Legal Notices must display the words
     * "Copyright Zurmo Inc. 2013. All rights reserved".
     ********************************************************************************/

    /**
     * Adapt module metadata into a module form
     * that can be modified in the user interface.
     */
    class ModuleMetadataToFormAdapter
    {
        protected $metadata;

        protected $moduleClassName;

        public function __construct($metadata, $moduleClassName)
        {
            $this->metadata        = $metadata;
            $this->moduleClassName = $moduleClassName;
        }

        public function getModuleForm()
        {
            $moduleFormClassName = $this->moduleClassName . 'Form';
            $moduleForm = new $moduleFormClassName();
            //FIGURE OUT HOW TO ONLY MAP SOME ATTRIBUTES SINCE MODULE LABELS ARE HANDLED DIFFERENTLY
            foreach ($moduleForm->attributeNames() as $attributeName)
            {
                if (isset($this->metadata[$attributeName]))
                {
                    $moduleForm->$attributeName = $this->metadata[$attributeName];
                }
            }
            $moduleClassName = $this->moduleClassName;
            foreach (Yii::app()->languageHelper->getActiveLanguagesData() as $languageCode => $languageData)
            {
                $moduleForm->singularModuleLabels[$languageCode] = $moduleClassName::getModuleLabelByTypeAndLanguage(
                                                                                    'SingularLowerCase', $languageCode);
                $moduleForm->pluralModuleLabels[$languageCode]   = $moduleClassName::getModuleLabelByTypeAndLanguage(
                                                                                    'PluralLowerCase',   $languageCode);
            }
            if ($moduleForm instanceof GlobalSearchEnabledModuleForm)
            {
                $moduleClassName         = $this->moduleClassName;
                $modelAttributesAdapter  = DesignerModelToViewUtil::
                                           getModelAttributesAdapterByModelForViewClassName(
                                               $moduleClassName::getGlobalSearchFormClassName(),
                                               $moduleClassName::getPrimaryModelName());
                $attributeCollection     = $modelAttributesAdapter->getAttributes();
                $adapter                 = new ModelAttributeCollectionToGlobalSearchAttributesAdapter(
                                                    $attributeCollection);
                $moduleForm->availableGlobalSearchAttributeNames = $adapter->getValuesAndLabelsData();
            }

            return $moduleForm;
        }
    }
?>