jii/base/Action.js

Jii - Full-Stack JavaScript Framework

/**
 * @author <a href="http://www.affka.ru">Vladimir Kozhin</a>
 * @license MIT
 */


'use strict';

const InvalidConfigException = require('../exceptions/InvalidConfigException');
const _isFunction = require('lodash/isFunction');
const BaseObject = require('./BaseObject');

class Action extends BaseObject {

    preInit(id, controller, config) {
        /**
         * @type {string} ID of the action
         */
        this.id = id;

        /**
         * @type {Controller} the controller that owns this action
         */
        this.controller = controller;

        super.preInit(config);
    }

    /**
     * Returns the unique ID of this action among the whole application.
     * @returns {string} the unique ID of this action among the whole application.
     */
    getUniqueId() {
        return this.controller.getUniqueId() + '/' + this.id;
    }

    /**
     * @param {Context} context
     */
    run(context) {
    }

    /**
     * Runs this action with the specified parameters.
     * This method is mainly invoked by the controller.
     * @param {Context} context
     * @returns {Promise} the result of the action
     * @throws {InvalidConfigException} if the action class does not have a run() method
     */
    runWithParams(context) {
        if (!_isFunction(this.run)) {
            throw new InvalidConfigException(this.className() + ' must define a `run()` method.');
        }

        //Yii::trace('Running action: ' . get_class($this) . '::run()', __METHOD__);

        return Promise.resolve(this.beforeRun(context)).then(bool => {
            if (!bool) {
                return Promise.reject();
            }

            return this.run(context);
        }).then(result => {
            return Promise.resolve(this.afterRun()).then(() => result);
        });
    }

    /**
     * This method is called right before `run()` is executed.
     * You may override this method to do preparation work for the action run.
     * If the method returns false, it will cancel the action.
     * @param {Context} context
     * @return {Promise|boolean} whether to run the action.
     */
    beforeRun(context) {
        return true;
    }

    /**
     * This method is called right after `run()` is executed.
     * You may override this method to do post-processing work for the action run.
     */
    afterRun() {
    }

}
module.exports = Action;