PubdbTableperiodical - JoomlaPubDB/PubDB GitHub Wiki
Summary:
periodical Table class
- No constants found
- public __construct()
- public bind()
- public check()
- public publish()
- public delete()
- protected _getAssetName()
- protected _getAssetParentId()
- private isUnique()
- private JAccessRulestoArray()
- File: administrator/tables/periodical.php
- Package: Com_Pubdb
- Class Hierarchy:
- \Joomla\CMS\Table\Table
- \PubdbTableperiodical
| Tag | Version | Description |
|---|---|---|
| since | 1.6 |
public __construct( $db)
Summary
Constructor
Details:
- Inherited From: \PubdbTableperiodical
| Type | Name | Description |
|---|---|---|
|
$db |
public bind(array $array, mixed $ignore = '') : null|string
Summary
Overloaded bind function to pre-process the params.
Details:
- Inherited From: \PubdbTableperiodical
- See Also:
- \JTable:bind
| Type | Name | Description |
|---|---|---|
array |
$array | Named array |
mixed |
$ignore | Optional array or list of parameters to ignore |
| Type | Description |
|---|---|
| \Exception |
Returns: null|string - null is operation was satisfactory, otherwise returns an error
| Tag | Version | Description |
|---|---|---|
| since | 1.5 |
public check() : boolean
Summary
Overloaded check function
Details:
- Inherited From: \PubdbTableperiodical
Returns: boolean
public publish(mixed $pks = null, integer $state = 1, integer $userId) : boolean
Summary
Method to set the publishing state for a row or list of rows in the database table. The method respects checked out rows by other users and will attempt to checkin rows that it can after adjustments are made.
Details:
- Inherited From: \PubdbTableperiodical
| Type | Name | Description |
|---|---|---|
mixed |
$pks | An optional array of primary key values to update. If not |
set the instance property value is used. |
| integer | $state | The publishing state. eg. [0 = unpublished, 1 = published] |
| integer | $userId | The user id of the user performing the operation. |
| Type | Description |
|---|---|
| \Exception |
Returns: boolean - True on success.
| Tag | Version | Description |
|---|---|---|
| since | 1.0.4 |
public delete(mixed $pk = null) : boolean
Summary
Delete a record by id
Details:
- Inherited From: \PubdbTableperiodical
| Type | Name | Description |
|---|---|---|
mixed |
$pk | Primary key value to delete. Optional |
Returns: boolean
protected _getAssetName() : string
Summary
Define a namespaced asset name for inclusion in the #__assets table
Details:
- Inherited From: \PubdbTableperiodical
- See Also:
- \Joomla\CMS\Table\Table::_getAssetName
Returns: string - The asset name
protected _getAssetParentId(\JTable $table = null, integer $id = null) : mixed
Summary
Returns the parent asset's id. If you have a tree structure, retrieve the parent's id using the external key field
Details:
- Inherited From: \PubdbTableperiodical
- See Also:
- \Joomla\CMS\Table\Table::_getAssetParentId
| Type | Name | Description |
|---|---|---|
\JTable |
$table | Table name |
integer |
$id | Id |
Returns: mixed - The id on success, false on failure.
private isUnique(string $field) : boolean
Summary
Check if a field is unique
Details:
- Inherited From: \PubdbTableperiodical
| Type | Name | Description |
|---|---|---|
string |
$field | Name of the field |
Returns: boolean - True if unique
private JAccessRulestoArray(array $jaccessrules) : array
Summary
This function convert an array of JAccessRule objects into an rules array.
Details:
- Inherited From: \PubdbTableperiodical
| Type | Name | Description |
|---|---|---|
array |
$jaccessrules | An array of JAccessRule objects. |
Returns: array
This document was automatically generated from source code comments on 2020-07-13 using phpDocumentor and fr3nch13/phpdoc-markdown