cvs: peardoc /en/package/database/db/db-common escapesimple.xml
| From: | Daniel Convissor | Date: | Mon, 26 Jan 2004 22:05:37 +0000 |
| Subject: | cvs: peardoc /en/package/database/db/db-common escapesimple.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-2176@lists.php.net to get a copy of this message | ||
danielc Mon Jan 26 17:05:37 2004 EDT
Added files:
/peardoc/en/package/database/db/db-common escapesimple.xml
Log:
Add new escapeSimple() method.
http://cvs.php.net/co.php/peardoc/en/package/database/db/db-common/escapesimple.xml?r=1.1&p=1
Index: peardoc/en/package/database/db/db-common/escapesimple.xml
+++ peardoc/en/package/database/db/db-common/escapesimple.xml
<!-- $Revision: 1.1 $ -->
<refentry id="package.database.db.db-common.escapesimple">
<refnamediv>
<refname>DB_Common::escapeSimple()</refname>
<refpurpose>Escape a string according to the current DBMS's
standards</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>DB::escapeSimple</function></funcdef>
<paramdef>string <parameter>$str</parameter></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="package.database.db.db-common.escapesimple.desc">
&title.desc;
<para>
Escape a string according to the current DBMS's standards.
</para>
</refsect1>
<refsect1 id="package.database.db.db-common.escapesimple.parameter">
&title.param;
<para>
<variablelist>
<varlistentry>
<term>
&type.string;
<parameter>$str</parameter>
</term>
<listitem>
<para>
the input to be escaped
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 id="package.database.db.db-common.escapesimple.return">
&title.returns;
<para>
<parameter>string</parameter> - the escaped string
</para>
</refsect1>
<refsect1 id="package.database.db.db-common.escapesimple.note">
&title.note;
¬e.notstatic;
<simpara>
Function available since: Release 1.6.0
</simpara>
</refsect1>
<refsect1 id="package.database.db.db-common.escapesimple.example">
&title.example;
<example>
<title>Using <function>escapeSimple</function></title>
<programlisting role="php">
<![CDATA[
<?php
// Once you have a valid DB object...
$name = "all's well";
$sql = "SELECT * FROM clients WHERE name = '"
. $db->escapeSimple($name) . "'";
$result = $db->query($sql);
?>
]]>
</programlisting>
</example>
</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
-->