PubdbModelLiterature - JoomlaPubDB/PubDB GitHub Wiki
Summary:
Pubdb model.
- No constants found
- public getTable()
- public getForm()
- public getItem()
- public duplicate()
- protected loadFormData()
- protected prepareTable()
- File: administrator/models/literature.php
- Package: Com_Pubdb
- Class Hierarchy:
- \Joomla\CMS\MVC\Model\AdminModel
- \PubdbModelLiterature
| Tag | Version | Description |
|---|---|---|
| since | 1.6 |
Type: string Alias to manage history control Details:
| Tag | Version | Description |
|---|---|---|
| since | 3.2 |
Type: string The prefix to use with controller messages. Details:
| Tag | Version | Description |
|---|---|---|
| since | 1.6 |
Type: null Item data Details:
| Tag | Version | Description |
|---|---|---|
| since | 1.6 |
public getTable(string $type = 'Literature', string $prefix = 'PubdbTable', array $config = array()) : \JTable
Summary
Returns a reference to the a Table object, always creating it.
Details:
- Inherited From: \PubdbModelLiterature
| Type | Name | Description |
|---|---|---|
string |
$type | The table type to instantiate |
string |
$prefix | A prefix for the table class name. Optional. |
array |
$config | Configuration array for model. Optional. |
Returns: \JTable - A database object
| Tag | Version | Description |
|---|---|---|
| since | 1.6 |
public getForm(array $data = array(), boolean $loadData = true) : \JForm
Summary
Method to get the record form.
Details:
- Inherited From: \PubdbModelLiterature
| Type | Name | Description |
|---|---|---|
array |
$data | An optional array of data for the form to interogate. |
boolean |
$loadData | True if the form is to load its own data (default case), false if not. |
| Type | Description |
|---|---|
Returns: \JForm - A JForm object on success, false on failure
| Tag | Version | Description |
|---|---|---|
| since | 1.6 |
public getItem(integer $pk = null) : mixed
Summary
Method to get a single record.
Details:
- Inherited From: \PubdbModelLiterature
| Type | Name | Description |
|---|---|---|
integer |
$pk | The id of the primary key. |
Returns: mixed - Object on success, false on failure.
| Tag | Version | Description |
|---|---|---|
| since | 1.6 |
public duplicate( $pks) : boolean
Summary
Method to duplicate an Literature
Details:
- Inherited From: \PubdbModelLiterature
| Type | Name | Description |
|---|---|---|
|
$pks |
| Type | Description |
|---|---|
| \Exception |
Returns: boolean - True if successful.
protected loadFormData() : mixed
Summary
Method to get the data that should be injected in the form.
Details:
- Inherited From: \PubdbModelLiterature
| Type | Description |
|---|---|
Returns: mixed - The data for the form.
| Tag | Version | Description |
|---|---|---|
| since | 1.6 |
protected prepareTable(\JTable $table) : void
Summary
Prepare and sanitise the table prior to saving.
Details:
- Inherited From: \PubdbModelLiterature
| Type | Name | Description |
|---|---|---|
\JTable |
$table | Table Object |
Returns: void
| Tag | Version | Description |
|---|---|---|
| since | 1.6 |
This document was automatically generated from source code comments on 2020-07-13 using phpDocumentor and fr3nch13/phpdoc-markdown