PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of FieldTable.php

(no description)

Copyright:	(C) 2016 Open Source Matters, Inc.
License:	GNU General Public License version 2 or later; see LICENSE.txt
File Size:	317 lines (10 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

FieldTable:: (8 methods):
  __construct()
  bind()
  check()
  store()
  _getAssetName()
  _getAssetTitle()
  _getAssetParentId()
  getAssetId()

Class: FieldTable - X-Ref

Fields Table

__construct($db = null) X-Ref

Class constructor.

param: DatabaseDriver $db DatabaseDriver object.

bind($src, $ignore = '') X-Ref

Method to bind an associative array or object to the JTable instance.This
method only binds properties that are publicly accessible and optionally
takes an array of properties to ignore when binding.

param: mixed  $src     An associative array or object to bind to the JTable instance.
param: mixed  $ignore  An optional array or space separated list of properties to ignore while binding.
return: boolean  True on success.

check() X-Ref

Method to perform sanity checks on the JTable instance properties to ensure
they are safe to store in the database. Child classes should override this
method to make sure the data they are storing in the database is safe and
as expected before storage.

return: boolean True if the instance is sane and able to be stored in the database.

store($updateNulls = true) X-Ref

Overloaded store function

param: boolean $updateNulls True to update fields even if they are null.
return: mixed False on failure, positive integer on success.

_getAssetName() X-Ref

Method to compute the default name of the asset.
The default name is in the form table_name.id
where id is the value of the primary key of the table.

return: string

_getAssetTitle() X-Ref

Method to return the title to use for the asset table.  In
tracking the assets a title is kept for each asset so that there is some
context available in a unified access manager.  Usually this would just
return $this->title or $this->name or whatever is being used for the
primary name of the row. If this method is not overridden, the asset name is used.

return: string  The string to use as the title in the asset table.

_getAssetParentId(Table $table = null, $id = null) X-Ref

Method to get the parent asset under which to register this one.
By default, all assets are registered to the ROOT node with ID,
which will default to 1 if none exists.
The extended class can define a table and id to lookup.  If the
asset does not exist it will be created.

param: Table    $table  A Table object for the asset parent.
param: integer  $id     Id to look up
return: integer

getAssetId($name) X-Ref

Returns an asset id for the given name or false.

param: string $name The asset name
return: number|boolean

PHP Cross Reference of Joomla 4.2.2 documentation

/administrator/components/com_fields/src/Table/ -> FieldTable.php (summary)

Defines 1 class