Class TemplatesControllerSource

Description

Template style controller class.

  • since: 1.6

Located in /administrator/components/com_templates/controllers/source.php (line 19)

JObject
   |
   --JController
      |
      --TemplatesControllerSource
Method Summary
TemplatesControllerSource __construct ([array $config = array()])
boolean allowEdit (array 0, string 1)
boolean allowSave (array 0, string 1)
void cancel ()
JController display ([boolean $cachable = false], [array $urlparams = false])
void edit ()
object The getModel ([string $name = 'Source'], [string $prefix = 'TemplatesModel'], [array $config = array()])
void save ()
Variables
Methods
Constructor __construct (line 27)

Constructor.

TemplatesControllerSource __construct ([array $config = array()])
  • array $config: An optional associative array of configuration settings.

Redefinition of:
JController::__construct()
Constructor.
allowEdit (line 45)

Method to check if you can add a new record.

Extended classes can override this if necessary.

  • access: protected
boolean allowEdit (array 0, string 1)
  • array 0: An array of input data.
  • string 1: The name of the key for the primary key.
allowSave (line 60)

Method to check if you can save a new or existing record.

Extended classes can override this if necessary.

  • access: protected
boolean allowSave (array 0, string 1)
  • array 0: An array of input data.
  • string 1: The name of the key for the primary key.
cancel (line 128)

Method to cancel an edit

  • access: public
void cancel ()
display (line 89)

This controller does not have a display method. Redirect back to the list view of the component.

  • return: This object to support chaining.
  • since: 1.5
  • access: public
JController display ([boolean $cachable = false], [array $urlparams = false])
  • boolean $cachable: If true, the view output will be cached
  • array $urlparams: An array of safe url parameters and their variable types, for valid values see JFilterInput::clean().

Redefinition of:
JController::display()
Typical view method for MVC based architecture
edit (line 99)

Method to edit an existing record.

  • access: public
void edit ()
getModel (line 74)

Method to get a model object, loading it if required.

  • return: model.
  • access: public
object The getModel ([string $name = 'Source'], [string $prefix = 'TemplatesModel'], [array $config = array()])
  • string $name: The model name. Optional.
  • string $prefix: The class prefix. Optional.
  • array $config: Configuration array for model. Optional (note, the empty array is atypical compared to other models).

Redefinition of:
JController::getModel()
Method to get a model object, loading it if required.
save (line 148)

Saves a template source file.

  • access: public
void save ()

Inherited Methods

Inherited From JController

JController::__construct()
JController::addModelPath()
JController::addPath()
JController::addViewPath()
JController::authorise()
JController::authorize()
JController::checkEditId()
JController::createFileName()
JController::createModel()
JController::createView()
JController::display()
JController::execute()
JController::getInstance()
JController::getModel()
JController::getName()
JController::getTask()
JController::getTasks()
JController::getView()
JController::holdEditId()
JController::redirect()
JController::registerDefaultTask()
JController::registerTask()
JController::releaseEditId()
JController::setAccessControl()
JController::setMessage()
JController::setPath()
JController::setRedirect()
JController::unregisterTask()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
JObject::__toString()

Documentation generated on Mon, 25 Jun 2012 13:59:40 -0500 by phpDocumentor 1.4.4