Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe Module
+ Graphe d'héritage de Module:

Fonctions membres publiques

 __construct (DatabaseDriver $db)
 
 check ()
 
 bind ($array, $ignore='')
 
 store ($updateNulls=true)
 
- Fonctions membres publiques hérités de Table
 __construct ($table, $key, DatabaseDriver $db, DispatcherInterface $dispatcher=null)
 
 getFields ($reload=false)
 
 appendPrimaryKeys ($query, $pk=null)
 
 getTableName ()
 
 getKeyName ($multiple=false)
 
 getId ()
 
 getDbo ()
 
 setDbo (DatabaseDriver $db)
 
 setRules ($input)
 
 getRules ()
 
 reset ()
 
 bind ($src, $ignore=array())
 
 load ($keys=null, $reset=true)
 
 check ()
 
 save ($src, $orderingFilter='', $ignore='')
 
 checkOut ($userId, $pk=null)
 
 checkIn ($pk=null)
 
 hasPrimaryKey ()
 
 hit ($pk=null)
 
 isCheckedOut ($with=0, $against=null)
 
 getNextOrder ($where='')
 
 getPrimaryKey (array $keys=array())
 
 reorder ($where='')
 
 move ($delta, $where='')
 
 publish ($pks=null, $state=1, $userId=0)
 
 getColumnAlias ($column)
 
 setColumnAlias ($column, $columnAlias)
 
 hasField ($key)
 
- Fonctions membres publiques hérités de CMSObject
 __construct ($properties=null)
 
 __toString ()
 
 def ($property, $default=null)
 
 get ($property, $default=null)
 
 getProperties ($public=true)
 
 getError ($i=null, $toString=true)
 
 getErrors ()
 
 set ($property, $value=null)
 
 setProperties ($properties)
 
 setError ($error)
 
- Fonctions membres publiques hérités de TableInterface
 delete ($pk=null)
 
 getKeyName ()
 
- Fonctions membres publiques hérités de DispatcherAwareInterface
 setDispatcher (DispatcherInterface $dispatcher)
 

Fonctions membres protégées

 _getAssetName ()
 
 _getAssetTitle ()
 
 _getAssetParentId (Table $table=null, $id=null)
 
- Fonctions membres protégées hérités de Table
 _getAssetName ()
 
 _getAssetTitle ()
 
 _lock ()
 
 _unlock ()
 

Attributs protégés

 $_supportNullValue = true
 
- Attributs protégés hérités de Table
 $_tbl = ''
 
 $_tbl_key = ''
 
 $_tbl_keys = array()
 
 $_db
 
 $_trackAssets = false
 
 $_rules
 
 $_locked = false
 
 $_autoincrement = true
 
 $_columnAlias = array()
 
 $_jsonEncode = array()
 
 $_supportNullValue = false
 
- Attributs protégés hérités de CMSObject
 $_errors = array()
 

Membres hérités additionnels

- Fonctions membres publiques statiques hérités de Table
static getInstance ($type, $prefix='JTable', $config=array())
 
static addIncludePath ($path=null)
 
- Champs de données hérités de Table
 $typeAlias = null
 

Description détaillée

Module table

Depuis
1.5

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( DatabaseDriver  $db)

Constructor.

Paramètres
DatabaseDriver$dbDatabase driver object.
Depuis
1.5

Références $db, Symfony\Contracts\Service\__construct(), et Factory\getApplication().

Documentation des fonctions membres

◆ _getAssetName()

_getAssetName ( )
protected

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.

Renvoie
string
Depuis
3.2

◆ _getAssetParentId()

_getAssetParentId ( Table  $table = null,
  $id = null 
)
protected

Method to get the parent asset id for the record

Paramètres
Table$tableA Table object (optional) for the asset parent
integer$idThe id (optional) of the content.
Renvoie
integer
Depuis
3.2

Références $assetId, $id, $query, $result, et null.

◆ _getAssetTitle()

_getAssetTitle ( )
protected

Method to return the title to use for the asset table.

Renvoie
string
Depuis
3.2

Références $title.

◆ bind()

bind (   $array,
  $ignore = '' 
)

Overloaded bind function.

Paramètres
array$arrayNamed array.
mixed$ignoreAn optional array or space separated list of properties to ignore while binding.
Renvoie
mixed Null if operation was satisfactory, otherwise returns an error
Voir également
Table::bind()
Depuis
1.5

Implémente TableInterface.

◆ check()

check ( )

Overloaded check function.

Renvoie
boolean True if the instance is sane and able to be stored in the database.
Voir également
Table::check()
Depuis
1.5

Implémente TableInterface.

Références $temp, Text\_(), content, et null.

◆ store()

store (   $updateNulls = true)

Stores a module.

Paramètres
boolean$updateNullsTrue to update fields even if they are null.
Renvoie
boolean True on success, false on failure.
Depuis
3.7.0

Implémente TableInterface.

Documentation des champs

◆ $_supportNullValue

$_supportNullValue = true
protected

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