README

Table of contents

• About the project
• Status
• License
• Contributing
• Install
• Getting started

About the project

This project provides a test harness to run the conformance suite test defined for XPath 2.0 in XQTS 1.0.3 2010-09-17.

The XPath 2.0 library implements the XPath 2.0 specification for PHP and is able to pass the 9,000 or so XPath 2.0 conformance suite tests.

Status

The conformance suite used is XQTS 1.0.3 2010-09-17. Not all the tests defined by the suite are used because many test XQuery. Instead the tests used are the ones in the test case documents that declare an attribute @is-XPath2 with a value of 'true'. There are about 9,000 such tests.

Dependencies

This project depends on lyquidity/XPath20 and on the XQTS 1.0.3 2010-09-17 zip file.

License

This project is released under GPL version 3.0

What does this mean?

It means you can use the source code in any way you see fit. However, the source code for any changes you make must be made available to others and must be made available on the same terms as you receive the source code in this project: under a GPL v3.0 license. You must include the license of this project with any distribution of the source code whether the distribution includes all the source code or just part of it. For example, if you create a class that derives from one of the classes provided by this project - a new taxonomy class, perhaps - that is derivative.

What does this not mean?

It does not mean that any products you create that only use this source code must be released under GPL v3.0. If you create a budgeting application that uses the source code from this project to access data in instance documents, used by the budgeting application to transfer data, that is not derivative.

Contributing

We welcome contributions. See our contributions page for more information. If you do choose to contribute we will ask you to agree to our Contributor License Agreement (CLA). We will ask you to agree to the terms in the CLA to assure other users that the code they use is not going to be encumbered by a labyrinth of different license and patent liabilities. You are also urged to review our code of conduct.

Install

The project can be installed by composer. First make sure the XPath 2.0 project is installed. Assuming Composer is installed and a shortcut to the program is called 'composer' then the command to install this project is:

composer require lyquidity/xpath2-tests:dev-master --prefer-dist

Or fork or download the repository. It will also be necessary to download and install the XML project.

You will then need to download the XQTS 1.0.3 2010-09-17 zip file and unzip it to some location. In your application you will also need to add a define called 'CONFORMANCE_SUITE_BASE' and give it a value which is the location you used to unzip the conformance test suite zip file.

Getting started

Assuming you have installed the library using composer then this PHP application will run the tests:

<php
require_once __DIR__ . '/vendor/autoload.php';
define( 'CONFORMANCE_SUITE_BASE', '<your unzip location>' );
include __DIR__ . "/vendor/lyquidity/XPath2-tests/test.php";