periodicjs.core.controller
Version:
Customizable CMS platform
274 lines (239 loc) • 15 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: utility/aliased/aliased_rest.js</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Source: utility/aliased/aliased_rest.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>'use strict';
const path = require('path');
const wrapWithDeprecationWarning = require(path.join(__dirname, '../deprecate'));
var _controller_edit = function () {
/**
* Creates a middleware function that will render and "edit" view given a configuration. Alias for CoreController.protocol.api.initialize.EDIT or CoreController.meta.initialize_edit
* @param {Object} options Configurable options for "edit" view middleware (see periodicjs.core.protocols for more details)
* @return {Function} "edit" view middeware
*/
let fn = function controller_edit (options = {}) {
return this.protocol.api.initialize.EDIT(options);
};
let message = 'CoreController.controller_edit: Use CoreController.protocol.api.initialize.EDIT, CoreController.meta.initialize.EDIT or CoreController.meta.initialize_edit instead';
return wrapWithDeprecationWarning.call(this, fn, message);
};
var _controller_show = function (options = {}) {
/**
* Creates a middleware function that will render and "show" view given a configuration. Alias for CoreController.protocol.api.initialize.SHOW or CoreController.meta.initialize_show
* @param {Object} options Configurable options for "show" view middleware (see periodicjs.core.protocols for more details)
* @return {Function} "show" view middeware
*/
let fn = function controller_show (options = {}) {
return this.protocol.api.initialize.SHOW(options);
};
let message = 'CoreController.controller_show: Use CoreController.protocol.api.initialize.SHOW, CoreController.meta.initialize.SHOW or CoreController.meta.initialize_show instead';
return wrapWithDeprecationWarning.call(this, fn, message);
};
var _controller_new = function (options = {}) {
/**
* Creates a middleware function that will render and "new" view given a configuration. Alias for CoreController.protocol.api.initialize.NEW or CoreController.meta.initialize_new
* @param {Object} options Configurable options for "new" view middleware (see periodicjs.core.protocols for more details)
* @return {Function} "new" view middeware
*/
let fn = function controller_new (options = {}) {
return this.protocol.api.initialize.NEW(options);
};
let message = 'CoreController.controller_new: Use CoreController.protocol.api.initialize.NEW, CoreController.meta.initialize.NEW or CoreController.meta.initialize_new instead';
return wrapWithDeprecationWarning.call(this, fn, message);
};
var _controller_index = function (options = {}) {
/**
* Creates a middleware function that will render and "index" view given a configuration. Alias for CoreController.protocol.api.initialize.INDEX or CoreController.meta.initialize_index
* @param {Object} options Configurable options for "index" view middleware (see periodicjs.core.protocols for more details)
* @return {Function} "index" view middeware
*/
let fn = function controller_index (options = {}) {
return this.protocol.api.initialize.INDEX(options);
};
let message = 'CoreController.controller_index: Use CoreController.protocol.api.initialize.INDEX, CoreController.meta.initialize.INDEX or CoreController.meta.initialize_index instead';
return wrapWithDeprecationWarning.call(this, fn, message);
};
var _controller_search_index = function (options = {}) {
/**
* Creates a middleware function that will query for data and either render a view or send json content dependent of req options
* @param {Object} options Configurable options for "search" middleware (see periodicjs.core.protocols for more details)
* @return {Function} "search" data middleware
*/
let fn = function controller_search_index (options = {}) {
return this.protocol.api.initialize.SEARCH(options);
};
let message = 'CoreController.controller_search_index: Use CoreController.protocol.api.initialize.SEARCH, CoreController.meta.initialize.SEARCH or CoreController.meta.initialize_search instead';
return wrapWithDeprecationWarning.call(this, fn, message);
};
var _controller_create = function (options = {}) {
/**
* Creates a create document middleware function that will take req.body data and create a document in database
* @param {Object} options Configurable options for "create" middleware (see periodicjs.core.protocols for more details)
* @return {Function} "create" data middleware
*/
let fn = function controller_create (options = {}) {
return this.protocol.api.initialize.CREATE(options);
};
let message = 'CoreController.controller_create: Use CoreController.protocol.api.initialize.CREATE, CoreController.meta.initialize.CREATE or CoreController.meta.initialize_create instead';
return wrapWithDeprecationWarning.call(this, fn, message);
};
var _controller_cli = function (options = {}) {
/**
* Creates a query method that is meant to be usable through the CLI
* @param {Object} options Configurable options for "cli" method (see periodicjs.core.protocols for more details)
* @return {Function} "cli" method
*/
let fn = function controller_cli (options = {}) {
return this.protocol.api.initialize.CLI(options);
};
let message = 'CoreController.controller_cli: Use CoreController.protocol.api.initialize.CLI, CoreController.meta.initialize.CLI or CoreController.meta.initialize_cli instead';
return wrapWithDeprecationWarning.call(this, fn, message);
};
var _controller_update = function (options = {}) {
/**
* Creates a update document middleware function that will take req.body data and update a document in database
* @param {Object} options Configurable options for "update" middleware (see periodicjs.core.protocols for more details)
* @return {Function} "update" data middleware
*/
let fn = function controller_update (options = {}) {
return this.protocol.api.initialize.UPDATE(options);
};
let message = 'CoreController.controller_update: Use CoreController.protocol.api.initialize.UPDATE, CoreController.meta.initialize.UPDATE or CoreController.meta.initialize_update instead';
return wrapWithDeprecationWarning.call(this, fn, message);
};
var _controller_remove = function (options = {}) {
/**
* Creates a remove document middleware function that will take req.body data and remove a document in database
* @param {Object} options Configurable options for "remove" middleware (see periodicjs.core.protocols for more details)
* @return {Function} "remove" data middleware
*/
let fn = function controller_remove (options = {}) {
return this.protocol.api.initialize.REMOVE(options);
};
let message = 'CoreController.controller_remove: Use CoreController.protocol.api.initialize.REMOVE, CoreController.meta.initialize.REMOVE or CoreController.meta.initialize_remove instead';
return wrapWithDeprecationWarning.call(this, fn, message);
};
var _controller_load_model = function (options = {}) {
/**
* Creates a load document middleware function that will take req.body data and load a document in database
* @param {Object} options Configurable options for "load" middleware (see periodicjs.core.protocols for more details)
* @param {string} options.load_model_population Population settings for load method
* @return {Function} "load" data middleware
*/
let fn = function controller_load (options = {}) {
options.population = ((options.population) ? options.population : options.load_model_population) || '';
return this.protocol.api.initialize.LOAD(options);
};
let message = 'CoreController.controller_load: Use CoreController.protocol.api.initialize.LOAD, CoreController.meta.initialize.LOAD or CoreController.meta.initialize_load instead';
return wrapWithDeprecationWarning.call(this, fn, message);
};
var _controller_load_model_with_population = function (options = {}) {
/**
* Creates a load document middleware function that will take req.body data and load a document in database
* @param {Object} options Configurable options for "load" middleware (see periodicjs.core.protocols for more details)
* @param {string} options.load_multiple_model_population Population settings for load method
* @return {Function} "load" data middleware
*/
let fn = function controller_load (options = {}) {
options.population = ((options.population) ? options.population : options.load_multiple_model_population) || '';
return this.protocol.api.initialize.LOAD(options);
};
let message = 'CoreController.controller_load: Use CoreController.protocol.api.initialize.LOAD, CoreController.meta.initialize.LOAD or CoreController.meta.initialize_load instead';
return wrapWithDeprecationWarning.call(this, fn, message);
};
var _controller_model_query = function (options = {}) {
/**
* Creates a query document middleware that will return data or paginated data dependent on configuration
* @param {Object} options Configurable options for "query" middleware (see periodicjs.core.protocols for more details)
* @param {string} options.load_multiple_model_population Population settings for load method
* @return {Function} "paginate" data middleware
*/
let fn = function controller_model_query (options = {}) {
options.population = ((options.population) ? options.population : options.load_multiple_model_population) || '';
return this.protocol.api.initialize.PAGINATE(options);
};
let message = 'CoreController.controller_model_query: Use CoreController.protocol.api.initialize.PAGINATE, CoreController.meta.initialize.PAGINATE or CoreController.meta.initialize_paginate instead';
return wrapWithDeprecationWarning.call(this, fn, message);
};
var _controller_load_model_with_count = function (options = {}) {
/**
* Sets a default paramter of the request object the specifies that query should return back a paginated set of data
* @param {Object} options Configurable options (see periodicjs.core.protocols for more details)
* @return {Function} load data with count middleware
*/
let fn = function controller_load_model_with_count (options = {}) {
return this.protocol.api.initialize.LOAD_WITH_COUNT(options);
};
let message = 'CoreController.controllerload_model_with_count: Use CoreController.protocol.api.initialize.LOAD_WITH_COUNT, CoreController.meta.initialize.LOAD_WITH_COUNT or CoreController.meta.initialize_load_with_count instead';
return wrapWithDeprecationWarning.call(this, fn, message);
};
var _controller_load_model_with_default_limit = function (options = {}) {
/**
* Sets a default paramter of the request object the specifies that query should have default limit
* @param {Object} options Configurable options (see periodicjs.core.protocols for more details)
* @return {Function} load data with limit middleware
*/
let fn = function controller_load_model_with_default_limit (options = {}) {
return this.protocol.api.initialize.LOAD_WITH_LIMIT(options);
};
let message = 'CoreController.controller_load_model_with_default_limit: Use CoreController.protocol.api.initialize.LOAD_WITH_LIMIT, CoreController.meta.initialize.LOAD_WITH_LIMIT or CoreController.meta.initialize_load_with_limit instead';
return wrapWithDeprecationWarning.call(this, fn, message);
};
var _controller_routes = function (options = {}) {
/**
* Configures a set of routes following api specifications
* @param {Object} options Configurable options (see periodicjs.core.protocols for more details)
* @return {Function} A function that will implement an API strategy for routes
*/
let fn = function controller_routes (options = {}) {
return this.protocol.api.implement(options);
};
let message = 'CoreController.controller_routes: Use CoreController.protocol.api.implement, CoreController.meta.initialize_routes or CoreController.protocol.implement instead (see periodicjs.core.protocols API docs for description of difference between methods)';
return wrapWithDeprecationWarning.call(this, fn, message);
};
module.exports = {
controller_edit: _controller_edit,
controller_show: _controller_show,
controller_new: _controller_new,
controller_index: _controller_index,
controller_search_index: _controller_search_index,
controller_create: _controller_create,
controller_cli: _controller_cli,
controller_update: _controller_update,
controller_remove: _controller_remove,
controller_load_model: _controller_load_model,
controller_load_model_with_population: _controller_load_model_with_population,
controller_model_query: _controller_model_query,
controller_load_model_with_count: _controller_load_model_with_count,
controller_load_model_with_default_limit: _controller_load_model_with_default_limit,
controller_routes: _controller_routes
};
</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="CORE.html">CORE</a></li></ul><h3>Global</h3><ul><li><a href="global.html#_createModel">_createModel</a></li><li><a href="global.html#_deleteModel">_deleteModel</a></li><li><a href="global.html#_getPluginViewDefaultTemplate">_getPluginViewDefaultTemplate</a></li><li><a href="global.html#_getViewModelProperties">_getViewModelProperties</a></li><li><a href="global.html#_handleDocumentQueryErrorResponse">_handleDocumentQueryErrorResponse</a></li><li><a href="global.html#_handleDocumentQueryRender">_handleDocumentQueryRender</a></li><li><a href="global.html#_INITIALIZE_ALIASED_UTILITIES">_INITIALIZE_ALIASED_UTILITIES</a></li><li><a href="global.html#_INITIALIZE_UTILITY_RESPONDER">_INITIALIZE_UTILITY_RESPONDER</a></li><li><a href="global.html#_loadModel">_loadModel</a></li><li><a href="global.html#_logError">_logError</a></li><li><a href="global.html#_logWarning">_logWarning</a></li><li><a href="global.html#_renderView">_renderView</a></li><li><a href="global.html#_respondInKind">_respondInKind</a></li><li><a href="global.html#_searchModel">_searchModel</a></li><li><a href="global.html#_STARTUP">_STARTUP</a></li><li><a href="global.html#_updateModel">_updateModel</a></li><li><a href="global.html#save_revision">save_revision</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Fri Dec 23 2016 13:59:15 GMT-0500 (EST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>