Difference between revisions of "JDatabaseMySQLi::getEscaped"
From Joomla! Documentation
(Layout updates) |
(Updated to r1448:247ba8d88526) |
||
| Line 2: | Line 2: | ||
=={{JVer|11.1}} JDatabaseMySQLi::getEscaped== | =={{JVer|11.1}} JDatabaseMySQLi::getEscaped== | ||
===Description=== | ===Description=== | ||
| − | + | Method to escape a string for usage in an SQL statement. | |
{{Description:JDatabaseMySQLi::getEscaped}} | {{Description:JDatabaseMySQLi::getEscaped}} | ||
| Line 8: | Line 8: | ||
<nowiki>[</nowiki>[[Description:JDatabaseMySQLi::getEscaped|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JDatabaseMySQLi::getEscaped|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
<source lang="php"> | <source lang="php"> | ||
| − | public | + | public function getEscaped ( |
| + | $text | ||
| + | $extra=false | ||
| + | ) | ||
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 22: | Line 24: | ||
|string | |string | ||
| | | | ||
| − | |The string to be escaped | + | |The string to be escaped. |
|- | |- | ||
|$extra | |$extra | ||
| − | | | + | |bool |
|false | |false | ||
| − | |Optional parameter to provide extra escaping | + | |Optional parameter to provide extra escaping. |
|- | |- | ||
|} | |} | ||
| − | + | * '''Returns''' string The escaped string. | |
| − | string | + | * '''Defined''' on line 226 of libraries/joomla/database/database/mysqli.php |
| − | + | * '''Since''' {{JVer|11.1 }} | |
| − | libraries/joomla/database/database/mysqli.php | ||
| − | * | ||
| − | |||
===See also=== | ===See also=== | ||
| + | * {{JVer|11.1}} '''JDatabaseMySQLi::getEscaped source code''' on [[jplatform:database/database/mysqli.php#cl-218|BitBucket]] | ||
| + | * {{JVer|11.1}} Class [[JDatabaseMySQLi/11.1|JDatabaseMySQLi]] | ||
| + | * {{JVer|11.1}} Subpackage [[Subpackage_Database/11.1|Database]] | ||
| + | * [[JDatabaseMySQLi::getEscaped|Other versions of JDatabaseMySQLi::getEscaped]] | ||
| + | {{SeeAlso:JDatabaseMySQLi::getEscaped}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JDatabaseMySQLi::getEscaped|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JDatabaseMySQLi::getEscaped|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:JDatabaseMySQLi]][[Category:JDatabaseMySQLi::getEscaped]]</noinclude> | <noinclude>[[Category:JDatabaseMySQLi]][[Category:JDatabaseMySQLi::getEscaped]]</noinclude> | ||
Revision as of 20:33, 27 April 2011
The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.
JDatabaseMySQLi::getEscaped[edit]
Description[edit]
Method to escape a string for usage in an SQL statement.
Template:Description:JDatabaseMySQLi::getEscaped [Edit Descripton]
public function getEscaped (
$text
$extra=false
)| Parameter | Type | Default | Description |
|---|---|---|---|
| $text | string | The string to be escaped. | |
| $extra | bool | false | Optional parameter to provide extra escaping. |
- Returns string The escaped string.
- Defined on line 226 of libraries/joomla/database/database/mysqli.php
- Since
See also[edit]
- JDatabaseMySQLi::getEscaped source code on BitBucket
- Class JDatabaseMySQLi
- Subpackage Database
- Other versions of JDatabaseMySQLi::getEscaped
Template:SeeAlso:JDatabaseMySQLi::getEscaped [Edit See Also]
User contributed notes[edit]
<CodeExamplesForm />