php-doc-en/reference/sqlite/functions/sqlite-escape-string.xml
Wez Furlong 932bef68d7 First run at documentation for the SQLite extension.
Many thanks to Johann :)


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@132642 c90b9560-bf6c-de11-be94-00142212c4b1
2003-06-20 17:31:55 +00:00

64 lines
2.3 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.sqlite-escape-string">
<refnamediv>
<refname>sqlite_escape_string</refname>
<refpurpose>Escapes a string for use as a query parameter</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>string</type><methodname>sqlite_escape_string</methodname>
<methodparam><type>string</type><parameter>item</parameter></methodparam>
</methodsynopsis>
<para>
<function>sqlite_escape_string</function> will correctly quote the string
specified by <parameter>item</parameter>
for use in an SQLite SQL statement. This includes doubling up
single-quote characters (<literal>'</literal>) and checking for
binary-unsafe characters in the query string.
</para>
<para>
If the <parameter>item</parameter> contains a <literal>NUL</literal>
character, or if it begins with a character whose ordinal value is
<literal>0x01</literal>, PHP will apply a binary encoding scheme so that
you can safely store and retrieve binary data.
</para>
<para>
Although the encoding makes it safe to insert the data, it will render
simple text comparisions and LIKE clauses in your queries unusable for
the columns that contain the binary data. In practice, this shouldn't be
a problem, as your schema should be such that you don't use such things
on binary columns (in fact, it might be better to store binary data using
other means, such as in files).
</para>
<warning>
<simpara>
<function>addslashes</function> should <emphasis>NOT</emphasis> be used
to quote your strings for SQLite queries; it will lead to strange results when
retrieving your data.
</simpara>
</warning>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->