Skip to content

Instantly share code, notes, and snippets.

@jparbros
Created September 28, 2018 14:15
Show Gist options
  • Save jparbros/4f2b7a67d203fc4077ea09453a010eda to your computer and use it in GitHub Desktop.
Save jparbros/4f2b7a67d203fc4077ea09453a010eda to your computer and use it in GitHub Desktop.
'use strict';
/**
* Controller handling search, category, and suggestion pages.
*
* @module controllers/Search
*/
/* API Includes */
var PagingModel = require('dw/web/PagingModel');
var URLUtils = require('dw/web/URLUtils');
var ContentMgr = require('dw/content/ContentMgr');
var SearchModel = require('dw/catalog/SearchModel');
/* Script Modules */
var app = require('~/cartridge/scripts/app');
var guard = require('~/cartridge/scripts/guard');
/**
* Renders a full-featured product search result page.
* If the httpParameterMao format parameter is set to "ajax" only the product grid is rendered instead of the full page.
*
* Checks for search redirects configured in Business Manager based on the query parameters in the
* httpParameterMap. If a search redirect is found, renders the redirect (util/redirect template).
* Constructs the search based on the HTTP params and sets the categoryID. Executes the product search and then the
* content asset search.
*
* If no search term, search parameter or refinement was specified for the search and redirects
* to the Home controller Show function. If there are any product search results
* for a simple category search, it dynamically renders the category page for the category searched.
*
* If the search query included category refinements, or is a keyword search it renders a product hits page for the category
* (rendering/category/categoryproducthits template).
* If only one product is found, renders the product detail page for that product.
* If there are no product results found, renders the nohits page (search/nohits template).
* @see {@link module:controllers/Search~showProductGrid|showProductGrid} function}.
*/
function show() {
var params = request.httpParameterMap;
if (params.format.stringValue === 'ajax' || params.format.stringValue === 'page-element') {
showProductGrid();
return;
}
var redirectUrl = SearchModel.getSearchRedirect(params.q.value);
if (redirectUrl){
app.getView({
Location: redirectUrl.location,
CacheTag: true
}).render('util/redirect');
return;
}
// Constructs the search based on the HTTP params and sets the categoryID.
var Search = app.getModel('Search');
var productSearchModel = Search.initializeProductSearchModel(params);
var contentSearchModel = Search.initializeContentSearchModel(params);
// execute the product search
productSearchModel.search();
contentSearchModel.search();
if (productSearchModel.emptyQuery && contentSearchModel.emptyQuery) {
response.redirect(URLUtils.abs('Home-Show'));
} else if (productSearchModel.count > 0) {
if ((productSearchModel.count > 1) || productSearchModel.refinedSearch || (contentSearchModel.count > 0)) {
var productPagingModel = new PagingModel(productSearchModel.productSearchHits, productSearchModel.count);
if (params.start.submitted) {
productPagingModel.setStart(params.start.intValue);
}
if (params.sz.submitted && request.httpParameterMap.sz.intValue <= 60) {
productPagingModel.setPageSize(params.sz.intValue);
} else {
productPagingModel.setPageSize(12);
}
if (productSearchModel.category) {
require('~/cartridge/scripts/meta').update(productSearchModel.category);
}
if (productSearchModel.categorySearch && !productSearchModel.refinedCategorySearch && productSearchModel.category.template) {
// Renders a dynamic template.
app.getView({
ProductSearchResult: productSearchModel,
ContentSearchResult: contentSearchModel,
ProductPagingModel: productPagingModel
}).render(productSearchModel.category.template);
} else {
//SearchPromo - for displaying search driven banners above the product grid, provided there is a q parameter in the httpParameterMap
var searchPromo;
if (params.q.value) {
searchPromo = ContentMgr.getContent('keyword_' + params.q.value.toLowerCase());
}
app.getView({
ProductSearchResult: productSearchModel,
ContentSearchResult: contentSearchModel,
ProductPagingModel: productPagingModel,
SearchPromo: searchPromo
}).render('rendering/category/categoryproducthits');
}
} else {
var targetProduct = productSearchModel.getProducts().next();
var productID = targetProduct.getID();
// If the target was not a master, simply use the product ID.
if (targetProduct.isMaster()) {
// In the case of a variation master, the master is the representative for
// all its variants. If there is only one variant, return the variant's
// product ID.
var iter = productSearchModel.getProductSearchHits();
if (iter.hasNext()) {
var productSearchHit = iter.next();
if (productSearchHit.getRepresentedProducts().size() === 1) {
productID = productSearchHit.getFirstRepresentedProductID();
}
}
}
app.getView({
Location: URLUtils.http('Product-Show', 'pid', productID)
}).render('util/redirect');
}
} else {
app.getView({
ProductSearchResult: productSearchModel,
ContentSearchResult: contentSearchModel
}).render('search/nohits');
}
}
/**
* Renders a full-featured content search result page.
*
* Constructs the search based on the httpParameterMap params and executes the product search and then the
* content asset search.
*
* If no search term, search parameter or refinement was specified for the search, it redirects
* to the Home controller Show function. If there are any content search results
* for a simple folder search, it dynamically renders the content asset page for the folder searched.
* If the search included folder refinements, it renders a folder hits page for the folder
* (rendering/folder/foldercontenthits template).
*
* If there are no product results found, renders the nohits page (search/nohits template).
*/
function showContent() {
var params = request.httpParameterMap;
var Search = app.getModel('Search');
var productSearchModel = Search.initializeProductSearchModel(params);
var contentSearchModel = Search.initializeContentSearchModel(params);
// Executes the product search.
productSearchModel.search();
contentSearchModel.search();
if (productSearchModel.emptyQuery && contentSearchModel.emptyQuery) {
response.redirect(URLUtils.abs('Home-Show'));
} else if (contentSearchModel.count > 0) {
var contentPagingModel = new PagingModel(contentSearchModel.content, contentSearchModel.count);
contentPagingModel.setPageSize(16);
if (params.start.submitted) {
contentPagingModel.setStart(params.start.intValue);
}
if (contentSearchModel.folderSearch && !contentSearchModel.refinedFolderSearch && contentSearchModel.folder.template) {
// Renders a dynamic template
app.getView({
ProductSearchResult: productSearchModel,
ContentSearchResult: contentSearchModel,
ContentPagingModel: contentPagingModel
}).render(contentSearchModel.folder.template);
} else {
app.getView({
ProductSearchResult: productSearchModel,
ContentSearchResult: contentSearchModel,
ContentPagingModel: contentPagingModel
}).render('rendering/folder/foldercontenthits');
}
} else {
app.getView({
ProductSearchResult: productSearchModel,
ContentSearchResult: contentSearchModel
}).render('search/nohits');
}
}
/**
* Renders the search suggestion page (search/suggestions template).
*/
function getSuggestions() {
app.getView().render('search/suggestions');
}
/**
* Renders the partial content of the product grid of a search result as rich HTML.
*
* Constructs the search based on the httpParameterMap parameters and executes the product search and then the
* content asset search. Constructs a paging model and determines whether the infinite scrolling feature is enabled.
*
* If there are any product search results for a simple category search, it dynamically renders the category page
* for the category searched.
*
* If the search query included category refinements or is a keyword search, it renders a product hits page for the category
* (rendering/category/categoryproducthits template).
*/
function showProductGrid() {
var params = request.httpParameterMap;
// Constructs the search based on the HTTP params and sets the categoryID.
var Search = app.getModel('Search');
var productSearchModel = Search.initializeProductSearchModel(params);
var contentSearchModel = Search.initializeContentSearchModel(params);
// Executes the product search.
productSearchModel.search();
contentSearchModel.search();
var productPagingModel = new PagingModel(productSearchModel.productSearchHits, productSearchModel.count);
if (params.start.submitted) {
productPagingModel.setStart(params.start.intValue);
}
if (params.sz.submitted && params.sz.intValue <= 60) {
productPagingModel.setPageSize(params.sz.intValue);
} else {
productPagingModel.setPageSize(12);
}
if (dw.system.Site.getCurrent().getCustomPreferenceValue('enableInfiniteScroll') && params.format.stringValue === 'page-element') {
app.getView({
ProductSearchResult: productSearchModel,
ProductPagingModel: productPagingModel
}).render('search/productgridwrapper');
} else {
if (productSearchModel.categorySearch && !productSearchModel.refinedCategorySearch && productSearchModel.category.template) {
// Renders a dynamic template.
app.getView({
ProductSearchResult: productSearchModel,
ContentSearchResult: contentSearchModel,
ProductPagingModel: productPagingModel
}).render(productSearchModel.category.template);
} else {
app.getView({
ProductSearchResult: productSearchModel,
ContentSearchResult: contentSearchModel,
ProductPagingModel: productPagingModel
}).render('rendering/category/categoryproducthits');
}
}
}
/*
* Web exposed methods
*/
/** Renders a full featured product search result page.
* @see module:controllers/Search~show
* */
exports.Show = guard.ensure(['get'], show);
/** Renders a full featured content search result page.
* @see module:controllers/Search~showContent
* */
exports.ShowContent = guard.ensure(['get'], showContent);
/** Determines search suggestions based on a given input and renders the JSON response for the list of suggestions.
* @see module:controllers/Search~getSuggestions */
exports.GetSuggestions = guard.ensure(['get'], getSuggestions);
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment