<?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".
     ********************************************************************************/

    /**
     * Helper class for working with CustomFieldData
     */
    class CustomFieldDataUtil
    {
        /**
         * Given a CustomFieldData object, return an array of data and translated labels indexed by the data name.
         * @param CustomFieldData $customFieldData
         * $param string $language
         */
        public static function getDataIndexedByDataAndTranslatedLabelsByLanguage(CustomFieldData $customFieldData, $language)
        {
            assert('is_string($language)');
            $dropDownArray       = unserialize($customFieldData->serializedData);
            $customLabels        = unserialize($customFieldData->serializedLabels);
            if (empty($dropDownArray))
            {
                return array();
            }
            $labelsArray = self::getDataLabelsByLanguage($dropDownArray, $language, $customLabels);
            return array_combine($dropDownArray, $labelsArray);
        }

        public static function getTranslatedLabelByValue(CustomFieldData $customFieldData, $value, $language)
        {
            assert('is_string($value)');
            assert('is_string($language)');
            if ($customFieldData->serializedLabels != null)
            {
                $data   = self::getDataIndexedByDataAndTranslatedLabelsByLanguage($customFieldData, $language);
                if (isset($data[$value]))
                {
                    return $data[$value];
                }
            }
            return $value;
        }

        /**
         * Given an array of data names, a language, and an array of custom labels make an array of data names paired
         * with their labels.  If a custom label is available then utilize that for each data name, otherwise fallback
         * to using the messages file to translate the label.  If the messages file does not have a translation, then
         * the data name will be used as the label.
         * @param $data
         * @param $language
         * @return array - labels for each data name.
         */
        protected static function getDataLabelsByLanguage($data, $language, $customLabels)
        {
            assert('is_array($data)');
            assert('is_string($language)');
            assert('$customLabels == null || is_array($customLabels)');
            $labels = array();
            foreach ($data as $order => $dataName)
            {
                if (isset($customLabels[$language]) &&
                   isset($customLabels[$language][$order]) &&
                   $customLabels[$language][$order] != null)
                {
                    $labels[] = $customLabels[$language][$order];
                }
                else
                {
                    $labels[] = Zurmo::t('CustomField', $dataName, array(), null, $language);
                }
            }
            return $labels;
        }
    }
?>