Ghost/core/server/helpers/foreach.js
Katharina Irrgang 397400b4f8
Moved visibility utility to static model fn (#9327)
refs #9178

- this logic belongs to a static model helper
- the visibility property is a model property, the knowledge about the visibility values belongs to the model
- rename the functions, so they make more sense
2017-12-13 13:19:51 +01:00

108 lines
3.3 KiB
JavaScript

// # Foreach Helper
// Usage: `{{#foreach data}}{{/foreach}}`
//
// Block helper designed for looping through posts
var proxy = require('./proxy'),
_ = require('lodash'),
logging = proxy.logging,
i18n = proxy.i18n,
models = proxy.models,
hbsUtils = proxy.hbs.Utils,
createFrame = proxy.hbs.handlebars.createFrame;
function filterItemsByVisibility(items, options) {
var visibilityArr = models.Base.Model.parseVisibilityString(options.hash.visibility);
return models.Base.Model.filterByVisibility(items, visibilityArr, !!options.hash.visibility);
}
module.exports = function foreach(items, options) {
if (!options) {
logging.warn(i18n.t('warnings.helpers.foreach.iteratorNeeded'));
}
if (hbsUtils.isFunction(items)) {
items = items.call(this);
}
// Exclude items which should not be visible in the theme
items = filterItemsByVisibility(items, options);
// Initial values set based on parameters sent through. If nothing sent, set to defaults
var fn = options.fn,
inverse = options.inverse,
columns = options.hash.columns,
length = _.size(items),
limit = parseInt(options.hash.limit, 10) || length,
from = parseInt(options.hash.from, 10) || 1,
to = parseInt(options.hash.to, 10) || length,
output = '',
data,
contextPath;
// If a limit option was sent through (aka not equal to default (length))
// and from plus limit is less than the length, set to to the from + limit
if ((limit < length) && ((from + limit) <= length)) {
to = (from - 1) + limit;
}
if (options.data && options.ids) {
contextPath = hbsUtils.appendContextPath(options.data.contextPath, options.ids[0]) + '.';
}
if (options.data) {
data = createFrame(options.data);
}
function execIteration(field, index, last) {
if (data) {
data.key = field;
data.index = index;
data.number = index + 1;
data.first = index === from - 1; // From uses 1-indexed, but array uses 0-indexed
data.last = !!last;
data.even = index % 2 === 1;
data.odd = !data.even;
data.rowStart = index % columns === 0;
data.rowEnd = index % columns === (columns - 1);
if (contextPath) {
data.contextPath = contextPath + field;
}
}
output = output + fn(items[field], {
data: data,
blockParams: hbsUtils.blockParams([items[field], field], [contextPath + field, null])
});
}
function iterateCollection(context) {
// Context is all posts on the blog
var current = 1;
// For each post, if it is a post number that fits within the from and to
// send the key to execIteration to set to be added to the page
_.each(context, function (item, key) {
if (current < from) {
current += 1;
return;
}
if (current <= to) {
execIteration(key, current - 1, current === to);
}
current += 1;
});
}
if (items && typeof items === 'object') {
iterateCollection(items);
}
if (length === 0) {
output = inverse(this);
}
return output;
};