BaseController class - Documentation for SproutCMS

Info Page:

Page options:

class BaseController

This is a true base controller.

It does nothing but base things.

File: /sprout/Controllers/BaseController.php
Namespace: Sprout\Controllers
This class is abstract

Functions

Name	Visibility	Description
__call	public	Handles methods that do not exist.
__construct	public
_run	public	The router/kohana will invoke this method to invoke an action.
getCssClassName	public	Return the class name for this controller, expressed in CSS style, i.e. with dashes
getModulePath	public	Gets the relative path to the module the controller lives in, or sprout itself

public __call

void $BaseController->__call ( string $method , array $args );

Handles methods that do not exist.

public __construct

void $BaseController->__construct ( );

This function does not have a description

public _run

void $BaseController->_run ( mixed $method , mixed $args );

The router/kohana will invoke this method to invoke an action.

If you please, you may wrap this method to create before/after hooks.

public getCssClassName

string $BaseController->getCssClassName ( );

Return the class name for this controller, expressed in CSS style, i.e. with dashes

Example: When called from BlogPostController --> 'blog-post-controller'

public getModulePath

string $BaseController->getModulePath ( );

Gets the relative path to the module the controller lives in, or sprout itself

SproutCMS