Previous Page
Constants

Solar_App_Bookmarks
Properties

Next Page
Methods

Properties

Public

$action

(string) The current action for the contoller; populated from $this->_action.

Inherited from Solar_App_Base.

$area

(Solar_Model_Areas_Record) The area we're using.

(string) A link back to the previous page: list results, bookmarked page, etc.

$controller

(string) The name of this contoller; populated from $this->_name.

Inherited from Solar_App_Base.

$count

(int) The total number of records in the query.

$errors

(array|Exception) Error messages, usually for the 'error' action/view.

Inherited from Solar_App_Base.

In some cases, this may be an Exception object.

$feed

(array) Feed information.

$formdata

(Solar_Form) The current form processing object.

$layout

(string) The name of the layout being used; populated from $this->_layout.

Inherited from Solar_App_Base.

$layout_head

(array) Values for the <head> block in the layout.

Inherited from Solar_App_Base.

Keys are:

title
(string) The <title> tag value.
base
(string) The <base> href value.
meta
(array) An array of <meta> tag values.
link
(array) An array of <link> tag values.
style
(array) An array of <style> tag values.
script
(array) An array of <script> tag values.
object
(array) An array of <object> tag values.

$layout_local

(array) Local navigation links.

Inherited from Solar_App_Base.

Format is "link href" => "display text".

$layout_local_active

(array) The currently-active local navigation link.

Inherited from Solar_App_Base.

Refers to a key in $layout_local.

$layout_nav

(array) Site navigation links.

Inherited from Solar_App_Base.

Format is "link href" => "display text".

$layout_nav_active

(array) The currently-active site navigation link.

Inherited from Solar_App_Base.

Refers to a key in $layout_nav.

$list

(array) The list of all bookmarks for the current page.

$order

(string) The requested bookmark order (subj, tags, created, etc).

$owner_handle

(string) The current owner_handle being displayed.

$page

(int) The current page number being displayed.

$pages

(int) The total number of pages in the query.

$tags

(string) The tags requested for filtering results.

$tags_in_use

(array) The list of all tags in use by the current owner_handle.

If no owner_handle, the list of all tags for all owners.

$user

(Solar_User) Local reference to the 'user' object in Solar_Registry::get().

Protected

$_Solar_App_Bookmarks

(array) User-defined configuration values.

Keys are ...

area_name
(string) The content area for the bookmarks app, default "default". Will be created automatically if it does not exist.

$_action

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

Inherited from Solar_Controller_Page.

$_action_default

(string) The default controller action.

Inherited from Solar_Controller_Page.

$_action_format

(array) These actions support these non-default formats.

Inherited from Solar_Controller_Page.

$_bookmarks

(Solar_Model_Nodes_Bookmarks) Bookmarks model.

$_charset

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

Inherited from Solar_Controller_Page.

$_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',
);
?>

$_format

(string) Use this output format for views.

Inherited from Solar_Controller_Page.

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?

Inherited from Solar_Controller_Page.

$_format_type

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

Inherited from Solar_Controller_Page.

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.

Inherited from Solar_Controller_Page.

$_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.

Inherited from Solar_Controller_Page.

$_info

(array) Request parameters collected from the URI pathinfo.

Inherited from Solar_Controller_Page.

$_layout

(string) Name of the layout to be rendered.

Inherited from Solar_Controller_Page.

Default is "navtop-localright".

$_layout_var

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

Inherited from Solar_Controller_Page.

Default is 'layout_content'.

$_name

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

Inherited from Solar_Controller_Page.

$_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'] or $_GET['process'].

Inherited from Solar_Controller_Page.

$_query

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

Inherited from Solar_Controller_Page.

$_request

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

Inherited from Solar_Controller_Page.

$_response

(Solar_Http_Response) The response object with headers and body.

Inherited from Solar_Controller_Page.

$_session

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

Inherited from Solar_Controller_Page.

$_tags

(Solar_Model_Tags) Tags model.

$_view

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

Inherited from Solar_Controller_Page.

$_view_class

(string) The class used for view objects.

Inherited from Solar_Controller_Page.

$_view_object

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

Inherited from Solar_Controller_Page.

Private

None.