mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
c613a7e2f1
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@338645 c90b9560-bf6c-de11-be94-00142212c4b1
77 lines
2 KiB
XML
77 lines
2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="mongodbref.isref" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
<refnamediv>
|
|
<refname>MongoDBRef::isRef</refname>
|
|
<refpurpose>Checks if an array is a database reference</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsynopsisdiv role="soft-deprecation-notice">
|
|
<sidebar>
|
|
&mongo.noalternative.class.note;
|
|
<para>
|
|
The concept of database references, and hence this class, has been
|
|
deprecated.
|
|
</para>
|
|
</sidebar>
|
|
</refsynopsisdiv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>MongoDBRef::isRef</methodname>
|
|
<methodparam><type>mixed</type><parameter>ref</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This method does not actually follow the reference, so it does not determine if it is
|
|
broken or not. It merely checks that <parameter>ref</parameter> is in valid
|
|
database reference format (in that it is an object or array with $ref and $id
|
|
fields).
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term>
|
|
<parameter>ref</parameter>
|
|
</term>
|
|
<listitem>
|
|
<para>
|
|
Array or object to check.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</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:"~/.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
|
|
-->
|