Koowa_View
[ class tree: Koowa_View ] [ index: Koowa_View ] [ all elements ]
Packages:
default
Koowa_Behavior
Koowa_Command
Koowa_Config
Koowa_Controller
Koowa_Database
Koowa_Date
Koowa_Dispatcher
Koowa_Event
Koowa_Exception
Koowa_Filter
Koowa_Helper
Koowa_Http
Koowa_Inflector
Koowa_Loader
Koowa_Mixin
Koowa_Model
Koowa_Object
Koowa_Plugins
Koowa_Request
Koowa_Service
Koowa_Template
Koowa_View
Nooku_Components
Nooku_Filter
Nooku_Module
Nooku_Modules
Nooku_Plugins


Files:
abstract.php
csv.php
default.php
exception.php
file.php
html.php
json.php
template.php
vcard.php

Classes:
KViewAbstract
KViewCsv
KViewDefault
KViewException
KViewFile
KViewHtml
KViewJson
KViewTemplate
KViewVcard

Class: KViewAbstract

Source Location: /libraries/koowa/view/abstract.php

Class Overview

KObject
   |
   --KViewAbstract

Abstract View Class


Author(s):

Variables

Methods

Child classes:

KViewJson
View JSON Class
KViewTemplate
Abstract Template View Class
KViewFile
Use to force browser to download a file from the file system

Inherited Variables

Class: KObject

KObject::$_mixed_methods
KObject::$__methods
KObject::$__service_container
KObject::$__service_identifier

Inherited Methods

Class: KObject

KObject::__construct()
Constructor
KObject::get()
Get the object properties
KObject::getHandle()
Get a handle for this object
KObject::getIdentifier()
Gets the service identifier.
KObject::getMethods()
Get a list of all the available methods
KObject::getService()
Get an instance of a class based on a class identifier only creating it if it does not exist yet.
KObject::inherits()
Checks if the object or one of it's mixin's inherits from a class.
KObject::mixin()
Mixin an object
KObject::set()
Set the object properties
KObject::_initialize()
Initializes the options for the object
KObject::__call()
Search the mixin method map and call the method or trigger an error
KObject::__clone()
Preform a deep clone of the object.

Class Details

[line 18]
Abstract View Class



Tags:

author:  Johan Janssens <johan@nooku.org>
abstract:  
uses:  KMixinClass
uses:  KTemplate


[ Top ]

Class Variables

$mimetype =  ''

[line 53]

The mimetype



Tags:

access:  public

Type:   string


[ Top ]

$output =  ''

[line 46]

The output of the view



Tags:

access:  public

Type:   string


[ Top ]

$_baseurl =

[line 39]

The uniform resource locator



Tags:

access:  protected

Type:   object


[ Top ]

$_layout =

[line 32]

Layout name



Tags:

access:  protected

Type:   string


[ Top ]

$_model =

[line 25]

Model identifier (com://APP/COMPONENT.model.NAME)



Tags:

access:  protected

Type:   string|object


[ Top ]


Class Methods

constructor __construct [line 60]

KViewAbstract __construct( [ $config = null])

Constructor



Tags:

access:  public


Overridden in child classes as:

KViewJson::__construct()
Constructor
KViewTemplate::__construct()
Constructor
ComDefaultViewHtml::__construct()
Constructor
KViewFile::__construct()
Constructor

Overrides KObject::__construct() (Constructor)

Parameters:

object An   $config   optional KConfig object with configuration options

[ Top ]

method display [line 128]

string display( )

Return the views output



Tags:

return:  The output of the view
access:  public


Overridden in child classes as:

KViewJson::display()
Return the views output
KViewTemplate::display()
Return the views output
KViewHtml::display()
Return the views output
ModDefaultHtml::display()
Renders and echo's the views output
KViewFile::display()
Return the views output
KViewCsv::display()
Return the views output
KViewVcard::display()
Return the views output

[ Top ]

method getBaseUrl [line 279]

object A getBaseUrl( )

Get the view base url



Tags:

return:  KHttpUrl object
access:  public


[ Top ]

method getFormat [line 118]

string getFormat( )

Get the format



Tags:

return:  The format of the view
access:  public


[ Top ]

method getLayout [line 195]

string getLayout( )

Get the layout.



Tags:

return:  The layout name
access:  public


Overridden in child classes as:

KViewTemplate::getLayout()
Get the layout.

[ Top ]

method getModel [line 138]

KModelAbstract getModel( )

Get the model object attached to the contoller



Tags:

access:  public


[ Top ]

method getName [line 107]

string getName( )

Get the name



Tags:

return:  The name of the object
access:  public


Overridden in child classes as:

ModDefaultHtml::getName()
Get the name

[ Top ]

method getRoute [line 227]

string getRoute( [string $route = ''], [boolean $fqr = true])

Get a route based on a full or partial query string

option, view and layout can be ommitted. The following variations will all result in the same route

  • foo=bar
  • option=com_mycomp&view=myview&foo=bar
In templates, use @route()




Tags:

return:  The route
access:  public


Overridden in child classes as:

KViewHtml::getRoute()
Get a route based on a full or partial query string.

Parameters:

string   $route   The query string used to create the route
boolean   $fqr   If TRUE create a fully qualified route. Default TRUE.

[ Top ]

method setLayout [line 206]

KViewAbstract setLayout( string $layout)

Sets the layout name to use



Tags:

access:  public


Overridden in child classes as:

KViewTemplate::setLayout()
Sets the layout name

Parameters:

string   $layout   The template name.

[ Top ]

method setModel [line 161]

KViewAbstract setModel( mixed $model)

Method to set a model object attached to the view



Tags:

throws:  KViewException If the identifier is not a table identifier
access:  public


Parameters:

mixed   $model   An object that implements KObjectServiceable, KServiceIdentifier object or valid identifier string

[ Top ]

method _initialize [line 89]

void _initialize( $config)

Initializes the config for the object

Called from __construct() as a first step of object instantiation.




Tags:

access:  protected


Overridden in child classes as:

KViewJson::_initialize()
Initializes the config for the object
KViewTemplate::_initialize()
Initializes the config for the object
KViewHtml::_initialize()
Initializes the config for the object
ModDefaultHtml::_initialize()
Initializes the default configuration for the object
KViewFile::_initialize()
Initializes the options for the object
KViewCsv::_initialize()
Initializes the options for the object
KViewVcard::_initialize()
Initializes the options for the object

Overrides KObject::_initialize() (Initializes the options for the object)

Parameters:

object An   $config   optional KConfig object with configuration options

[ Top ]

method __toString [line 289]

string __toString( )

Returns the views output



Tags:

access:  public


Overridden in child classes as:

KViewTemplate::__toString()
Execute and return the views output

[ Top ]

Documentation generated on Sat, 18 May 2013 03:02:08 +0200 by phpDocumentor 1.4.3