quantity-unit-toggle.controller.js

/*
 * This program is part of the OpenLMIS logistics management information system platform software.
 * Copyright © 2017 VillageReach
 *
 * This program is free software: you can redistribute it and/or modify it under the terms
 * of the GNU Affero General Public License as published by the Free Software Foundation, either
 * version 3 of the License, or (at your option) any later version.
 *  
 * This program 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.  For additional information contact info@OpenLMIS.org. 
 */

(function() {

    'use strict';

    /**
     * @ngdoc controller
     * @name openlmis-quantity-unit-toggle.controller:QuantityUnitToggleController
     *
     * @description
     * Responsible for managing quantity unit element.
     */
    angular
        .module('openlmis-quantity-unit-toggle')
        .controller('QuantityUnitToggleController', QuantityUnitToggleController);

    QuantityUnitToggleController.$inject = [
        'messageService', 'QUANTITY_UNIT', 'quantityUnitConfigService', '$rootScope'
    ];

    function QuantityUnitToggleController(messageService, QUANTITY_UNIT, quantityUnitConfigService,
                                          $rootScope) {

        var vm = this;

        vm.$onInit = onInit;
        vm.getMessage = getMessage;
        vm.onChange = onChange;
        vm.isQuantityUnitToggleVisible = isQuantityUnitToggleVisible;

        /**
         * @ngdoc property
         * @propertyOf openlmis-quantity-unit-toggle.controller:QuantityUnitToggleController
         * @name quantityUnits
         * @type {Array}
         *
         * @description
         * Holds quantity units that will be displayed on toggle component.
         */
        vm.quantityUnits = undefined;

        /**
         * @ngdoc property
         * @propertyOf openlmis-quantity-unit-toggle.controller:QuantityUnitToggleController
         * @name quantityUnit
         * @type {Object}
         *
         * @description
         * Holds quantity unit.
         */
        vm.quantityUnit = undefined;

        /**
         * @ngdoc method
         * @methodOf openlmis-quantity-unit-toggle.controller:QuantityUnitToggleController
         * @name onInit
         *
         * @description
         * Initialization method called after the controller has been created. Responsible for
         * setting data to be available on the view.
         */
        function onInit() {
            vm.quantityUnits = [
                QUANTITY_UNIT.PACKS,
                QUANTITY_UNIT.DOSES
            ];

            vm.quantityUnit = quantityUnitConfigService.getEffectiveUnit();
        }

        /**
         * @ngdoc method
         * @methodOf openlmis-quantity-unit-toggle.controller:QuantityUnitToggleController
         * @name getMessage
         *
         * @description
         * Returns translated message for key.
         */
        function getMessage(unit) {
            return messageService.get(QUANTITY_UNIT.$getDisplayName(unit));
        }

        /**
         * @ngdoc method
         * @methodOf openlmis-quantity-unit-toggle.controller:QuantityUnitToggleController
         * @name onChange
         *
         * @description
         * Handles change in toggle.
         */
        function onChange() {
            quantityUnitConfigService.setSelectedUnit(vm.quantityUnit);
            $rootScope.$emit('openlmis.quantityUnit.selected', vm.quantityUnit);
        }

        /**
         * @ngdoc method
         * @propertyOf openlmis-quantity-unit-toggle.controller:QuantityUnitToggleController
         * @name isQuantityUnitToggleVisible
         *
         * @description
         * Returns information about quantity unit toggle visibility.
         */
        function isQuantityUnitToggleVisible() {
            return quantityUnitConfigService.getMode() === QUANTITY_UNIT.BOTH;
        }

    }
})();