php-doc-en/reference/mysql_xdevapi/mysql_xdevapi/collection/existsindatabase.xml
Philip Olson 98bf51d2b9 Documented the mysql_xdevapi PECL extension, an extension for the MySQL X DevAPI.
Documentation written by Darek, Filip, Johannes, and myself
They are rough and incomplete at the moment so translators
please ignore them for at least a month


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@344726 c90b9560-bf6c-de11-be94-00142212c4b1
2018-04-19 05:05:47 +00:00

75 lines
1.9 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="mysql-xdevapi-collection.existsindatabase" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Collection::existsInDatabase</refname>
<refpurpose>Check if collection exists in database</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>bool</type><methodname>mysql_xdevapi\Collection::existsInDatabase</methodname>
<void />
</methodsynopsis>
<para>
Checks if the Collection object refers to a collection in the database.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; if collection exists in the database, else &false; if it does not.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>mysql_xdevapi\Collection::existsInDatabase</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Assuming $coll is a valid Collection object
if( !$coll->existsInDatabase() ) {
print('Sorry, but the collection do not exists in the provided database!');
}
?>
]]>
</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
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/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
-->