From 166000d7b73881e594b5c0c6517b5ef615ecb06a Mon Sep 17 00:00:00 2001
From: Kristina Chodorow <kristina@php.net>
Date: Tue, 24 Mar 2009 18:25:46 +0000
Subject: [PATCH] adding code datatype

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@277701 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/mongo/mongocode.xml         |  70 +++++++++++++++++
 reference/mongo/mongoid/construct.xml | 105 ++++++++++++++++++++++++++
 reference/mongo/mongoid/tostring.xml  |  77 +++++++++++++++++++
 3 files changed, 252 insertions(+)
 create mode 100644 reference/mongo/mongocode.xml
 create mode 100644 reference/mongo/mongoid/construct.xml
 create mode 100644 reference/mongo/mongoid/tostring.xml

diff --git a/reference/mongo/mongocode.xml b/reference/mongo/mongocode.xml
new file mode 100644
index 0000000000..c3d2365970
--- /dev/null
+++ b/reference/mongo/mongocode.xml
@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.1 $ -->
+
+<phpdoc:classref xml:id="class.mongocode" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+
+ <title>The MongoCode class</title>
+ <titleabbrev>MongoCode</titleabbrev>
+
+ <partintro>
+
+<!-- {{{ MongoId intro -->
+  <section xml:id="mongocode.intro">
+   &reftitle.intro;
+   <para>
+    Represents JavaScript code for the database.
+   </para>
+   <para>
+    MongoCode objects are composed of two parts: a string of code and an optional scope.  The string of code must be valid JavaScript.  The scope is a associative array of variable name/value pairs.
+   </para>
+  </section>
+<!-- }}} -->
+
+  <section xml:id="mongoid.synopsis">
+   &reftitle.classsynopsis;
+
+<!-- {{{ Synopsis -->
+   <classsynopsis>
+    <ooclass><classname>MongoCode</classname></ooclass>
+
+<!-- {{{ Class synopsis -->
+    <classsynopsisinfo>
+     <ooclass>
+      <classname>MongoCode</classname>
+     </ooclass>
+    </classsynopsisinfo>
+<!-- }}} -->
+    
+    <classsynopsisinfo role="comment">Methods</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.mongocode')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[1])" />
+   </classsynopsis>
+<!-- }}} -->
+
+  </section>
+
+ </partintro>
+
+ &reference.mongo.entities.mongocode;
+
+</phpdoc:classref>
+
+<!-- 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:"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
+-->
diff --git a/reference/mongo/mongoid/construct.xml b/reference/mongo/mongoid/construct.xml
new file mode 100644
index 0000000000..89ff994c76
--- /dev/null
+++ b/reference/mongo/mongoid/construct.xml
@@ -0,0 +1,105 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.1 $ -->
+
+<refentry xml:id="mongocode.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>MongoCode::__construct</refname>
+  <refpurpose>Creates a new code object</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <methodname>MongoCode::__construct</methodname>
+   <methodparam><type>string</type><parameter>code</parameter></methodparam>
+   <methodparam choice="opt"><type>array</type><parameter>scope</parameter><initializer>array()</initializer></methodparam>
+  </methodsynopsis>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term>
+      <parameter>code</parameter>
+     </term>
+     <listitem>
+      <para>
+       A string of code.
+      </para>
+     </listitem>
+    </varlistentry>   
+    <varlistentry>
+     <term>
+      <parameter>scope</parameter>
+     </term>
+     <listitem>
+      <para>
+       The scope to use for the code.
+      </para>
+     </listitem>
+    </varlistentry>   
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns a new code object.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example>
+    <title><function>MongoCode::__construct</function> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+
+$code = new MongoCode('function(x) { for(i=0;i<10;i++) { db.foo.update({x:i}, {x:i+1}); } return x-1; }', array("x" => 4));
+var_dump($code);
+
+?>
+]]>
+    </programlisting>
+    &example.outputs.similar;
+    <screen>
+<![CDATA[
+object(MongoCode)#1 (2) {
+  ["scope"]=>
+  array(1) {
+    ["x"]=>
+    int(4)
+  }
+  ["code"]=>
+  string(80) "function(x) { for(i=0;i<10;i++) { db.foo.update({x:i}, {x:i+1}); } return x-1; }"
+}
+]]>
+    </screen>
+  </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:"../../../../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
+-->
diff --git a/reference/mongo/mongoid/tostring.xml b/reference/mongo/mongoid/tostring.xml
new file mode 100644
index 0000000000..5c22ae86cc
--- /dev/null
+++ b/reference/mongo/mongoid/tostring.xml
@@ -0,0 +1,77 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision: 1.1 $ -->
+
+<refentry xml:id="mongocode.tostring" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <refnamediv>
+  <refname>MongoCode::__toString</refname>
+  <refpurpose>Returns this code as a string</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <modifier>public</modifier> <type>string</type><methodname>MongoCode::__toString</methodname>
+   <void/>
+  </methodsynopsis>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   This code, the scope is not returned.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <example>
+   <title><function>MongoCode::__toString</function> example</title>
+   <programlisting role="php">
+<![CDATA[
+<?php
+
+$code = new MongoCode('return x;', array("x"=>"hi"));
+echo "$code\n";
+
+$code = new MongoCode('function() { for(i=0;i<10;i++) { db.foo.update({x:i}, {x:i+1}); } }');
+echo "$code\n";
+
+?>
+]]>
+   </programlisting>
+   &example.outputs.similar;
+   <screen>
+<![CDATA[
+return x;
+function() { for(i=0;i<10;i++) { db.foo.update({x:i}, {x:i+1}); } }
+]]>
+   </screen>
+  </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:"../../../../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
+-->