All files / web/bundles/pimui/js/filter/attribute attribute.js

78.87% Statements 56/71
61.76% Branches 21/34
76.19% Functions 16/21
78.87% Lines 56/71

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276                    25x                                         25x         49x 49x     49x                   2x 2x   2x                 24x 2x     22x                   8x 8x   8x                 54x 4x     50x             125x     125x 125x           125x                   125x   125x 13x 13x 13x   13x   13x                     13x     125x 28x 28x 28x   28x   28x       2x 2x 2x         28x     125x                     111x       111x                                                                                                             13x 11x   2x                       30x 24x   6x                   124x 124x 852x 852x 852x 790x   852x     124x        
/**
 * Abstract attribute filter
 *
 * @author    Yohan Blain <yohan.blain@akeneo.com>
 * @copyright 2016 Akeneo SAS (http://www.akeneo.com)
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 */
 
'use strict';
 
define([
    'jquery',
    'underscore',
    'oro/translator',
    'pim/filter/filter',
    'pim/fetcher-registry',
    'pim/i18n',
    'pim/user-context',
    'pim/product-edit-form/scope-switcher',
    'pim/product-edit-form/locale-switcher'
], function (
    $,
    _,
    __,
    BaseFilter,
    FetcherRegistry,
    i18n,
    UserContext,
    ScopeSwitcher,
    LocaleSwitcher
) {
    return BaseFilter.extend({
        /**
         * {@inherit}
         */
        initialize: function (config) {
            Eif (undefined !== config) {
                this.config = config.config;
            }
 
            return BaseFilter.prototype.initialize.apply(this, arguments);
        },
 
        /**
         * Sets the scope code on which this filter operates.
         *
         * @param {string} scope
         * @param {Object} options
         */
        setScope: function (scope, options) {
            var context = this.getFormData().context || {};
            context.scope = scope;
 
            this.setData({context: context}, options);
        },
 
        /**
         * Gets the scope code on which this filter operates.
         *
         * @return {string}
         */
        getScope: function () {
            if (undefined === this.getFormData().context) {
                return null;
            }
 
            return this.getFormData().context.scope;
        },
 
        /**
         * Sets the locale code on which this filter operates.
         *
         * @param {string} locale
         * @param {Object} options
         */
        setLocale: function (locale, options) {
            var context = this.getFormData().context || {};
            context.locale = locale;
 
            this.setData({context: context}, options);
        },
 
        /**
         * Gets the locale code on which this filter operates.
         *
         * @return {string}
         */
        getLocale: function () {
            if (undefined === this.getFormData().context) {
                return null;
            }
 
            return this.getFormData().context.locale;
        },
 
        /**
         * {@inheritdoc}
         */
        renderElements: function () {
            FetcherRegistry.getFetcher('attribute')
                .fetch(this.getCode())
                .then(function (attribute) {
                    Eif (this.isEditable()) {
                        this.addContextDropdowns(attribute);
                    } else {
                        this.addContextLabels(attribute);
                    }
                }.bind(this))
                .then(function () {
                    BaseFilter.prototype.renderElements.apply(this, arguments);
                }.bind(this));
        },
 
        /**
         * Adds the context dropdown to the filter in edit mode according to attribute information.
         *
         * @param {Object} attribute
         */
        addContextDropdowns: function (attribute) {
            var container = $('<span class="AknFieldContainer-contextContainer AknButtonList filter-context">');
 
            if (attribute.scopable) {
                var scopeSwitcher = new ScopeSwitcher({config: {context: 'base_product'}});
                scopeSwitcher.setDisplayInline(false);
                scopeSwitcher.setDisplayLabel(false);
 
                this.listenTo(scopeSwitcher, 'pim_enrich:form:scope_switcher:pre_render', this.initScope.bind(this));
 
                this.listenTo(
                    scopeSwitcher,
                    'pim_enrich:form:scope_switcher:change',
                    function (scopeEvent) {
                        if ('base_product' === scopeEvent.context) {
                            this.setScope(scopeEvent.scopeCode, {silent: true});
                            this.trigger('pim_enrich:form:entity:post_update');
                        }
                    }.bind(this)
                );
 
                container.append(scopeSwitcher.render().$el);
            }
 
            if (attribute.localizable) {
                var localeSwitcher = new LocaleSwitcher({config: {context: 'base_product'}});
                localeSwitcher.setDisplayInline(false);
                localeSwitcher.setDisplayLabel(false);
 
                this.listenTo(localeSwitcher, 'pim_enrich:form:locale_switcher:pre_render', this.initLocale.bind(this));
 
                this.listenTo(
                    localeSwitcher,
                    'pim_enrich:form:locale_switcher:change',
                    function (localeEvent) {
                        Eif ('base_product' === localeEvent.context) {
                            this.setLocale(localeEvent.localeCode, {silent: true});
                            this.trigger('pim_enrich:form:entity:post_update');
                        }
                    }.bind(this)
                );
 
                container.append(localeSwitcher.render().$el);
            }
 
            this.addElement(
                'after-label',
                'filter-context',
                container
            );
        },
 
        /**
         * {@inheritdoc}
         */
        getTemplateContext: function () {
            return $.when(
                BaseFilter.prototype.getTemplateContext.apply(this, arguments),
                FetcherRegistry.getFetcher('attribute').fetch(this.getCode())
            ).then(function (templateContext, attribute) {
                return _.extend({}, templateContext, {
                    label: i18n.getLabel(attribute.labels, UserContext.get('uiLocale'), attribute.code),
                    attribute: attribute
                });
            }.bind(this));
        },
 
        /**
         * Adds the context labels to the filter in view mode according to attribute information.
         *
         * @param {Object} attribute
         */
        addContextLabels: function (attribute) {
            var promises = [];
 
            if (attribute.scopable && this.getScope()) {
                promises.push(FetcherRegistry.getFetcher('channel')
                    .fetch(this.getScope())
                    .then(function (channel) {
                        return $('<span>').html(channel.label);
                    })
                );
            }
 
            if (attribute.localizable && this.getLocale()) {
                promises.push(
                    $.Deferred()
                        .resolve($('<span>').html(i18n.getFlag(this.getLocale())))
                        .promise()
                );
            }
 
            $.when.apply($, promises)
                .then(function () {
                    var container = $('<span class="AknButtonList filter-context">');
                    _.each(_.toArray(arguments), function (item) {
                        container.append(item);
                    });
 
                    this.addElement(
                        'after-input',
                        'filter-context',
                        container
                    );
                }.bind(this));
        },
 
        /**
         * Initialize the scope
         *
         * @param {Object} scopeEvent
         * @param {string} scopeEvent.context
         * @param {string} scopeEvent.scopeCode
         */
        initScope: function (scopeEvent) {
            if (this.getScope()) {
                scopeEvent.scopeCode = this.getScope();
            } else {
                this.setScope(scopeEvent.scopeCode, {silent: true});
            }
        },
 
        /**
         * Initialize the locale
         *
         * @param {Object} localeEvent
         * @param {string} localeEvent.context
         * @param {string} localeEvent.localeCode
         */
        initLocale: function (localeEvent) {
            if (this.getLocale()) {
                localeEvent.localeCode = this.getLocale();
            } else {
                this.setLocale(localeEvent.localeCode, {silent: true});
            }
        },
 
        /**
         * Returns the list of the operator choices with their translations.
         *
         * @returns {object}
         */
        getLabelledOperatorChoices(shortName) {
            let result = {};
            this.config.operators.forEach((operator) => {
                const key = 'pim_enrich.export.product.filter.' + shortName + '.operators.' + operator;
                let translation = __(key);
                if (translation === key) {
                    translation = __('pim_common.operators.' + operator);
                }
                result[operator] = translation;
            });
 
            return result;
        }
    });
});