API17:JDatabase::quote
From Joomla! Documentation
(Difference between revisions)
(Layout updates) |
(Updated to r1448:247ba8d88526) |
||
| Line 2: | Line 2: | ||
=={{JVer|11.1}} JDatabase::quote== | =={{JVer|11.1}} JDatabase::quote== | ||
===Description=== | ===Description=== | ||
| − | + | Method to quote and optionally escape a string to database requirements for insertion into the database. | |
{{Description:JDatabase::quote}} | {{Description:JDatabase::quote}} | ||
| Line 8: | Line 8: | ||
<nowiki>[</nowiki>[[Description:JDatabase::quote|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JDatabase::quote|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
<source lang="php"> | <source lang="php"> | ||
| − | public | + | public function quote ( |
| + | $text | ||
| + | $escape=true | ||
| + | ) | ||
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 22: | Line 24: | ||
|string | |string | ||
| | | | ||
| − | | | + | |The string to quote. |
|- | |- | ||
| − | |$ | + | |$escape |
| − | | | + | |bool |
|true | |true | ||
| − | | | + | |True to escape the string, false to leave it unchanged. |
|- | |- | ||
|} | |} | ||
| − | + | * '''Returns''' string The quoted input string. | |
| − | string | + | * '''Defined''' on line 903 of libraries/joomla/database/database.php |
| − | + | * '''Since''' {{JVer|11.1 }} | |
| − | libraries/joomla/database/database.php | + | |
| − | * | + | |
| − | + | ||
===See also=== | ===See also=== | ||
| + | * {{JVer|11.1}} '''JDatabase::quote source code''' on [[jplatform:database/database.php#cl-895|BitBucket]] | ||
| + | * {{JVer|11.1}} Class [[JDatabase/11.1|JDatabase]] | ||
| + | * {{JVer|11.1}} Subpackage [[Subpackage_Database/11.1|Database]] | ||
| + | * [[JDatabase::quote|Other versions of JDatabase::quote]] | ||
| + | {{SeeAlso:JDatabase::quote}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JDatabase::quote|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JDatabase::quote|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | + | ===User contributed notes=== | |
| − | + | ||
| − | + | ||
| − | === | + | |
<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::quote]]</noinclude> | <noinclude>[[Category:JDatabase]][[Category:JDatabase::quote]]</noinclude> | ||
Revision as of 20:27, 27 April 2011
JDatabase::quote
Description
Method to quote and optionally escape a string to database requirements for insertion into the database.
Description:JDatabase::quote [Edit Descripton]
public function quote ( $text $escape=true )
| Parameter | Type | Default | Description |
|---|---|---|---|
| $text | string | The string to quote. | |
| $escape | bool | true | True to escape the string, false to leave it unchanged. |
- Returns string The quoted input string.
- Defined on line 903 of libraries/joomla/database/database.php
- Since
See also
- JDatabase::quote source code on BitBucket
- Class JDatabase
- Subpackage Database
- Other versions of JDatabase::quote
SeeAlso:JDatabase::quote [Edit See Also]
User contributed notes
<CodeExamplesForm />
