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

    /**
     * A module to manage scheduled jobs that run and interact with the job logs from jobs that have
     * already run.  Module provides a user interface to inspect information on any failed jobs.
     */
    class JobsManagerModule extends SecurableModule
    {
        const RIGHT_ACCESS_JOBSMANAGER = 'Access Jobs Manager Tab';

        public static function getTranslatedRightsLabels()
        {
            $labels                              = array();
            $labels[self::RIGHT_ACCESS_JOBSMANAGER] = Zurmo::t('JobsManagerModule', 'Access Jobs Manager Tab');
            return $labels;
        }

        public function getDependencies()
        {
           return array('notifications', 'zurmo');
        }

        public static function getDefaultMetadata()
        {
            $metadata = array();
            $metadata['global'] = array(
                'configureMenuItems' => array(
                    array(
                        'category'         => ZurmoModule::ADMINISTRATION_CATEGORY_GENERAL,
                        'titleLabel'       => "eval:Zurmo::t('JobsManagerModule', 'Job Manager')",
                        'descriptionLabel' => "eval:Zurmo::t('JobsManagerModule', 'Manage Scheduled Jobs')",
                        'route'            => '/jobsManager/default/list',
                        'right'            => self::RIGHT_ACCESS_JOBSMANAGER,
                    ),
                ),
            );
            return $metadata;
        }

        public static function getAccessRight()
        {
            return self::RIGHT_ACCESS_JOBSMANAGER;
        }

        protected static function getSingularModuleLabel($language)
        {
            return Zurmo::t('JobsManagerModule', 'Job Manager', array(), null, $language);
        }

        protected static function getPluralModuleLabel($language)
        {
            return Zurmo::t('JobsManagerModule', 'Job Managers', array(), null, $language);
        }

        public function getRootModelNames()
        {
            return array('JobLog', 'JobInProcess');
        }
    }
?>
