svn: /phpdoc/en/trunk/reference/mongo/ mongogridfs/delete.xml mongogridfs/get.xml mongogridfs/put.xml versions.xml
| From: | Kristina Chodorow | Date: | Thu, 13 May 2010 19:19:55 +0000 |
| Subject: | svn: /phpdoc/en/trunk/reference/mongo/ mongogridfs/delete.xml mongogridfs/get.xml mongogridfs/put.xml versions.xml | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-6646@lists.php.net to get a copy of this message | ||
kristina Thu, 13 May 2010 19:19:55 +0000
Revision: http://svn.php.net/viewvc?view=revision&revision=299359
Log:
added gridfs get, put, & delete
Changed paths:
A phpdoc/en/trunk/reference/mongo/mongogridfs/delete.xml
A phpdoc/en/trunk/reference/mongo/mongogridfs/get.xml
A phpdoc/en/trunk/reference/mongo/mongogridfs/put.xml
U phpdoc/en/trunk/reference/mongo/versions.xml
Added: phpdoc/en/trunk/reference/mongo/mongogridfs/delete.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongogridfs/delete.xml (rev 0)
+++ phpdoc/en/trunk/reference/mongo/mongogridfs/delete.xml 2010-05-13 19:19:55 UTC (rev 299359)
@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!-- $Revision$ -->
+<refentry xml:id="mongogridfs.delete" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>MongoGridFS::delete</refname>
+ <refpurpose>Delete a file from the database</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier>
<type>boolean</type><methodname>MongoGridFS::delete</methodname>
+
<methodparam><type>mixed</type><parameter>id</parameter></methodparam>
+ </methodsynopsis>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>id</parameter>
+ </term>
+ <listitem>
+ <para>
+ <literal>_id</literal> of the file to remove.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns if the remove was successfully sent to the database.
+ </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
+-->
Property changes on: phpdoc/en/trunk/reference/mongo/mongogridfs/delete.xml
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
Added: phpdoc/en/trunk/reference/mongo/mongogridfs/get.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongogridfs/get.xml (rev 0)
+++ phpdoc/en/trunk/reference/mongo/mongogridfs/get.xml 2010-05-13 19:19:55 UTC (rev 299359)
@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!-- $Revision$ -->
+<refentry xml:id="mongogridfs.get" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>MongoGridFS::get</refname>
+ <refpurpose>Retrieve a file from the database</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier>
<type>MongoGridFSFile</type><methodname>MongoGridFS::get</methodname>
+
<methodparam><type>mixed</type><parameter>id</parameter></methodparam>
+ </methodsynopsis>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>id</parameter>
+ </term>
+ <listitem>
+ <para>
+ <literal>_id</literal> of the file to find.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the file, if found, or &null;.
+ </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
+-->
Property changes on: phpdoc/en/trunk/reference/mongo/mongogridfs/get.xml
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
Added: phpdoc/en/trunk/reference/mongo/mongogridfs/put.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/mongogridfs/put.xml (rev 0)
+++ phpdoc/en/trunk/reference/mongo/mongogridfs/put.xml 2010-05-13 19:19:55 UTC (rev 299359)
@@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<!-- $Revision$ -->
+<refentry xml:id="mongogridfs.put" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+ <refname>MongoGridFS::put</refname>
+ <refpurpose>Stores a file in the database</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+ &reftitle.description;
+ <methodsynopsis>
+ <modifier>public</modifier>
<type>mixed</type><methodname>MongoGridFS::put</methodname>
+
<methodparam><type>string</type><parameter>filename</parameter></methodparam>
+ <methodparam
choice="opt"><type>array</type><parameter>extra</parameter><initializer>array()</initializer></methodparam>
+ </methodsynopsis>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term>
+ <parameter>filename</parameter>
+ </term>
+ <listitem>
+ <para>
+ The name of the file.
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>
+ <parameter>extra</parameter>
+ </term>
+ <listitem>
+ <para>
+ Other metadata to add to the file saved.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns the <literal>_id</literal> of the saved object.
+ </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
+-->
Property changes on: phpdoc/en/trunk/reference/mongo/mongogridfs/put.xml
___________________________________________________________________
Added: svn:keywords
+ Id Rev Revision Date LastChangedDate LastChangedRevision Author LastChangedBy HeadURL URL
Modified: phpdoc/en/trunk/reference/mongo/versions.xml
===================================================================
--- phpdoc/en/trunk/reference/mongo/versions.xml 2010-05-13 18:39:00 UTC (rev 299358)
+++ phpdoc/en/trunk/reference/mongo/versions.xml 2010-05-13 19:19:55 UTC (rev 299359)
@@ -100,6 +100,9 @@
<function name='mongogridfs::storefile' from='PECL mongo
>=0.9.0'/>
<function name='mongogridfs::storeupload' from='PECL mongo
>=0.9.0'/>
<function name='mongogridfs::storebytes' from='PECL mongo
>=0.9.2'/>
+ <function name='mongogridfs::get' from='PECL mongo >=1.0.8'/>
+ <function name='mongogridfs::put' from='PECL mongo >=1.0.8'/>
+ <function name='mongogridfs::delete' from='PECL mongo >=1.0.8'/>
<!-- MongoGridFSFile -->
<function name='mongogridfsfile::__construct' from='PECL mongo
>=0.9.0'/>
<function name='mongogridfsfile::getbytes' from='PECL mongo
>=0.9.0'/>