Référence de la classe JTable

Graphe d'héritage de JTable:

Graphe de collaboration de JTable:

Liste de tous les membres

Fonctions membres publiques

• __construct ($table, $key, &$db)
• & getInstance ($type, $prefix= 'JTable', $config=array())
• & getDBO ()
• setDBO (&$db)
• getTableName ()
• getKeyName ()
• reset ()
• bind ($from, $ignore=array())
• load ($oid=null)
• check ()
• store ($updateNulls=false)
• move ($dirn, $where='')
• getNextOrder ($where='')
• reorder ($where='')
• canDelete ($oid=null, $joins=null)
• delete ($oid=null)
• checkout ($who, $oid=null)
• checkin ($oid=null)
• hit ($oid=null, $log=false)
• save ($source, $order_filter='', $ignore='')
• publish ($cid=null, $publish=1, $user_id=0)
• toXML ($mapKeysToText=false)
• addIncludePath ($path=null)

Fonctions membres publiques statiques

• isCheckedOut ($with=0, $against=null)

Attributs publics

• $_tbl = ''
• $_tbl_key = ''
• $_db = null

---

Documentation des constructeurs et destructeur

JTable::__construct	(	$	table,
		$	key,
		&$	db
	)

Object constructor to set table and key field

Can be overloaded/supplemented by the child class

protected

Paramètres:

string	$table	name of the table in the db schema relating to child class
string	$key	name of the primary key field in the table
object	$db	JDatabase object

Réimplémentée dans mosDBTable.

Références $db.

---

Documentation des fonctions membres

JTable::addIncludePath

(

$

path = null

)

Add a directory where JTable should search for table types. You may either pass a string or an array of directories.

public

Paramètres:

string

A path to search.

Renvoie:

array An array with directory elements

Depuis:

1.5

Références $path.

Référencé par JModel::addTablePath(), getInstance(), et ContactController::vcard().

Voici le graphe d'appel pour cette fonction :

JTable::bind	(	$	from,
		$	ignore = array()
	)

Binds a named array/hash to this object

Can be overloaded/supplemented by the child class

public

Paramètres:

$from	mixed An associative array or object
$ignore	mixed An array or space separated list of fields not to bind

Renvoie:

boolean

Réimplémentée dans TablePoll, TableWeblink, JTableComponent, JTableMenu, JTableModule, JTablePlugin, JTableSection, et JTableUser.

Références $k.

JTable::canDelete	(	$	oid = null,
		$	joins = null
	)

Generic check for whether dependancies exist for this object in the db schema

can be overloaded/supplemented by the child class

public

Paramètres:

string	$msg	Error message returned
	int	Optional key index
	array	Optional array to compiles standard joins: format [label=>'Label',name=>'table name',idfield=>'field',joinfield=>'field']

Renvoie:

true|false

Références $i, $k, $query, et JText::_().

Voici le graphe d'appel pour cette fonction :

JTable::check

(

)

Generic check method

Can be overloaded/supplemented by the child class

public

Renvoie:

boolean True if the object is ok

Réimplémentée dans TableBanner, TableBannerClient, TableContact, TableMessage, TableNewsFeed, TablePoll, TableWeblink, JTableCategory, JTableComponent, JTableContent, JTableMenu, JTableMenuTypes, JTableModule, JTableSection, et JTableUser.

JTable::checkin

(

$

oid = null

)

Checks in a row

public

Paramètres:

mixed

The primary key value for the row

Renvoie:

boolean True if successful, or if checkout is not supported

Références $k, et $query.

JTable::checkout	(	$	who,
		$	oid = null
	)

Checks out a row

public

Paramètres:

integer	The id of the user
mixed	The primary key value for the row

Renvoie:

boolean True if successful, or if checkout is not supported

Références $date, $k, $query, et JFactory::getDate().

Voici le graphe d'appel pour cette fonction :

JTable::delete

(

$

oid = null

)

Default delete method

can be overloaded/supplemented by the child class

public

Renvoie:

true if successful otherwise returns and error message

Réimplémentée dans TablePoll, JTableSession, et JTableUser.

Références $k, et $query.

& JTable::getDBO

(

)

Get the internal database object

Renvoie:

object A JDatabase based object

& JTable::getInstance	(	$	type,
		$	prefix = 'JTable',
		$	config = array()
	)

Returns a reference to the a Table object, always creating it

Paramètres:

type	$type	The table type to instantiate
string	$prefix	A prefix for the table class name. Optional.
array	$options	Configuration array for model. Optional.

Renvoie:

database A database object

Depuis:

1.5

Références $config, $db, $path, $type, addIncludePath(), JPath::find(), JFactory::getDBO(), jimport(), et JError::raiseWarning().

Référencé par JInstallerComponent::_buildAdminMenus(), JApplication::_createSession(), JModel::_createTable(), MenusModelItem::_getTable(), PluginsController::access(), ContentController::accessMenu(), accessMenu(), ContentController::cancel(), PollController::cancel(), PluginsController::cancel(), BannerControllerClient::cancel(), BannerControllerBanner::cancel(), cancelCategory(), cancelContact(), ContentController::cancelContent(), cancelNewsFeed(), cancelSection(), changeAccess(), changeContact(), changeFrontPage(), changePublishNewsFeeds(), ContentModelArticle::checkin(), ContentModelArticle::checkout(), MenusModelList::copy(), BannerControllerBanner::copy(), copyCategorySave(), ContentController::copyItemSave(), copySectionSave(), MenusModelMenutype::delete(), plgXMLRPCBloggerServices::deletePost(), deleteTrash(), JSessionStorageDatabase::destroy(), InstallerModelComponents::disable(), ContactViewCategory::display(), PollViewPoll::display(), PluginsViewPlugin::display(), MenusController::doCopyMenu(), ConfigControllerComponent::edit(), BannerControllerClient::edit(), BannerControllerBanner::edit(), editCategory(), editContact(), ContentController::editContent(), MenusViewMenus::editForm(), editNewsFeed(), plgXMLRPCBloggerServices::editPost(), editSection(), InstallerModelComponents::enable(), JElementArticle::fetchElement(), JSessionStorageDatabase::gc(), ContentModelArticle::getArticle(), MenusModelList::getComponent(), MenusModelItem::getComponent(), JApplication::getItemid(), ConfigModelComponent::getParams(), JUser::getTable(), MenusModelMenutype::getTable(), MenusModelList::getTable(), ContentModelArticle::hit(), JInstallerPlugin::install(), JInstallerModule::install(), isCheckedOut(), moveCategorySave(), ContentController::moveSectionSave(), plgXMLRPCBloggerServices::newPost(), plgUserJoomla::onLoginUser(), plgUserJoomla::onLogoutUser(), PluginsController::order(), orderCategory(), orderContacts(), ContentController::orderContent(), orderFrontPage(), orderNewsFeed(), orderSection(), PollController::publish(), PluginsController::publish(), publishCategories(), publishSections(), JSessionStorageDatabase::read(), PollController::remove(), BannerControllerClient::remove(), removeFrontPage(), ContentHelper::resetHits(), PollController::save(), PluginsController::save(), ConfigControllerComponent::save(), BannerControllerClient::save(), BannerControllerBanner::save(), ConfigControllerApplication::save(), saveCategory(), saveContact(), MenusController::saveMenu(), saveNewsFeed(), PluginsController::saveorder(), ContentController::saveOrder(), BannerControllerBanner::saveOrder(), saveOrder(), saveSection(), MenusController::setdefault(), ConfigApplicationView::showConfig(), ContentModelArticle::store(), JInstallerPlugin::uninstall(), JInstallerModule::uninstall(), JInstallerComponent::uninstall(), ContactController::vcard(), PollController::vote(), et JSessionStorageDatabase::write().

Voici le graphe d'appel pour cette fonction :

JTable::getKeyName

(

)

Gets the internal primary key name

Renvoie:

string

Depuis:

1.5

JTable::getNextOrder

(

$

where = ''

)

Returns the ordering value to place a new item last in its group

public

Paramètres:

string

query WHERE clause for selecting MAX(ordering).

Références $query, et $where.

JTable::getTableName

(

)

Gets the internal table name for the object

Renvoie:

string

Depuis:

1.5

JTable::hit	(	$	oid = null,
		$	log = false
	)

Description

public

Paramètres:

$oid
$log

Références $k, et $query.

JTable::isCheckedOut	(	$	with = 0,
		$	against = null
	)		[static]

Check if an item is checked out

This function can be used as a static function too, when you do so you need to also provide the a value for the $against parameter.

public

Paramètres:

integer	$with	The userid to preform the match with, if an item is checked out by this user the function will return false
integer	$against	The userid to perform the match against when the function is used as a static function.

Renvoie:

boolean

Références $session, et getInstance().

Référencé par BannersViewBanner::banners(), BannersViewClients::clients(), editCategory(), ContentController::editContent(), sections_html::show(), categories_html::show(), HTML_contact::showContacts(), ContentView::showContent(), FrontpageView::showList(), HTML_newsfeeds::showNewsFeeds(), TemplatesView::showTemplates(), et HTML_modules::view().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

JTable::load

(

$

oid = null

)

Loads a row from the database and binds the fields to the object properties

public

Paramètres:

mixed

Optional primary key. If not specifed, the value of current key is used

Renvoie:

boolean True if successful

Références $db, $k, et $query.

JTable::move	(	$	dirn,
		$	where = ''
	)

Description

public

Paramètres:

$dirn
$where

Références $k, $query, $where, et JError::raiseError().

Voici le graphe d'appel pour cette fonction :

JTable::publish	(	$	cid = null,
		$	publish = 1,
		$	user_id = 0
	)

Generic Publish/Unpublish function

public

Paramètres:

array	An array of id numbers
integer	0 if unpublishing, 1 if publishing
integer	The id of the user performnig the operation

Depuis:

1.0.4

Références $cid, $k, $query, et JArrayHelper::toInteger().

Voici le graphe d'appel pour cette fonction :

JTable::reorder

(

$

where = ''

)

Compacts the ordering sequence of the selected records

public

Paramètres:

string

Additional where query to limit ordering to a particular subset of records

Références $i, $k, $n, $query, et $where.

JTable::reset

(

)

Resets the default properties

Renvoie:

void

Références $k, et $name.

JTable::save	(	$	source,
		$	order_filter = '',
		$	ignore = ''
	)

Generic save function

public

Paramètres:

array	Source array for binding to class vars
string	Filter for the order updating
mixed	An array or space separated list of fields not to bind

Renvoie:

TRUE if completely successful, FALSE if partially or not succesful.

JTable::setDBO

(

&$

db

)

Set the internal database object

Paramètres:

object

$db

A JDatabase based object

Renvoie:

void

Références $db.

JTable::store

(

$

updateNulls = false

)

Inserts a new row if id is zero or updates an existing row in the database table

Can be overloaded/supplemented by the child class

public

Paramètres:

boolean

If false, null object variables are not updated

Renvoie:

null|string null if successful otherwise returns and error message

Réimplémentée dans JTableUser.

Références $k.

JTable::toXML

(

$

mapKeysToText = false

)

Export item list to xml

public

Paramètres:

boolean

Map foreign keys to text values

Réimplémentée dans JTableContent.

Références $k.

---

Documentation des données membres

JTable::$_db = null

JTable::$_tbl = ''

JTable::$_tbl_key = ''

---

La documentation de cette classe a été générée à partir du fichier suivant :

• table.php