JDatabaseQuery::escape

Method to escape a string for usage in an SQL statement.

This method is provided for use where the query object is passed to a function for modification. If you have direct access to the database object, it is recommended you use the escape method directly. Note that 'e' is an alias for this method as it is in JDatabaseDriver.

Signature

public function escape(string
        $text,
            [boolean
        $extra = false] )

Parameters

$text: The string to be escaped.
$extra: Optional parameter to provide extra escaping.

Returns

string: The escaped string.

Errors/Exceptions

RuntimeException: if the internal db property is not a valid object.