Actions

API17

Difference between revisions of "JDatabase::quote"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
m (Reverted edits by Tom6 (talk) to last revision by Doxiki2)
(3 intermediate revisions by 2 users not shown)
Line 2: Line 2:
 
=={{JVer|11.1}} JDatabase::quote==
 
=={{JVer|11.1}} JDatabase::quote==
 
===Description===
 
===Description===
Get a quoted database escaped string.  
+
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>
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public JDatabase->quote ($text, $escaped=true)
+
public function quote (
 +
        $text
 +
        $escape=true
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 22: Line 24:
 
|string
 
|string
 
|
 
|
|A string  
+
|The string to quote.
 
|-
 
|-
|$escaped
+
|$escape
|boolean
+
|bool
 
|true
 
|true
|Default true to escape string, false to leave the string unchanged  
+
|True to escape the string, false to leave it unchanged.
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' string The quoted input string.
string
+
* '''Defined''' on line 903 of libraries/joomla/database/database.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/database/database.php
+
===Referenced by===
+
 
===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>
* [[JDatabase/11.1|JDatabase]]
+
===User contributed notes===
* [[JDatabase::quote|Other versions of this method]]
+
{{SeeAlso:JDatabase::quote}}
+
===Examples===
+
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 50: 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 19:18, 2 February 2012

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::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 Joomla 11.1

See also

SeeAlso:JDatabase::quote [Edit See Also]

User contributed notes

<CodeExamplesForm />