Controller

Controller.prototype.addLayout = function addLayout( layout )

adds a layout layer to this this request

Parameters

This layout will in included after the global default layout, the controller default layout, and any previously defined layouts for this controller

See

• Layouts

Controller.prototype.setLayout = function setLayout( layout )

Sets a single layout layer to this this request, clearing any existing layouts

Parameters

Detail

disables global and controller default layouts.  If layout is a layout name or path, then that will be the only layout applied

See

• Layouts

Controller.prototype.addFilter = function addFilter( filter, options )

Adds an action filter

Parameters

Options

Filter Function Parameters

Events

Detail

Filters are functions run before or after actions and/or before and after rendering the view for an action.  Filters, by default, are run before every action, but can be applied to only specific actions.  Great uses of filters are authentication and logging.  Filters are only executed in standard request handling, callAction, and include.  Direct execution of an action will not trigger filters.

Examples

function init(){
    // exec an auth function before every action except
    // "home" and "status"
    this.addFilter(
        this._auth,
        {
            except:["home","status"]
        }
    )

    //log only actions whose name starts with "save"
    this.addFilter(
        this._audit,
        {
            only:[/^save/i]
        }
    )

    this.addFilter(
        this._pdfView,
        {
            when:"afterRender"
        }
    )

}


// Functions that begin with "_" are not considered actions and
// are excluded from browser requests
function _auth(controller,action,params){
    if (!$cookie.getAuthUser()){
        $FP.redirectTo({
            controller:"Auth",
            action:"login"
        })
        //unnecessary, becasue redirecTo halts processing, but good practice
        return false; //cancels action
    }
}

function _audit(controller,action,params){
    Myna.log(
        "audit",
        controller.name + "." + action,
        Myna.dump({
            params:params,
            user:$cookie.getAuthUser()
        })
    );
}

function _pdfView(controller, action, params){
    if (params.format =="pdf"){
        // calling render or renderContent prevents default view from rendering
        this.renderContent(
            Myna.xmlToPdf(
                Myna.htmlToXhtml(
                    $res.clear()
                )
            ),
            "application/pdf",
            params.controller + "." + params.action + ".pdf"
        );
    }
}

Controller.prototype.applyBehavior = function applyBehavior( name, options )

loads a behavior and applies it to this object

Parameters

Detail

Loads a behavior by name from app/behaviors/controllers/ or framework/behaviors/controllers/, whichever is found first.  Behaviors are functions that are applied to the current object.  applyBehavior should be called from init

Example

//in some_controller.sjs
function init(){
    // loads the built-in PDF andJSON filters
    // Each of these has an "init" function that adds the appropriate
    // before and after filters
    this.applyBehavior([
        "FormatPdf",
        "FormatJson"
    ]);

    //loads a single behavior with options
    this.applyBehavior("MynaAuth",{
        whitelist:[
            "Main.index",
            "Main.logout"
        ],
        redirectParams:{
            message: "Enter your AD domain credentials",
            providers:["ldap_ad"]
        }
    });
}

See

• Behaviors

Controller.prototype.getFilters = function addFilter( event, action )

returns the filter array for the requested event and action.

Parameters

See

• addFilter

Controller.prototype.getActions = function getActions()

returns an array of objects for each action that contain the action name and action function.

Object Properties

Controller.prototype.callAction = function callAction( action, params )

Call an action as an inline function.

Parameters

Detail

Calling this function on a controller will execute the specified action “inline”, meaning without generating output, and will return whatever the action returns.  Before and after action filters are also triggered.  This can be useful for marshaling several actions in one request, or for providing alternate ways of calling actions (see <framework.controllers.DirectController>)

Example

//triggers filters, so will fail if cur user is not authorized
var empList = $FP.getController("employee").callAction("list",params);

Note

You can also call actions directly from a controller, but filters won’t be triggered.

// does not run filters, but might render output if render() or
// renderContent() is called inside this action
var empList = $FP.getController("employee").list(params);

Controller.prototype.include = function include( action, params )

Call an action and includes its output in the current request

Parameters

Detail

Calling this function on a controller will execute the specified action, appending any output generated to the current request.  This will also return any response from the action.  Before and after action filters are also triggered.  This can be useful for including several actions in one request.

Example

// triggers filters, so will fail if cur user is not authorized
// includes employee listing table in the current view
$FP.getController("employee").callAction("list",params);

Controller.prototype.init = function init( controllerName )

Initializes a controller instance

Whenever a controller is instantiated, init() is run to configure the instance.  First the init() in the controller base class is run, then the init() in app/controllers/global.sjs, and finally the init() in app/controllers/<name>_controller.sjs

This is a good place to call this.applyBehavior, this.addFilter and this.add/setLayout

See Also

• applyBehavior
• addFilter
• addLayout

Controller.prototype.render = function render( options )

renders a view

Parameters

Options

Detail

This function is called automatically with default options whenever an action function returns.  This function can be called explicitly from inside an action function to override this default behavior

When rendering a view, all previously generated content is cleared, and the view is included.  Once the view is rendered, it is wrapped in any defined layouts (see <addLayout>) The following variables are available in view scope, and can be directly referenced:

View Scope properties

Examples

//in app/controllers/person_controller.sjs
function doStuff(params){
    //bulk sets/replaces this.data
    this.set({
        firstName:"Bob",
        lastName:"Dobb"
    })

    //sets an individual property
    this.set("bean",this.Person.get({id:params.id}))

    // implied render, same as
    // this.render({controller:this.name,action:"doStuff"})
}

//in app/views/person/person_do_stuff.ejs
<%=getElement("form_wrap",{title:"Edit Employee"})%>
<form action="<%=Html.url({action:"save",id:bean.id})%>" method="post">
<table width="100%" height="1" cellpadding="0" cellspacing="0" border="0" >
    <tr>
        <th class="">ID:</th><td><%=bean.id%><td>
    </tr>

    <tr>
        <th><%=bean.getLabel("first_name")%>:</th>
        <td><input name="first_name" value="<%=String(bean.data.first_name||"").escapeHtml()%>"><td>
    </tr>
    <tr>
        <th><%=bean.getLabel("last_name")%>:</th>
        <td><input name="last_name" value="<%=String(bean.data.last_name||"").escapeHtml()%>"><td>
    </tr>

    <tr>
        <td colspan="2" align="right">
            <button type="submit">Save</button>
        </td>
    </tr>
</table>
</form>
<%=getElement("form_wrap",{type:"end"})%>


//in app/elements/form_wrap.ejs
<@if type == "end">
    </div>
<@else>
    <div class="form_wrap">
    <div class="caption"><%=title||""%></div>
</@if>

//in app/elements/form_footer.ejs
</div>

See

• Views

Controller.prototype.renderContent = function renderBinary( data, contentType, filename )

Directly render content, bypassing default render

Parameters

See

$res.printBinary

Controller.prototype.getElement = function renderElement( element, options )

renders an HTML template returns the content as a string

Parameters

Element Scope properties

This function is normally used inside view templates.  See render for example usage

Examples

//in app/views/test/index.ejs

<%=getElement("shared/common_commonlinks.ejs")%>
<%=getElement()%>

See

• Elements

Controller.prototype.set = function set( prop, val )

Sets a property on data

Parameters

All top level properties of data become global variables in views and elements.

Returns val

Examples

function myAction(params){
    //set single property
    this.set("firstName","Bob")

    //set multiple properties, preserves "firstName" set earlier
    this.set({
        lastName:"Dobb",
        age:56
    })

    //you can also directly manipulate the data object
    this.data.position="Slackmaster"
}