Properties

$_action

(string) The action being requested of (performed by) the controller.

$_action_default

(string) The default controller action.

$_action_format

(array) Tells which alternative output formats are supported by which actions.

Array format is 'action' => array('format', 'format', 'format').

If an action is not listed, it will not respond to alternative formats.

Using a '*' as the action key means "all actions allow this format".

For example ...

<?php
$_action_format = array(
    // multiple formats
    'browse' => array('rss', 'atom')
    // shorthand for just one format
    'read'   => 'atom',
    // shorthand for all actions
    '*'      => 'xml'
);

$_charset

(string) The character set to use when setting the Content-Type header.

$_config

(array) Collection point for configuration values.

Inherited from Solar_Base.

Note that you do not define config defaults in $_config directly.

<?php
// DO NOT DO THIS
protected $_config = array(
    'foo' => 'bar',
    'baz' => 'dib',
);

Instead, define config defaults in a protected property named for the class, withan underscore prefix.

For exmple, a "Vendor_Class_Name" class would define the default config array in "$_Vendor_Class_Name". This convention lets child classes inherit parent config keys and values.

<?php
// DO THIS INSTEAD
protected $_Vendor_Class_Name = array(
    'foo' => 'bar',
    'baz' => 'dib',
);

$_controller

(string) The short-name of this page-controller.

$_errors

(array) An array of application error messages.

$_format

(string) Use this output format for views.

For example, say the action is "read". In the default case, the format is empty, so the _render() method will look for a view named "read.php". However, if the format is "xml", the _render() method will look for a view named "read.xml.php".

Has no effect on the layout script that _render() looks for.

$_format_default

(string) What is the default output format?

$_format_layout

(string) Which formats go with which layouts?

Empty/false/null means "no layout", boolean true means "the current or default layout", and a string means that particular layout.

The default is that XHTML formats use the current layout, and all other explicit formats get no layout.

$_format_type

(array) Maps format name keys to Content-Type values.

When $this->_format matches one of the keys, the controller will set the matching Content-Type header automatically in the response object.

$_front

(Solar_Controller_Front) The front-controller object (if any) that invoked this page-controller.

$_helper_class

(array) These helper classes will be added in the middle of the stack, between the Solar_View_Helper final fallbacks and the vendor+app specific helpers.

$_info

(array) Request parameters collected from the URI pathinfo.

$_layout

(string) The name of the layout to be rendered.

$_layout_default

(string) The default layout to use.

$_layout_var

(string) The name of the variable where content is placed in the layout.

Default is 'layout_content'.

$_process_key

(string) Name of the form element that holds the process request value (such as 'Save', 'Next', 'Cancel', etc)

Default is 'process', as in $_POST['process'].

$_query

(string) Request parameters collected from the URI query string.

$_request

(Solar_Request) Request environment details: get, post, etc.

$_response

(Solar_Http_Response) The response object with headers and body.

$_rewrite

(Solar_Uri_Rewrite) The rewrite rules object.

$_session

(Solar_Session) Session data, including read-once flashes.

$_view

(string) The name of the view to be rendered.

$_view_class

(string) The class used for view objects.

$_view_object

(Solar_View) The object used for rendering views and layouts.