Merge lp:~zorba-coders/zorba/phpapi into lp:zorba

[William Candillon]

This merge adds the PHP API that was introduced at the PHP Tour 2011.
It contains a test for it (php2).

From the last merge proposal, the following things have been done:
- Revert bogus change in swig/php/generate_proxy.php.in (renaming of libPrefix to prefix).
- Introduce a STD Iterator for streaming results.
- Make the parseXML() method private.
- Improve importQueryFromURI

The two key tests are:
- php1
- php2

[Matthias Brantner (matthias-brantner)]

- One thing that I don't understand is the relationship with the existing PHP binding.
- The first three changes in swig/php/generate_proxy.php.in should be reverted (renaming of libPrefix to prefix)
- executeToURI is only capable of writing to files. Also, it currently doesn't stream.
- importQueryFromURI only works for file URIs.
- The parse functionality should probably be removed. It merges two functionalities which don't really belong together (retrieving of data and parsing xml). The latter can also be done in XQuery. If this philosophy is to push more functionality into XQuery, the parse functionality should be removed or made symmetric to the existing C++ and XQuery data manager APIs.
- getItem doesn't have a comment and is incomplete. Shouldn't it support more/all XQuery types?

review: Needs Fixing

[William Candillon (wcandillon)]

> - One thing that I don't understand is the relationship with the existing PHP binding.
The low level API enables us to extend/debug the XQueryProcessor API more easily.

> - The first three changes in swig/php/generate_proxy.php.in should be reverted (renaming of libPrefix to prefix)
This is fixed in commit 10597.

> - executeToURI is only capable of writing to files. Also, it currently doesn't stream.
This is fixed in commit 10598.

> - importQueryFromURI only works for file URIs.
This is fixed in commit 10600. There is a test for it in commit 10601.

> - The parse functionality should probably be removed. It merges two functionalities which don't really belong together (retrieving of data and parsing xml). The latter can also be done in XQuery. If this philosophy is to push more functionality into XQuery, the parse functionality should be removed or made symmetric to the existing C++ and XQuery data manager APIs.

This is fixed in commit 10598. Unfortunately there two orthogonal things in commit 10598.

> - getItem doesn't have a comment and is incomplete. Shouldn't it support more/all XQuery types?
It should support any kind of PHP type. Currently objects are not supported. Maybe in the futur we will introduce support for objects.

[Matthias Brantner (matthias-brantner)]

Here are some more comments and questions:

* Copyright 2006-2008 The FLWOR Foundation.
=> * Copyright 2006-2012 The FLWOR Foundation.

* Iterate over an instance of the XML Data Model (i.e, a sequence of items).
* This class implements the SPL Iterator interface.

You can only iterate over a sequence of instances of the XDM. The sequence
is not an instance by itself.

* The XQueryProcessor class allows to invoke
* <a href="http://www.zorba-xquery.com">Zorba XQuery Processor</a>.

to invoke _the_ ...

* Instruction to install the extension can be found at <a href=""></a>.

Instruction_s_

* Shutdowns

Shuts down

* In the following code snippet, the following code snippets imports and execute an <em>Hello World</em> query:

confusing sentence

* Import a query to execute from its filename.

Import a query to execute from a file with the given name.

* $xquery->importQueryiFromURI('hello_world.xq');

$xquery->importQueryFromURI('hello_world.xq');

* Filename of the query to execute.

Filename containing the query to execute.

* Set value for an external variable.

Set a value for an external variable.

* The following code snippet sets the value of the variable
* <em>$i</em> with <em>1</em>.

The following code snippet sets the value of the variable
<em>$i</em> to <em>1</em> with type xs:integer.

* The following code snippet sets the value of the variable <em>$i</em> in
* the local namespace with the value <em>1</em>.

The following code snippet sets the value of the variable <em>$i</em> in
the local namespace to the value <em>1</em>.

getIterator and compile() don't have comments. Also, the indentation of compile() and getItem() seem to be broken

Why do you repeat the conversion rules from setVariable in the comment of getItem. Why does one rule include SimpleXMLElement and the other one doesn't?

Did you drop the streaming execution for execute()? If so, why?

review: Needs Fixing

[William Candillon (wcandillon)]

Copyright statements are updated in r10603.
All the typos you sent are fixed in r10604.
PHPDoc docs comments are added for compile() and getIterator() in r10605.
The indentation of the compile() and getItem() is fixed in r10606.
r10607 is a fix for the duplicate and inconsistent description of the PHP to XQuery type mapping.
William finds out about IteratorAggregate in r10608 (http://php.net/manual/en/class.iteratoraggregate.php).

[Matthias Brantner (matthias-brantner)]

- Is it on purpose that the only thing that is returned by the iterator is a serialized version of the item? For example, this will return an error for attribute nodes.

- There is a tab at the beginning of

  /**
   * Internal

- Is this wrapper supposed to be merged before the implementation of execute() can stream?

review: Needs Information

[William Candillon (wcandillon)]

> - Is it on purpose that the only thing that is returned by the iterator is a
> serialized version of the item? For example, this will return an error for
> attribute nodes.
Yes.
We have two use cases for XQPHP:
- The mobile app which uses execute().
- The google earth demo which uses the iterator.

>
> - There is a tab at the beginning of
>
> /**
> * Internal
>
> - Is this wrapper supposed to be merged before the implementation of execute()
> can stream?
Yes

[William Candillon (wcandillon)]

This new proposal is removing unwanted tabs.

[Matthias Brantner (matthias-brantner)]

I'm fine with it now. Before merging, please make sure the change is contained in the ChangeLog. Also, don't mention the obsolete comment in the description or commit message "- Revert bogus change in swig/php/generate_proxy.php.in (renaming of libPrefix to prefix).".

As an aside, importQueryFromURI still allows file system access only. I saw that the comment mentions that but it's still strange.

[William Candillon (wcandillon)]

importQueryFromURI() can read any kind of stream and there is even a test for it.
It is commented out so the php tests don't rely on http connections.

[William Candillon (wcandillon)]

I've updated the changelog.

[Matthias Brantner (matthias-brantner)]

When I tried it, I was confused about the return value of the iterator. I think it deserves a comment that it return the string value of the current item.

Also a minor typo:

 The following code snippets imports and execute an <em>Hello World</em> query:
=>
 The following code snippets imports and execute_s a_ <em>Hello World</em> query:

review: Needs Fixing

[Rodolfo Ochoa (rodolfo-ochoa)]

review: Approve

[lp:~zorba-coders/zorba/phpapi]

10619. By Markos Zaharioudakis on 2012-01-18

Fixed bug 917923 (bug in copying outer var values into the eval dynamic context) Approved: Markos Zaharioudakis

10620. By Gabriel Petrovay on 2012-01-18

Added Ctrl-C hooking in the debugger. Ctrl-C can not kill the debugger anymore. It will only stop the running query. Approved: David Graf, Gabriel Petrovay

10621. By William Candillon on 2012-01-18

This merge adds the PHP API that was introduced at the PHP Tour 2011. Approved: Rodolfo Ochoa, William Candillon

10622. By Chris Hillery on 2012-01-19

This merge adds the PHP API that was introduced at the PHP Tour 2011. Approved: Rodolfo Ochoa, William Candillon

10623. By Sorin Marian Nasoi <email address hidden> on 2012-01-20

Added the information about the Zorba module version in the generated XQDoc documentation. Approved: William Candillon, Sorin Marian Nasoi

10624. By Markos Zaharioudakis on 2012-01-20

fix for bug #919189 Approved: Markos Zaharioudakis

10625. By Markos Zaharioudakis on 2012-01-20

fix for bug #866423 Approved: Markos Zaharioudakis

10626. By Matthias Brantner on 2012-01-21

fn:serialize avoids copying the result but returns a streamable string instead Approved: Till Westmann, Matthias Brantner

10627. By Matthias Brantner on 2012-01-21

Implemented StaticContext::getNamespaceBindings to resolve bug #905035. In the same commit, the function getNamespaceURIByPrefix was deprecated because it's superseded by the new function. Approved: Rodolfo Ochoa, Markos Zaharioudakis

10628. By Markos Zaharioudakis on 2012-01-23

fix for bug #866932 (string pool not empty on shutdown)
 Approved: Markos Zaharioudakis

10629. By Chris Hillery on 2012-01-24

Remove test case sc3_ex3 in order to merge the removal of the non-core JSON module. sc3_ex3 will be re-added along with the core JSON module. Approved: Paul J. Lucas, Chris Hillery

10630. By Markos Zaharioudakis on 2012-01-24

More types-related optimizations for the comparison operators Approved: Markos Zaharioudakis

10631. By Markos Zaharioudakis on 2012-01-25

Fixed bug involving positional var and groupby Approved: Markos Zaharioudakis

10632. By Chris Hillery on 2012-01-26

- updated the import scripts to use the latest version of XQTS, XQUTS and XQFTTS as of 25.01.2012
- added EXPECTED_FAILURES for XQFTTS XQuery and XQueryX tests
- updated the W3C conformance documentation
- included fix for the XQFTTS XQueryX tests created by Daniel in lp:~zorba-coders/zorba/xqueryx_fulltext branch Approved: Chris Hillery, Sorin Marian Nasoi

10633. By Markos Zaharioudakis on 2012-01-26

type-related optimizagtions of boolean iterators Approved: Markos Zaharioudakis

10634. By Paul J. Lucas on 2012-01-27

Migrated several unit tests to libunittest. Approved: Chris Hillery, Paul J. Lucas

10635. By Chris Hillery on 2012-01-30

Fix filename when creating library for unversioned module. Approved: Dennis Knochenwefel, Chris Hillery

10636. By Markos Zaharioudakis on 2012-01-30

type-related optimizations for sequence-type iterators Approved: Markos Zaharioudakis

10637. By Paul J. Lucas on 2012-01-31

Fixed bug 924063 (sentence is incorrectly incremented when token characters end without sentence terminator) Approved: Matthias Brantner, Paul J. Lucas

10638. By Chris Hillery on 2012-02-01

Install the XHTML DTD locally so we don't ask w3.org for it. Approved: Chris Hillery, Sorin Marian Nasoi

10639. By Chris Hillery on 2012-02-02

Added DECLARE_ZORBA_URI_FILE() for installing files of any type that we would like to load by URI. Also made built-in URI mappers look on the filesystem for any kind of URIs, not just modules and schemas. Approved: Cezar Andrei, Chris Hillery

10640. By Daniel Turcanu on 2012-02-02

several fixes for the plan serializer + implemented materialize_clause::clone() Approved: Matthias Brantner, Chris Hillery

10641. By Markos Zaharioudakis on 2012-02-02

w3c test modules-schema-context now passes Approved: Markos Zaharioudakis

10642. By Ghislain Fourny on 2012-02-02

Correcting two typos (parameter name and document debug output). Approved: Ghislain Fourny, Matthias Brantner

10643. By William Candillon on 2012-02-02

Fix for bug #918592 Approved: Chris Hillery, Rodolfo Ochoa

10644. By Chris Hillery on 2012-02-05

Several fixes related to test breakages caused by zorba-xquery.com changes:
1. Don't attempt HTTP resolution w/ HttpStream if Zorba compiled without CURL.
2. store/example_3 test: load content from zorbatest site like other tests.
3. fetch_bogus2 and impot5 test: change "ver" test module to be identified with a flworfound.org URI, so we'll get a 404 when loading it wrong. (Both example.com and zorba-xquery.com don't return 404 for unknown URLs.)
 Approved: Matthias Brantner, Chris Hillery

10645. By Rodolfo Ochoa on 2012-02-06

Added recognition for URIs without authority, this is a JAVA URI case. Approved: Rodolfo Ochoa, Cezar Andrei

10646. By Rodolfo Ochoa on 2012-02-06

added
#include "stdafx.h"

and changed uri_util.h having
ZORBA_DLL_PUBLIC extern char const uri_safe[];
ZORBA_DLL_PUBLIC extern signed char const hex2dec[]; Approved: Cezar Andrei, Matthias Brantner

10647. By Sorin Marian Nasoi <email address hidden> on 2012-02-06

Downloaded the latest version of the W3C Working Draft 13 December 2011for XQuery 3.0 F&O to be used in test "xquery_3_0". Approved: Juan Zacarias, Sorin Marian Nasoi

10648. By Ghislain Fourny on 2012-02-07

Using GET_PUL_FACTORY macro. Approved: Markos Zaharioudakis

10649. By Markos Zaharioudakis on 2012-02-07

optimization for the Item::add/removeReference methods Approved: Markos Zaharioudakis

10650. By Chris Hillery on 2012-02-08

Ensure same module is not declared twice with the same version number (including twice with no declared version).
 Approved: Sorin Marian Nasoi, Chris Hillery

10651. By Chris Hillery on 2012-02-08

Download v1.0 of http-client. Approved: Sorin Marian Nasoi, Chris Hillery

10652. By Ghislain Fourny on 2012-02-08

Made same-directory simple store includes. Approved: Matthias Brantner, Markos Zaharioudakis

10653. By Paul J. Lucas on 2012-02-09

Simple fix. Approved: William Candillon, Paul J. Lucas

10654. By Markos Zaharioudakis on 2012-02-10

use SUBSEQUENCE_INT function, instead of SUBSEQUENCE_INT in partial_eval_eq rewrite rule Approved: Markos Zaharioudakis

10655. By Paul J. Lucas on 2012-02-10

Added clone(). Approved: Matthias Brantner, William Candillon

10656. By Markos Zaharioudakis on 2012-02-13

small optimization for subsequence iterators Approved: Markos Zaharioudakis

10657. By Markos Zaharioudakis on 2012-02-14

1. Optimization: preallocate and reuse temp sequence iterator for LetVarITerator and CtxVarIterator.
2. Optimization: enhanced push-down of positional predicate into LetVarITerator and CtxVarIterator. Approved: Markos Zaharioudakis

10658. By Markos Zaharioudakis on 2012-02-14

Fixed bug #872288 Approved: Markos Zaharioudakis

10659. By Till Westmann on 2012-02-14

added a new unit test for the plan serializer Approved: Matthias Brantner, Till Westmann

10660. By Markos Zaharioudakis on 2012-02-15

Fixed bug #867022 Approved: Markos Zaharioudakis

10661. By Markos Zaharioudakis on 2012-02-15

fix for bug #867266 Approved: Markos Zaharioudakis

10662. By Paul J. Lucas on 2012-02-16

New JSON parser and module. Approved: Sorin Marian Nasoi, Paul J. Lucas

10663. By Paul J. Lucas on 2012-02-16

- Added transcode_streambuf
- file:read-text now respects encodings
- http:send-request now respects encodings Approved: Matthias Brantner, Paul J. Lucas

10664. By Markos Zaharioudakis on 2012-02-16

Optimization: changed the implementation of the free-vars annotation and got rid of the annotations map in expressions Approved: Markos Zaharioudakis

10665. By Matthias Brantner on 2012-02-17

Put the state file written by the uuid functionality into the system's temp directory (temporary solution). Approved: Till Westmann, Matthias Brantner

10666. By Paul J. Lucas on 2012-02-17

Fixed return type. Approved: Juan Zacarias, Matthias Brantner, Paul J. Lucas

10667. By Matthias Brantner on 2012-02-18

added two api functions to introspect the functions of a static context Approved: Till Westmann, Matthias Brantner

10668. By William Candillon <email address hidden> on 2012-02-20

Fix typos in doxygen documentation. Approved: Cezar Andrei, Matthias Brantner

10669. By William Candillon on 2012-02-20

Update the XQDDF ebnf to fit with XQuery 3.0 syntax. Approved: William Candillon, Matthias Brantner

10670. By William Candillon on 2012-02-20

Add support for return and parameters elements in XQDoc. Approved: William Candillon, Sorin Marian Nasoi

10671. By Rodolfo Ochoa on 2012-02-20

Just some precompiled headers included Approved: Matthias Brantner, Cezar Andrei

10672. By William Candillon on 2012-02-21

XQuery 3.0 concat operator Approved: Matthias Brantner, William Candillon

10673. By David Graf on 2012-02-22

Added the new external variable value tests that will be added to the w3c testsuite to the zorba rbkt tests. Inclusive the failing once. Added launchpad entries for them and marked the tests as expected failures. Approved: Matthias Brantner, David Graf

10674. By Chris Hillery on 2012-02-23

Update data-cleaning module to release 1.0 (fixes conversion tests).
 Approved: Sorin Marian Nasoi, Chris Hillery

10675. By William Candillon on 2012-02-24

Add --compile-plan and --execute-plan option to zorba command line.
Example:
zorba -q 1+1 --compile-plan > test.xqc
zorba -q test.xqc -f --execute-plan Approved: William Candillon, Matthias Brantner

10676. By Chris Hillery on 2012-02-24

Error checking for DownloadModules.cmake; try three times on failures.
 Approved: Sorin Marian Nasoi, Chris Hillery

10677. By Matthias Brantner on 2012-02-24

more efficient implementation of xs:base64Binary items Approved: Till Westmann, Matthias Brantner

10678. By Ghislain Fourny on 2012-02-24

Makes same-directory store includes in the headers as well. Approved: Till Westmann, Matthias Brantner

10679. By Markos Zaharioudakis on 2012-02-27

Fixed bug in codegen: do not create a materialize clause if one exists already Approved: Markos Zaharioudakis

10680. By William Candillon on 2012-02-27

Remove conflicting shortcut -e for --execute-plan option. Approved: Matthias Brantner, William Candillon

10681. By Ghislain Fourny on 2012-02-28

Replacing ulong positions with xs_integer for positions in collections. Approved: Ghislain Fourny, Matthias Brantner

10682. By Ghislain Fourny on 2012-02-28

Refactored CollectionSet class. zorba::store::CollectionSet is abstract, zorba::simplestore::SimpleCollectionSet is its implementation for the simple store. Approved: Matthias Brantner, Till Westmann

10683. By Paul J. Lucas on 2012-02-28

Fixed bug 942808. Approved: Matthias Brantner, Paul J. Lucas

10684. By Markos Zaharioudakis on 2012-02-28

removed properties-generating scripts and restored zorba_properties.h and store_properties.h files. Approved: Markos Zaharioudakis

10685. By Daniel Turcanu on 2012-02-29

Making https work on Windows. Approved: Gabriel Petrovay, Sorin Marian Nasoi

10686. By Ghislain Fourny on 2012-02-29

Refactored QName pool and QNameItem class. Approved: Markos Zaharioudakis

10687. By Sorin Marian Nasoi <email address hidden> on 2012-02-29

Updated the web crawler tutorial. Approved: Nicolae Brinza, Sorin Marian Nasoi

10688. By William Candillon on 2012-02-29

Optimize iterator generation for the concat operator (fixes bug #942011) Approved: Matthias Brantner, Markos Zaharioudakis

10689. By Paul J. Lucas on 2012-02-29

Better implementation of ZORBA_WITH_BIG_INTEGER=OFF: now limited to 63 bits (for a 64-bit implementation of a long long). Also added build_options.dox. Approved: Markos Zaharioudakis, Matthias Brantner

10690. By Markos Zaharioudakis on 2012-03-01

fixed bug involing eval and the no-copy rule Approved: Markos Zaharioudakis

10691. By Matthias Brantner on 2012-03-01

fix for bug #943788 (streamable string is not seekable) Approved: Till Westmann, Matthias Brantner

10692. By Federico Cavalieri <federico@M702X> on 2012-03-01

Fixed bug #912579 (validate-in-place on non-root elements)
Fixed merge of updput primitives
Fixed merge conflict. Approved: Markos Zaharioudakis, Cezar Andrei

10693. By Markos Zaharioudakis on 2012-03-01

Added test that illustrates bug #944002 Approved: Markos Zaharioudakis

10694. By Markos Zaharioudakis on 2012-03-02

Fixed another bug involving eval and the no-copy rule Approved: Markos Zaharioudakis

10695. By Paul J. Lucas on 2012-03-02

Added ~XmlNodeTokenizerCallback() to destroy tokenizers. Approved: Matthias Brantner, Paul J. Lucas

10696. By Ghislain Fourny on 2012-03-05

Introduces an abstract layer between zorba::store::collection and zorba::simplestore::SimpleCollection. Approved: Matthias Brantner, Markos Zaharioudakis

10697. By Markos Zaharioudakis on 2012-03-05

fixed bug #944002
 Approved: Markos Zaharioudakis

10698. By Ghislain Fourny on 2012-03-05

Making two non-abstract functions in simplecollection API also non-virtual. Approved: Matthias Brantner, Markos Zaharioudakis

10699. By Ghislain Fourny on 2012-03-05

Added default constructors for index classes in simple store. Approved: Markos Zaharioudakis, Matthias Brantner

10700. By Markos Zaharioudakis on 2012-03-06

Fixed bug #867024 Approved: Markos Zaharioudakis

10701. By Sorin Marian Nasoi <email address hidden> on 2012-03-06

Fixed bug lp:946896. Approved: William Candillon, Sorin Marian Nasoi

10702. By Markos Zaharioudakis on 2012-03-06

Fixed memory leak in no-copy rule Approved: Markos Zaharioudakis

10703. By Matthias Brantner on 2012-03-06

A new module that provides URL-related functions. Currently, it provides functions to do URL-decoding but other URL-related functions (e.g. to retrieve the scheme or path) will be added later. Approved: Matthias Brantner, Chris Hillery

10704. By Markos Zaharioudakis on 2012-03-06

fixes bug 924987
- extended TypeIdentifier to also support schema-element, schema-attribute
  and namespace-node sequence types
- fixed TypeOps::get_type_identifier
- added a test to the staticcollectionmanager unit test
- added operator<< for TypeIdentifier Approved: Markos Zaharioudakis, Till Westmann

10705. By Paul J. Lucas on 2012-03-06

Set dispose_data_using_delete_ = false in reserve(). Approved: Markos Zaharioudakis, Matthias Brantner

10706. By Cezar Andrei <email address hidden> on 2012-03-06

Fix for bug 891209 : validation with xsi:type returns untyped. Approved: Matthias Brantner, Markos Zaharioudakis, Cezar Andrei

10707. By Sorin Marian Nasoi <email address hidden> on 2012-03-07

- fixed the test 'moduleDocumentation': all modules that appear in ZorbaManifest.xml are checked for correct XQDoc documentation
- re-enabled the 'moduleDocumentation' test that was previously disabled. Approved: Sorin Marian Nasoi, Chris Hillery

10708. By Markos Zaharioudakis on 2012-03-07

bug fixes: some methods in atomic_item.h should have been virtual + use myChild local var in children iterators" Approved: Markos Zaharioudakis

10709. By Paul J. Lucas on 2012-03-07

Added links to full-text documentation. Approved: Matthias Brantner, Paul J. Lucas

10710. By Paul J. Lucas on 2012-03-07

fix Bug #949111: getUnsignedIntValue() not implemented for Integer Approved: Matthias Brantner, Paul J. Lucas

10711. By Paul J. Lucas on 2012-03-09

Added delete theSerStream; Approved: Matthias Brantner, Paul J. Lucas

10712. By Sorin Marian Nasoi <email address hidden> on 2012-03-09

Fix for bug lp:948712: Added a way for easy copy&paste of the import schema statements. Approved: Matthias Brantner, Sorin Marian Nasoi

10713. By Matthias Brantner on 2012-03-09

StaticCollectionManager::declaredIndexes() doesn't return temporary indexes anymore. Also isDeclaredIndex also doesn't return true if asked whether a temporary index is declared. Approved: Till Westmann, Matthias Brantner

10714. By Matthias Brantner on 2012-03-09

- fix bug #938934 "collection dml:truncate function missing"
- fixes documentation bug: raise zerr:ZDDY0003 instead of zerr:ZDDY0009 Approved: Till Westmann, Markos Zaharioudakis, Matthias Brantner

10715. By Matthias Brantner on 2012-03-11

fixed bug #951772 Comment node crashes serialization) Approved: William Candillon, Matthias Brantner

10716. By Matthias Brantner on 2012-03-12

Fixed bug #952829 (Nondeterministic annotation doesn't seem to be checked) Approved: Matthias Brantner, William Candillon

10717. By Rodolfo Ochoa on 2012-03-12

This fixes the error:
n strings remain in the pool.
and change it to a more comprehensive error with reference to document that helps to prevent the error. Approved: Matthias Brantner, Markos Zaharioudakis, Cezar Andrei

10718. By Markos Zaharioudakis on 2012-03-13

Fixed bug #948259 Approved: Markos Zaharioudakis

10719. By Ghislain Fourny on 2012-03-13

Introduced function OrdPathNode::getDescendantNodeByOrdPath (from Sausalito). Approved: Markos Zaharioudakis, Matthias Brantner

10720. By Matthias Brantner on 2012-03-14

2.2 release preparations Approved: Chris Hillery, Matthias Brantner

10721. By Rodolfo Ochoa on 2012-03-14

- Fixed bug for PHP wrapper pointing to a wrong DLL name
- Fixed precompiled headers bug
- Fixed warning -> Conversion Int to Bool - Performance warning Approved: Cezar Andrei, William Candillon, Matthias Brantner

10722. By William Candillon on 2012-03-15

Minor update of the PHP example page.

Unmerged revisions

=== modified file 'ChangeLog'
--- ChangeLog	2012-01-11 17:30:25 +0000
+++ ChangeLog	2012-01-17 13:34:25 +0000
@@ -20,6 +20,7 @@
   * Added split function to the string module that allows for streamable tokenization but doesn't have regular expression
     support.
   * zerr is not predeclared anymore to be http://www.zorba-xquery.com/errors
+  * Add new XQuery interface for the PHP bindings.
   * Added API method Item::getNamespaceBindings().
 
 version 2.1

=== modified file 'doc/php/CMakeLists.txt'
--- doc/php/CMakeLists.txt	2011-06-20 12:44:21 +0000
+++ doc/php/CMakeLists.txt	2012-01-17 13:34:25 +0000
@@ -1,4 +1,4 @@
-# Copyright 2006-2008 The FLWOR Foundation.
+# Copyright 2006-2012 The FLWOR Foundation.
 # 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

=== modified file 'doc/php/examples/CMakeLists.txt'
--- doc/php/examples/CMakeLists.txt	2011-08-19 00:03:31 +0000
+++ doc/php/examples/CMakeLists.txt	2012-01-17 13:34:25 +0000
@@ -1,4 +1,4 @@
-# Copyright 2006-2008 The FLWOR Foundation.
+# Copyright 2006-2012 The FLWOR Foundation.
 # 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -20,14 +20,21 @@
   MESSAGE(STATUS "PHP Path:" ${phpPath})
   SET(phpExtensionPath ${CMAKE_BINARY_DIR}/swig/php)
   MESSAGE(STATUS "PHP Extension Path: " ${phpExtensionPath})
+  SET(phpIncludePath ${CMAKE_BINARY_DIR}/swig/php)
+  MESSAGE(STATUS "PHP Include Path: " ${phpExtensionPath})
   CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/php.ini.in ${CMAKE_CURRENT_BINARY_DIR}/php.ini)
   MESSAGE(STATUS "Configuration file: " ${CMAKE_CURRENT_BINARY_DIR}/php.ini)
   CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/simple.php.in ${CMAKE_CURRENT_BINARY_DIR}/simple.php)
   MESSAGE(STATUS "Simple configuration file: " ${CMAKE_CURRENT_BINARY_DIR}/simple.php)
-  ADD_TEST("php" ${PHP5_EXECUTABLE} -c ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_BINARY_DIR}/simple.php)
+  CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/test.php.in ${CMAKE_CURRENT_BINARY_DIR}/test.php)
+  MESSAGE(STATUS "PHP test  file configured: " ${CMAKE_CURRENT_BINARY_DIR}/test.php)
+  ADD_TEST("php1" ${PHP5_EXECUTABLE} -c ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_BINARY_DIR}/simple.php)
   MESSAGE(STATUS "Installing: " ${CMAKE_CURRENT_BINARY_DIR}/simple.php)
-  
-  INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/simple.php
+  ADD_TEST("php2" ${PHP5_EXECUTABLE} -c ${CMAKE_CURRENT_BINARY_DIR} ${CMAKE_CURRENT_BINARY_DIR}/test.php)
+  MESSAGE(STATUS "Installing: " ${CMAKE_CURRENT_BINARY_DIR}/test.php)
+  
+  
+  INSTALL(FILES ${CMAKE_CURRENT_BINARY_DIR}/simple.php ${CMAKE_CURRENT_BINARY_DIR}/test.php
           COMPONENT "php_examples"
           DESTINATION
           share/doc/zorba-${ZORBA_MAJOR_NUMBER}.${ZORBA_MINOR_NUMBER}.${ZORBA_PATCH_NUMBER}/php/examples)

=== modified file 'doc/php/examples/php.ini.in'
--- doc/php/examples/php.ini.in	2009-10-30 16:34:37 +0000
+++ doc/php/examples/php.ini.in	2012-01-17 13:34:25 +0000
@@ -1,2 +1,3 @@
 enable_dl=On
 extension_dir=@phpExtensionPath@
+include_path=".:@phpIncludePath@"
\ No newline at end of file

=== modified file 'doc/php/examples/simple.php.in'
--- doc/php/examples/simple.php.in	2011-08-04 02:14:56 +0000
+++ doc/php/examples/simple.php.in	2012-01-17 13:34:25 +0000
@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2006-2008 The FLWOR Foundation.
+ * Copyright 2006-2012 The FLWOR Foundation.
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-require '@phpPath@/zorba_api_wrapper.php';
+require '@phpPath@/Zorba/zorba_api_wrapper.php';
 
 function example_1(Zorba $aZorba)
 {

=== added file 'doc/php/examples/test.php.in'
--- doc/php/examples/test.php.in	1970-01-01 00:00:00 +0000
+++ doc/php/examples/test.php.in	2012-01-17 13:34:25 +0000
@@ -0,0 +1,120 @@
+<?php
+/*
+ * Copyright 2006-2012 The FLWOR Foundation.
+ * 
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * 
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * 
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+require '@phpPath@/Zorba/XQueryProcessor.php';
+
+function omitXMLDecl($xml)
+{
+  $xml = str_replace('<?xml version="1.0" encoding="UTF-8"?>', '', $xml);
+  $xml = trim($xml);
+  return $xml;
+}
+
+function assertEquality($test, $reference, $label)
+{
+  $test = omitXMLDecl($test);
+  echo "=====================================\n";
+  var_dump($test);
+  var_dump($reference);
+  if($test != $reference) {
+    throw new Exception(
+       "Test "
+     . $label
+     . " failed. Result:\n"
+     . $test
+     . "\nDoesn't match reference:\n"
+     . $reference
+    );
+  }
+}
+/* Test 1 */
+$xquery = new XQueryProcessor();
+$xquery->importQuery('1+1');
+$result = $xquery->execute();
+assertEquality($result, '2', "1+1");
+
+/* Test 2 */
+$query = <<<'XQ'
+declare variable $foo as xs:string external;
+declare variable $bar as xs:integer external;
+declare variable $doc1 as document-node() external;
+declare variable $doc2-str as xs:string external;
+declare variable $doc2 as document-node() := parse-xml($doc2-str);
+
+$foo, $bar, $doc1 , $doc2
+XQ;
+
+$xquery->importQuery($query);
+
+$xquery->setVariable("foo", "bar");
+$xquery->setVariable("bar", 3);
+
+$doc = simplexml_load_string('<root />');
+$xquery->setVariable("doc1", $doc);
+
+$doc = "<root />";
+$xquery->setVariable("doc2-str", $doc);
+
+$result = trim($xquery->execute());
+assertEquality($result,  "bar 3<root/><root/>", "Test PHP Types Mapping");
+
+/* Test 3 */
+$xquery->importQuery("(1, 2, <foo bar='bar' />)");
+$it = $xquery->getIterator();
+
+foreach($it as $pos => $value) {
+  switch($pos) {
+    case 0:
+      assertEquality($value, "1", "Consume the item at position {$pos}");
+    break;
+    case 1:
+      assertEquality($value, "2", "Consume the item at position {$pos}");
+    break;
+    case 3:
+      assertEquality($value, '<foo bar="bar"/>', "Consume the item at position {$pos}");
+    break;
+  }
+}
+
+//Let's do it again by leveraging the SPL IteratorAggregate
+foreach($xquery as $pos => $value) {
+  switch($pos) {
+    case 0:
+      assertEquality($value, "1", "Consume the item at position {$pos}");
+    break;
+    case 1:
+      assertEquality($value, "2", "Consume the item at position {$pos}");
+    break;
+    case 3:
+      assertEquality($value, '<foo bar="bar"/>', "Consume the item at position {$pos}");
+    break;
+  }
+}
+
+//Try the same query with execute
+$result = $xquery->execute();
+assertEquality($result, "1 2<foo bar=\"bar\"/>", "Execute To URI");
+
+/* Test 4 */
+$xquery->importQueryFromURI("@phpPath@/test.xq");
+$result = $xquery->execute();
+assertEquality($result, "2", "Test importQueryFromURI");
+
+/* Test 5 */
+//$xquery->importQueryFromURI("http://zorba.s3.amazonaws.com/test.xq");
+//$result = $xquery->execute();
+//assertEquality($result, "2", "Test importQueryFromURI");
+?>

=== modified file 'doc/php/examples/zorba_api.php'
--- doc/php/examples/zorba_api.php	2010-01-27 13:25:24 +0000
+++ doc/php/examples/zorba_api.php	2012-01-17 13:34:25 +0000
@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2006-2008 The FLWOR Foundation.
+ * Copyright 2006-2012 The FLWOR Foundation.
  * 
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

=== modified file 'swig/php/CMakeLists.txt'
--- swig/php/CMakeLists.txt	2011-12-21 14:40:33 +0000
+++ swig/php/CMakeLists.txt	2012-01-17 13:34:25 +0000
@@ -1,4 +1,4 @@
-# Copyright 2006-2008 The FLWOR Foundation.
+# Copyright 2006-2012 The FLWOR Foundation.
 # 
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -38,6 +38,9 @@
     SWIG_LINK_LIBRARIES (zorba_api ${PHP5_LIBRARY})
   ENDIF (WIN32)
 
+  #Copy test to the build folder
+  CONFIGURE_FILE("${CMAKE_CURRENT_SOURCE_DIR}/test.xq" "${CMAKE_CURRENT_BINARY_DIR}/test.xq")
+
   CONFIGURE_FILE("${CMAKE_CURRENT_SOURCE_DIR}/../StaticContext.h" "${CMAKE_CURRENT_BINARY_DIR}/StaticContext.h")
   CONFIGURE_FILE("${CMAKE_CURRENT_SOURCE_DIR}/../ItemFactory.h" "${CMAKE_CURRENT_BINARY_DIR}/ItemFactory.h")
 
@@ -55,20 +58,23 @@
 
     INSTALL (
       FILES
-        ${CMAKE_CURRENT_BINARY_DIR}/zorba_api_wrapper.php
+        ${CMAKE_CURRENT_BINARY_DIR}/Zorba/XQueryProcessor.php
+        ${CMAKE_CURRENT_BINARY_DIR}/Zorba/zorba_api_wrapper.php
         ${CMAKE_CURRENT_BINARY_DIR}/${ZORBA_SWIG_LIB_PREFIX}zorba_api.so
       DESTINATION ${PHP5_INSTALL_PATH}
     )
 	ELSE (NOT WIN32 OR CYGWIN)
     IF (MSVC_IDE)
       INSTALL ( FILES 
-        ${CMAKE_CURRENT_BINARY_DIR}/zorba_api.php
+        ${CMAKE_CURRENT_BINARY_DIR}/Zorba/XQueryProcessor.php
+        ${CMAKE_CURRENT_BINARY_DIR}/Zorba/zorba_api_wrapper.php
         ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_BUILD_TYPE}/zorba_api.dll
         COMPONENT "php_swig"
         DESTINATION share/php )
     ELSE (MSVC_IDE)
       INSTALL ( FILES 
-        ${CMAKE_CURRENT_BINARY_DIR}/zorba_api.php
+        ${CMAKE_CURRENT_BINARY_DIR}/Zorba/XQueryProcessor.php
+        ${CMAKE_CURRENT_BINARY_DIR}/Zorba/zorba_api_wrapper.php
         ${CMAKE_CURRENT_BINARY_DIR}/php_zorba_api.dll
         COMPONENT "php_swig"
         DESTINATION share/php )
@@ -77,6 +83,7 @@
 
   ### Start PHP proxy generation
   # Configure the test file
+  SET (phpLibPrefix ${ZORBA_SWIG_LIB_PREFIX})
   SET (phpAPIPath ${CMAKE_CURRENT_BINARY_DIR})
   SET (phpLibPrefix ${ZORBA_SWIG_LIB_PREFIX})
   CONFIGURE_FILE (
@@ -84,8 +91,13 @@
     ${CMAKE_CURRENT_BINARY_DIR}/generate_proxy.php
   )
 
+  CONFIGURE_FILE (
+    ${CMAKE_CURRENT_SOURCE_DIR}/XQueryProcessor.php
+    ${CMAKE_CURRENT_BINARY_DIR}/Zorba/XQueryProcessor.php
+  )
+
   ADD_CUSTOM_COMMAND (
-    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/zorba_api_wrapper.php
+    OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/Zorba/zorba_api_wrapper.php
     # the following addes a dependency to the *.cxx file that is generated by swig
     DEPENDS ${swig_generated_file_fullname}
     DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/generate_proxy.php.in
@@ -94,7 +106,8 @@
   )
   ADD_CUSTOM_TARGET (
     Api_PHP_Wrapper ALL
-    DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/zorba_api_wrapper.php
+    DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/Zorba/zorba_api_wrapper.php
+    DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/Zorba/XQueryProcessor.php
   )
   ### End PHP proxy generation
 

=== added file 'swig/php/XQueryProcessor.php'
--- swig/php/XQueryProcessor.php	1970-01-01 00:00:00 +0000
+++ swig/php/XQueryProcessor.php	2012-01-17 13:34:25 +0000
@@ -0,0 +1,397 @@
+<?php
+require_once 'Zorba/zorba_api_wrapper.php';
+
+class XQueryCompilerException extends Exception{}
+class XQueryProcessorException extends Exception{}
+
+/**
+ * Iterate over a sequence of XQuery items.
+ * This class implements the SPL Iterator interface.
+ *
+ * The following code snippet iterates over a small sequence of items.
+ * <code>
+ * <?php
+ * require_once 'Zorba/XQueryProcessor.php';
+ *
+ * $xquery = new XQueryProcessor();
+ * $xquery->importQuery('(1, 2, 3)');
+ * 
+ * $iterator = $xquery->getIterator();
+ * foreach($it as $key => $value) {
+ *   echo $value."\n";
+ * }
+ * ?>
+ * </code>
+ */
+class XQueryIterator implements Iterator {
+
+  private $xquery   = null;
+  private $iterator = null;
+  private $item     = null;
+  private $position = 0;
+  private $valid    = false;
+  
+  /**
+   * XQueryIterator constructor.
+   * This constructor is used internally only.
+   * 
+   * @param XQuery XQuery object.
+   *
+   * @see XQueryProcessor::getIterator()
+   */
+  public function __construct(XQuery $xquery)
+  {
+    $this->xquery = $xquery;
+    $this->item = Item::createEmptyItem();
+  }
+
+ 
+  public function __destruct()
+  {
+    $this->xquery->destroy();
+  }
+  
+  /**
+   * Rewinds back to the first item of the Iterator.
+   */
+  public function rewind()
+  {
+    if ($this->iterator != null) {
+      $this->iterator->close();
+      $this->iterator->destroy();
+    }
+    
+    $this->position = 0;
+    $this->iterator = $this->xquery->iterator(); 
+    $this->iterator->open();
+    $this->valid    = $this->iterator->next($this->item);
+  }
+
+  /**
+   * Return the current item serialized as string.
+   *
+   * @return string The current item serialized as string.
+   *
+   */
+  public function current()
+  {
+    return $this->item->serialize();
+  }
+
+  /**
+   * Return the position of current item.
+   *
+   * @return interger the position of the current item.
+   */
+  public function key()
+  {
+    return $this->position;
+  }
+
+  /**
+   * Move forward to the next item
+   *
+   */
+  public function next()
+  {
+    ++$this->position;
+    $this->valid = $this->iterator->next($this->item);
+  }
+
+  /**
+   * Checks if there are still items to process.
+   *
+   * @return boolean Returns true if the iterator has still items to process or false otherwise.
+   */
+  public function valid()
+  {
+    return $this->valid;
+  }
+}
+
+/**
+ * The XQueryProcessor class allows to invoke the
+ * <a href="http://www.zorba-xquery.com">Zorba XQuery Processor</a>.  
+ *
+ * Instructions to install the extension can be found at <a href="http://www.zorba-xquery.com/site2/html/php.html">http://www.zorba-xquery.com/site2/html/php.html</a>.
+ *
+ * The following code snippet executes a small <em>Hello World</em> program:
+ * <code>
+ * <?php
+ * require_once 'ZorbaXQueryProcessor.php';
+ *
+ * $xquery = new XQueryProcessor();
+ *
+ * $query = <<<'XQ'
+ * declare variable $name external;
+ *
+ * <h1>Hello {$name}</h1>
+ * XQ;
+ *
+ * $xquery->importQuery($query);
+ *
+ * $xquery->setVariable('name', 'World');
+ *
+ * echo $xquery->execute();
+ * ?>
+ * </code>
+ */
+class XQueryProcessor implements IteratorAggregate {
+
+  private $store = null;
+  private $zorba = null;
+  private $query = null;
+  private $variables = array();
+
+  /**
+   * Creates an XQueryProcessor instance.
+   */
+  public function __construct(){
+    $this->store = InMemoryStore::getInstance();
+    $this->zorba = Zorba::getInstance($this->store);
+  }
+
+  /**
+   * Shuts down the XQueryProcessor instance.
+   */
+  public function __destruct() {
+    $this->zorba->shutdown();
+    InMemoryStore::shutdown($this->store);
+  }
+
+  /**
+   * Import a query to execute.
+   * For instance, the following code snippets imports and executes the query '1+1':
+   * <code>
+   * $xquery = new ZorbaXQueryProcessor();
+   *
+   * $xquery->importQuery('1+1');
+   * 
+   * echo $xquery->execute() . '\n';
+   * </code>
+   * The following code snippets imports and executes an <em>Hello World</em> query:
+   * <code>
+   * <?php
+   * $xquery = new XQueryProcessor();
+   *
+   * $query = <<<'XQ'
+   * let $world := 'World'
+   * return <h1>Hello {$world}</h1>
+   * XQ;
+   *
+   * $xquery->importQuery($query);
+   *
+   * echo $xquery->execute() . '\n';
+   * ?>
+   * </code>
+   *  
+   * @param $query Query to execute.
+   * @return ZorbaXQueryProcessor instance.
+   */ 
+  public function importQuery($query) {
+    if(!is_string($query)) {
+      throw new XQueryProcessorException('The query parameter must be a string. For instance: XQueryProcessor->importQuery("1+1")');
+    }
+    $this->query = $query;
+    return $this;
+  }
+
+  /**
+   * Import a query to execute from a file with the given name.
+   * For instance, the following code snippet imports the query file named <em>hello_word.xq</em>:
+   * <code>
+   * $xquery = new ZorbaXQueryProcessor();
+   *
+   * $xquery->importQueryFromURI('hello_world.xq');
+   * 
+   * echo $xquery->execute() . '\n';
+   * </code>
+   *
+   * @param  $filename Filename containing the query to execute.
+   * @return ZorbaXQueryProcessor instance.
+   */
+  public function importQueryFromURI($filename) {
+    $ctx = null;
+    if(func_num_args() == 2) {
+      $ctx = func_get_arg(1);
+    }
+    $query = file_get_contents($filename, FILE_USE_INCLUDE_PATH, $ctx);
+    $this->importQuery($query);
+    return $this;
+  }
+
+  /**
+   * Set a value for an external variable.
+   *
+   * The following code snippet sets the value of the variable
+   * <em>$i</em> with <em>1</em> with type xs:integer.
+   * <code>
+   * $xquery = new ZorbaXQueryProcessor();
+   * 
+   * $query = <<<'XQ'
+   * declare variable $i as xs:integer external;
+   *
+   * $i + 1
+   * 'XQ';
+   *
+   * $xquery->importQuery($query);
+   * $xquery->setVariable($i, 1);
+   *
+   * echo $xquery->execute() . '\n';
+   * </code>
+   *
+   * The following code snippet sets the value of the variable <em>$i</em> in
+   * the local namespace to the value <em>1</em>.
+   * <code>
+   * $xquery = new ZorbaXQueryProcessor();
+   * 
+   * $query = <<<'XQ'
+   * declare variable $local:i as xs:integer external;
+   *
+   * $i + 1
+   * 'XQ';
+   *
+   * $xquery->importQuery($query);
+   * $xquery->setVariable("http://www.w3.org/2005/xquery-local-functions", $i, 1);
+   *
+   * echo $xquery->execute() . '\n';
+   * </code>
+   *
+   * PHP types are converted to the following XML types:
+   * - <b>DOMDocument</b> & <b>SimpleXMLElement</b>: document-node()
+   * - <b>string</b>: xs:string
+   * - <b>float</b>: xs:float
+   * - <b>long</b>: xs:long
+   * - <b>integer</b>: xs:integer
+   * - <b>boolean</b>: xs:boolean
+   * - <b>DOMDocument</b>: document-node()    
+   * 
+   * @param string $namespace optional Namespace URI of the external variable.
+   * @param string $name Local name of the external variable.
+   * @param mixed  $value of the external variable.
+   *
+   * return ZorbaXQueryProcessor instance. 
+   */
+  public function setVariable($arg1, $arg2) {
+    $count = func_num_args();
+    if($count == 2) {
+      $name  = func_get_arg(0);
+      $value = func_get_arg(1);
+      $this->variables['_'][$name] = $value;
+    } else {
+      $ns  = func_get_arg(0);
+      $name  = func_get_arg(1);
+      $value = func_get_arg(2);
+      $this->variables[$ns][$name] = $value;
+    }
+    return $this;
+  } 
+  
+  /**
+   * Execute the Query.
+   *
+   * @return Query result.
+   */
+  public function execute() {
+    //Execute
+    $query = $this->compile();
+    $result = $query->execute();
+    $query->destroy();
+    return $result;
+  }
+
+  /**
+   * Provide an intance of the SPL iterator to iterator over the 
+   * sequence of items produced by the query result.
+   *
+   * @return XQueryIterator
+   */
+  public function getIterator() {
+    return new XQueryIterator($this->compile());
+  }
+
+  /**
+   * Internal method that creates an instance of the
+   * XQuery class from the input parameters (importQuery and setVariable).
+   *
+   * @return XQuery compiled query.
+   */
+  private function compile()
+  {
+    //You need at least to import a query in order to compile it.
+    if(!is_string($this->query)) {
+      throw new XQueryCompilerException('No Query Imported. Use XQueryProcessor->importQuery($query).');
+    }
+    
+    //Compile Query
+    $query = $this->zorba->compileQuery($this->query);
+    
+    //Set Variables
+    $dctx = $query->getDynamicContext();
+    foreach($this->variables as $ns => $variables){
+      foreach($variables as $name => $value) {
+        if($ns == "_") $ns = "";
+        $param = $this->zorba->compileQuery(".");
+        $value = $this->getItem($value);
+        $param->getDynamicContext()->setContextItem($value);
+        $dctx->setVariable($ns, $name, $param->iterator());
+      }
+    }
+    //Returns an instance of the XQuery class
+    return $query;
+  }
+
+  /**
+   * Converts a PHP value to an XQuery Item.
+   * The mapping between PHP and XQuery types in {@link setVariable}.
+   * 
+   * @see setVariable()
+   */  
+  private function getItem($value) {
+    $itemFactory = $this->zorba->getItemFactory();
+
+    if($value instanceof DOMDocument or $value instanceof SimpleXMLElement) { 
+      $value = $this->parseXML($value->saveXML());
+    } else if(is_string($value)) {
+      $value = $itemFactory->createString($value);
+    } else if(is_int($value)) {
+      $value = $itemFactory->createInteger($value);
+    } else if(is_bool($value)) {
+      $value = $itemFactory->createBoolean($value);
+    } else if(is_float($value)) {
+      $value = $itemFactory->createFloat($value);
+    } else if(is_long($value)) {
+      $value = $itemFactory->createLong($value);
+    } else {
+      throw new XQueryCompilerException("Unsupported variable type: ".gettype($value));
+    }
+
+    assert($value instanceof Item);
+
+    return $value;
+  }
+
+  /**
+   * Parse an XML string to an XQuery Item.
+   * This function is used internally only. 
+   * @param $xml string XML string to parse.
+   *
+   * @return Item instance.
+   */
+  private function parseXML($xml)
+  {
+    $lDataManager = $this->zorba->getXmlDataManager();
+    $lDocMgr = $lDataManager->getDocumentManager();
+    $iter = $lDataManager->parseXML($xml);
+    
+    $iter->open();
+    $doc = Item::createEmptyItem();
+    
+    $iter->next($doc);
+    $iter->close();
+    $iter->destroy();
+    
+    return $doc;  
+  }
+}
+?>

=== modified file 'swig/php/generate_proxy.php.in'
--- swig/php/generate_proxy.php.in	2011-12-21 14:40:33 +0000
+++ swig/php/generate_proxy.php.in	2012-01-17 13:34:25 +0000
@@ -164,7 +164,7 @@
 	}
 }
 
-file_put_contents('zorba_api_wrapper.php', $wrapper);
+file_put_contents('Zorba/zorba_api_wrapper.php', $wrapper);
 
 function getRefParameters(ReflectionMethod $method, array $params) {
 	$result = "";

=== added file 'swig/php/test.xq'
--- swig/php/test.xq	1970-01-01 00:00:00 +0000
+++ swig/php/test.xq	2012-01-17 13:34:25 +0000
@@ -0,0 +1,1 @@
+1+1

=== modified file 'swig/php/zorba_api.i'
--- swig/php/zorba_api.i	2011-10-12 20:56:27 +0000
+++ swig/php/zorba_api.i	2012-01-17 13:34:25 +0000
@@ -1,5 +1,5 @@
 /*
- * Copyright 2006-2008 The FLWOR Foundation.
+ * Copyright 2006-2012 The FLWOR Foundation.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.