Actions

API17

Difference between revisions of "JDatabase::getTableFields"

From Joomla! Documentation

(Layout updates)
(Updated to r1448:247ba8d88526)
Line 2: Line 2:
 
=={{JVer|11.1}} JDatabase::getTableFields==
 
=={{JVer|11.1}} JDatabase::getTableFields==
 
===Description===
 
===Description===
Retrieves information about the given tables.  
+
Retrieves field information about the given tables.  
  
 
{{Description:JDatabase::getTableFields}}
 
{{Description:JDatabase::getTableFields}}
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JDatabase::getTableFields|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JDatabase::getTableFields|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public JDatabase::getTableFields ($tables, $typeonly=true)
+
public function getTableFields (
 +
        $tables
 +
        $typeOnly=true
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 20: Line 22:
 
|-
 
|-
 
|$tables
 
|$tables
|array|string
 
 
|
 
|
|A table name or a list of table names
+
|
 +
|
 
|-
 
|-
|$typeonly
+
|$typeOnly
|boolean
+
|bool
 
|true
 
|true
|Only return field types, default true
+
|True to only return field types.
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' array An array of fields by table.
array An array of fields by table
+
* '''Defined''' on line 1201 of libraries/joomla/database/database.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/database/database.php (line 804)
+
* see source code in [[jplatform:database/database.php#cl-804|BitBucket]]
+
===Referenced by===
+
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JDatabase::getTableFields source code''' on [[jplatform:database/database.php#cl-1193|BitBucket]]
 +
* {{JVer|11.1}} Class [[JDatabase/11.1|JDatabase]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_Database/11.1|Database]]
 +
* [[JDatabase::getTableFields|Other versions of JDatabase::getTableFields]]
 +
{{SeeAlso:JDatabase::getTableFields}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JDatabase::getTableFields|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JDatabase::getTableFields|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JDatabase/11.1|JDatabase]]
+
===User contributed notes===
* [[JDatabase::getTableFields|Other versions of this method]]
+
{{SeeAlso:JDatabase::getTableFields}}
+
===Examples===
+
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 51: Line 52:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JDatabase]][[Category:JDatabase::getTableFields]]</noinclude>
 
<noinclude>[[Category:JDatabase]][[Category:JDatabase::getTableFields]]</noinclude>

Revision as of 20:25, 27 April 2011

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Joomla 11.1 JDatabase::getTableFields

Description

Retrieves field information about the given tables.

Description:JDatabase::getTableFields [Edit Descripton]

public function getTableFields (
        $tables
        $typeOnly=true
)
Parameter Type Default Description
$tables
$typeOnly bool true True to only return field types.
  • Returns array An array of fields by table.
  • Defined on line 1201 of libraries/joomla/database/database.php
  • Since Joomla 11.1

See also

SeeAlso:JDatabase::getTableFields [Edit See Also]

User contributed notes

<CodeExamplesForm />