PubdbModelCitationstyleForm - JoomlaPubDB/PubDB GitHub Wiki
Summary:
Pubdb model.
- No constants found
- public getItem()
- public getTable()
- public getItemIdByAlias()
- public checkin()
- public checkout()
- public getForm()
- public save()
- public delete()
- public getCanSave()
- protected populateState()
- protected loadFormData()
- File: site/models/citationstyleform.php
- Package: Com_Pubdb
- Class Hierarchy:
- \Joomla\CMS\MVC\Model\FormModel
- \PubdbModelCitationstyleForm
| Tag | Version | Description |
|---|---|---|
| since | 1.6 |
Type:
Details:
public getItem(integer $id = null) : Object|boolean
Summary
Method to get an ojbect.
Details:
- Inherited From: \PubdbModelCitationstyleForm
| Type | Name | Description |
|---|---|---|
integer |
$id | The id of the object to get. |
| Type | Description |
|---|---|
| \Exception |
Returns: Object|boolean - Object on success, false on failure.
public getTable(string $type = 'Citationstyle', string $prefix = 'PubdbTable', array $config = array()) : \JTable|boolean
Summary
Method to get the table
Details:
- Inherited From: \PubdbModelCitationstyleForm
| Type | Name | Description |
|---|---|---|
string |
$type | Name of the JTable class |
string |
$prefix | Optional prefix for the table class name |
array |
$config | Optional configuration array for JTable object |
Returns: \JTable|boolean - JTable if found, boolean false on failure
public getItemIdByAlias(string $alias) : integer
Summary
Get an item by alias
Details:
- Inherited From: \PubdbModelCitationstyleForm
| Type | Name | Description |
|---|---|---|
string |
$alias | Alias string |
Returns: integer - Element id
public checkin(integer $id = null) : boolean
Summary
Method to check in an item.
Details:
- Inherited From: \PubdbModelCitationstyleForm
| Type | Name | Description |
|---|---|---|
integer |
$id | The id of the row to check out. |
Returns: boolean - True on success, false on failure.
| Tag | Version | Description |
|---|---|---|
| since | 1.6 |
public checkout(integer $id = null) : boolean
Summary
Method to check out an item for editing.
Details:
- Inherited From: \PubdbModelCitationstyleForm
| Type | Name | Description |
|---|---|---|
integer |
$id | The id of the row to check out. |
Returns: boolean - True on success, false on failure.
| Tag | Version | Description |
|---|---|---|
| since | 1.6 |
public getForm(array $data = array(), boolean $loadData = true) : \JForm
Summary
Method to get the profile form.
Description
The base form is loaded from XML
Details:
- Inherited From: \PubdbModelCitationstyleForm
| 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. |
Returns: \JForm - A JForm object on success, false on failure
| Tag | Version | Description |
|---|---|---|
| since | 1.6 |
public save(array $data) : boolean
Summary
Method to save the form data.
Details:
- Inherited From: \PubdbModelCitationstyleForm
| Type | Name | Description |
|---|---|---|
array |
$data | The form data |
| Type | Description |
|---|---|
| \Exception |
Returns: boolean
| Tag | Version | Description |
|---|---|---|
| since | 1.6 |
public delete(integer $pk) : integer
Summary
Method to delete data
Details:
- Inherited From: \PubdbModelCitationstyleForm
| Type | Name | Description |
|---|---|---|
integer |
$pk | Item primary key |
| Type | Description |
|---|---|
| \Exception |
Returns: integer - The id of the deleted item
| Tag | Version | Description |
|---|---|---|
| since | 1.6 |
public getCanSave() : boolean
Summary
Check if data can be saved
Details:
- Inherited From: \PubdbModelCitationstyleForm
Returns: boolean
protected populateState() : void
Summary
Method to auto-populate the model state.
Description
Note. Calling getState in this method will result in recursion.
Details:
- Inherited From: \PubdbModelCitationstyleForm
| Type | Description |
|---|---|
| \Exception |
Returns: void
| Tag | Version | Description |
|---|---|---|
| since | 1.6 |
protected loadFormData() : mixed
Summary
Method to get the data that should be injected in the form.
Details:
- Inherited From: \PubdbModelCitationstyleForm
Returns: mixed - The data for the form.
| 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