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

94% Statements 47/50
66.67% Branches 4/6
93.33% Functions 28/30
94% Lines 47/50

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 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296    45x                             45x               377x 1447x     377x                 377x                 127x                 377x                 3849x                                         2832x                 377x                 683x                 11x                       3135x                   12x   12x                       3837x                 683x                 1404x                 9x                 377x                 683x             2x                 683x 683x 683x   683x   683x     683x 683x   683x 683x 683x   683x 683x 683x     683x                 669x                                       683x 586x 586x   586x 586x     586x                                     586x 580x     586x        
'use strict';
 
define([
    'jquery',
    'underscore',
    'oro/translator',
    'oro/mediator',
    'pim/form',
    'pim/template/filter/filter'
], function (
    $,
    _,
    __,
    mediator,
    BaseForm,
    filterTemplate
) {
    return BaseForm.extend({
        className: 'AknFieldContainer control-group filter-item',
        elements: {},
        editable: true,
        removable: false,
        filterTemplate: _.template(filterTemplate),
 
        configure: function () {
            this.listenTo(this.getRoot(), 'pim_enrich:form:entity:pre_update', function (data) {
                _.defaults(data, {field: this.getCode()});
            }.bind(this));
 
            return BaseForm.prototype.configure.apply(this, arguments);
        },
 
        /**
         * Sets the parentForm code on which this filter operates.
         *
         * @param {string} parentForm
         */
        setParentForm: function (parentForm) {
            this.parentForm = parentForm;
        },
 
        /**
         * Gets the parentForm code on which this filter operates.
         *
         * @return {string}
         */
        getParentForm: function () {
            return this.parentForm;
        },
 
        /**
         * Sets the filter code  (code: 'categories', field: 'categories')
         *
         * @param {string} code
         */
        setCode: function (code) {
            this.filterCode = code;
        },
 
        /**
         * Gets the filter code (code: 'categories', field: 'categories')
         *
         * @return {string}
         */
        getCode: function () {
            return this.filterCode;
        },
 
        /**
         * Sets the field code on which this filter operates. (code: 'categories', field: 'categories')
         *
         * @param {string} field
         */
        setField: function (field) {
            this.setData(
                {field: field},
                {silent: true}
            );
        },
 
        /**
         * Gets the field code on which this filter operates.  (code: 'categories', field: 'categories')
         *
         * @return {string}
         */
        getField: function () {
            return this.getFormData().field;
        },
 
        /**
         * Type setter
         *
         * @param {string} type
         */
        setType: function (type) {
            this.type = type;
        },
 
        /**
         * Get the type identifier
         *
         * @return {string}
         */
        getType: function () {
            return this.type;
        },
 
        /**
         * Set the field operator
         *
         * @param {string} operator
         */
        setOperator: function (operator) {
            this.setData(
                {operator: operator},
                {silent: true}
            );
        },
 
        /**
         * Gets the current operator.
         *
         * @return {string}
         */
        getOperator: function () {
            return this.getFormData().operator;
        },
 
        /**
         * Sets the current value.
         *
         * @param {string} value
         * @param {object} [options]
         */
        setValue: function (value, options) {
            options = options || {silent: true};
 
            this.setData(
                {value: value},
                options
            );
        },
 
        /**
         * Gets the current value.
         *
         * @return {string}
         */
        getValue: function () {
            return this.getFormData().value;
        },
 
        /**
         * Sets this filter as editable or not.
         *
         * @param {boolean} editable
         */
        setEditable: function (editable) {
            this.editable = Boolean(editable);
        },
 
        /**
         * Is this filter editable?
         *
         * @returns {boolean}
         */
        isEditable: function () {
            return this.editable;
        },
 
        /**
         * Returns whether this filter is empty.
         *
         * @returns {boolean}
         */
        isEmpty: function () {
            return false;
        },
 
        /**
         * Sets this filter as removable or not.
         *
         * @param {boolean} removable
         */
        setRemovable: function (removable) {
            this.removable = removable;
        },
 
        /**
         * Is this filter removable?
         *
         * @return {boolean}
         */
        isRemovable: function () {
            return this.removable;
        },
 
        /**
         * Triggers the filter removal event.
         */
        removeFilter: function () {
            this.trigger('filter:remove', this.getField());
        },
 
        /**
         * Renders the filter.
         *
         * @return {Object}
         */
        render: function () {
            var promises  = [];
            this.elements = {};
            this.setEditable(true);
 
            mediator.trigger('pim_enrich:form:filter:extension:add', {filter: this, promises: promises});
 
            $.when.apply($, promises)
                .then(this.getTemplateContext.bind(this))
                .then(function (templateContext) {
                    this.el.dataset.name = this.getField();
                    this.el.dataset.type = this.getType();
 
                    this.$el.html(this.filterTemplate(templateContext));
                    this.$('.remove').on('click', this.removeFilter.bind(this));
                    this.$('.filter-input').replaceWith(this.renderInput(templateContext));
 
                    this.renderElements();
                    this.postRender(templateContext);
                    this.delegateEvents();
                }.bind(this));
 
            return this;
        },
 
        /**
         * Gets the template context.
         *
         * @returns {Promise}
         */
        getTemplateContext: function () {
            return $.Deferred().resolve({
                label: __('pim_enrich.export.product.filter.' + this.shortname + '.title'),
                removable: this.isRemovable(),
                editable: this.isEditable()
            }).promise();
        },
 
        /**
         * Renders the input inside the filter area.
         *
         * @throws {Error} if this method is not implemented
         */
        renderInput: function () {
            throw new Error('You should implement your filter template');
        },
 
        /**
         * Renders extension elements of the filter.
         */
        renderElements: function () {
            _.each(this.elements, function (elements, position) {
                var $container = this.$('.' + position + '-elements-container');
                $container.empty();
 
                _.each(elements, function (element) {
                    Iif ('function' === typeof element.render) {
                        $container.append(element.render().$el);
                    } else {
                        $container.append(element);
                    }
                });
            }.bind(this));
        },
 
        /**
         * Called after rendering the input.
         */
        postRender: function () {},
 
        /**
         * Adds an extension element to this filter.
         *
         * @param {string} position 'label', 'after-input' or 'below-input'
         * @param {string} code
         * @param {Object} element
         */
        addElement: function (position, code, element) {
            if (!this.elements[position]) {
                this.elements[position] = {};
            }
 
            this.elements[position][code] = element;
        }
    });
});