Class WeblinksModelWeblink

Description

Weblinks model.

  • since: 1.5

Located in /administrator/components/com_weblinks/models/weblink.php (line 19)

JObject
   |
   --JModelLegacy
      |
      --JModelForm
         |
         --JModelAdmin
            |
            --WeblinksModelWeblink
Variable Summary
 string $text_prefix
 string $typeAlias
Method Summary
 boolean canDelete (object $record)
 boolean canEditState (object $record)
 array generateNewTitle (integer $category_id, string $alias, string $name)
 mixed getForm ([array $data = array()], [boolean $loadData = true])
 mixed getItem ([integer $pk = null])
 array getReorderConditions (JTable $table)
 JTable getTable ([string $type = 'Weblink'], [string $prefix = 'WeblinksTable'], [array $config = array()])
 array loadFormData ()
 void prepareTable (JTable $table)
 boolean save (array $data)
Variables
string $text_prefix = 'COM_WEBLINKS' (line 36)

The prefix to use with controller messages.

  • since: 1.6
  • access: protected

Redefinition of:
JModelAdmin::$text_prefix
The prefix to use with controller messages.
string $typeAlias = 'com_weblinks.weblink' (line 28)

The type alias for this content type.

  • since: 3.2
  • access: public

Inherited Variables

Inherited from JModelAdmin

JModelAdmin::$event_after_delete
JModelAdmin::$event_after_save
JModelAdmin::$event_before_delete
JModelAdmin::$event_before_save
JModelAdmin::$event_change_state

Inherited from JModelForm

JModelForm::$_forms

Inherited from JModelLegacy

JModelLegacy::$event_clean_cache
JModelLegacy::$name
JModelLegacy::$option
JModelLegacy::$state
JModelLegacy::$_db
JModelLegacy::$__state_set

Inherited from JObject

JObject::$_errors
Methods
canDelete (line 47)

Method to test whether a record can be deleted.

  • return: True if allowed to delete the record. Defaults to the permission for the component.
  • since: 1.6
  • access: protected
boolean canDelete (object $record)
  • object $record: A record object.
canEditState (line 77)

Method to test whether a record can be deleted.

  • return: True if allowed to change the state of the record. Defaults to the permission for the component.
  • since: 1.6
  • access: protected
boolean canEditState (object $record)
  • object $record: A record object.
generateNewTitle (line 322)

Method to change the title & alias.

  • return: Contains the modified title and alias.
  • since: 3.1
  • access: protected
array generateNewTitle (integer $category_id, string $alias, string $name)
  • integer $category_id: The id of the parent.
  • string $alias: The alias.
  • string $name: The title.
getForm (line 117)

Abstract method for getting the form from the model.

  • return: A JForm object on success, false on failure
  • since: 1.6
  • access: public
mixed getForm ([array $data = array()], [boolean $loadData = true])
  • array $data: Data for the form.
  • boolean $loadData: True if the form is to load its own data (default case), false if not.

Redefinition of:
JModelForm::getForm()
Abstract method for getting the form from the model.
getItem (line 197)

Method to get a single record.

  • return: Object on success, false on failure.
  • since: 1.6
  • access: public
mixed getItem ([integer $pk = null])
  • integer $pk: The id of the primary key.
getReorderConditions (line 278)

A protected method to get a set of ordering conditions.

  • return: An array of conditions to add to ordering queries.
  • since: 1.6
  • access: protected
array getReorderConditions (JTable $table)
  • JTable $table: A JTable object.
getTable (line 102)

Method to get a table object, load it if necessary.

  • return: A JTable object
  • since: 1.6
  • access: public
JTable getTable ([string $type = 'Weblink'], [string $prefix = 'WeblinksTable'], [array $config = array()])
  • string $type: The table name. Optional.
  • string $prefix: The class prefix. Optional.
  • array $config: Configuration array for model. Optional.

Redefinition of:
JModelLegacy::getTable()
Method to get a table object, load it if necessary.
loadFormData (line 166)

Method to get the data that should be injected in the form.

  • return: The default data is an empty array.
  • since: 1.6
  • access: protected
array loadFormData ()

Redefinition of:
JModelForm::loadFormData()
Method to get the data that should be injected in the form.
prepareTable (line 231)

Prepare and sanitise the table data prior to saving.

  • since: 1.6
  • access: protected
void prepareTable (JTable $table)
  • JTable $table: A reference to a JTable object.
save (line 295)

Method to save the form data.

  • return: True on success.
  • since: 3.1
  • access: public
boolean save (array $data)
  • array $data: The form data.

Inherited Methods

Inherited From JModelAdmin

 JModelAdmin::__construct()
 JModelAdmin::batch()
 JModelAdmin::batchAccess()
 JModelAdmin::batchCopy()

Inherited From JModelForm

 JModelForm::checkin()
 JModelForm::checkout()
 JModelForm::getForm()
 JModelForm::loadForm()
 JModelForm::loadFormData()
 JModelForm::preprocessData()
 JModelForm::preprocessForm()
 JModelForm::validate()

Inherited From JModelLegacy

 JModelLegacy::__construct()
 JModelLegacy::addIncludePath()
 JModelLegacy::addTablePath()
 JModelLegacy::cleanCache()
 JModelLegacy::getDbo()
 JModelLegacy::getInstance()
 JModelLegacy::getName()
 JModelLegacy::getState()
 JModelLegacy::getTable()
 JModelLegacy::loadHistory()
 JModelLegacy::populateState()
 JModelLegacy::setDbo()
 JModelLegacy::setState()
 JModelLegacy::_createFileName()
 JModelLegacy::_createTable()
 JModelLegacy::_getList()
 JModelLegacy::_getListCount()

Inherited From JObject

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

Documentation generated on Tue, 19 Nov 2013 15:18:29 +0100 by phpDocumentor 1.4.3