PHPackages                             lyquidity/xbrl-tests - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Testing &amp; Quality](/categories/testing)
4. /
5. lyquidity/xbrl-tests

ActiveLibrary[Testing &amp; Quality](/categories/testing)

lyquidity/xbrl-tests
====================

Provides a harness to run the conformance suite tests for XBRL 2.1, XDT, XFI and Formulas using the XBRLlibrary for PHP

2141PHP

Since Oct 26Pushed 4y ago1 watchersCompare

[ Source](https://github.com/bseddon/XBRL-tests)[ Packagist](https://packagist.org/packages/lyquidity/xbrl-tests)[ RSS](/packages/lyquidity-xbrl-tests/feed)WikiDiscussions develop Synced today

READMEChangelogDependenciesVersions (2)Used By (0)

Conformance testing for the Lyquidity XBRL project
==================================================

[](#conformance-testing-for-the-lyquidity-xbrl-project)

**Table of contents**

- [About the project](#about-the-project)
- [Status](#status)
- [License](#license)
- [Contributing](#contributing)
- [Install](#install)
- [Getting started](#getting-started)

About the project
-----------------

[](#about-the-project)

This project provides a test harness to run the conformance suite test defined for XBRL 2.1, XDT, Formulas and Function Registry functions

### Test harness notes

[](#test-harness-notes)

#### XBRL 2.1

[](#xbrl-21)

A small number of the tests are not used. The XBRL processor only has incomplete support for reference link bases so tests using or relating to reference links are not run for any of the conformance suites. These tests include tests 291 V-12, V-13, V-14 and V-15

#### Formulas

[](#formulas)

The formula processor does support some of the specifications that do not yet have a recommended status such as [Formula Tuples](http://www.xbrl.org/Specification/formulaTuples/CR-2011-11-30/formulaTuples-CR-2011-11-30.html)and [Vaiables Scope](http://www.xbrl.org/Specification/variables-scope/CR-2011-11-30/variables-scope-CR-2011-11-30.html). However it does not support the [Variable Instances for Multi-Instance Processing and Chaining](http://www.xbrl.org/specification/instances/cr-2012-10-03/instances-cr-2012-10-03.html) specifications.

This means the XBRL Formula processor test harness will not include tests in the groups 60300 (Instances processing) and 60400 (Instances chaining processing).

### Links

[](#links)

This project does not include the conformance suite tests. The relevant suite files can be downloaded:

- [XBRL-CONF-2014-12-10.zip](http://www.xbrl.org/2014/XBRL-CONF-2014-12-10.zip)
- [XDT-CONF-CR4-2009-10-06.zip](http://www.xbrl.org/2009/xdt-conf-cr4-2009-10-06.zip)
- [FORMULA-CONF-REC-2013-09-12.zip](http://www.xbrl.org/specification/formula/rec-2011-10-24/conformance/formula-conf-rec-2013-09-12.zip)

Status
------

[](#status)

[![XBRL 2.1 conformance](https://camo.githubusercontent.com/eb57d1d19b42ae378144cdb478d65727cd40fc97db82630e5a351fb873a309b0/68747470733a2f2f7777772e7862726c71756572792e636f6d2f74657374732f7374617475732e7068703f746573743d636f6e666f726d616e63655f323126783d79 "XBRL 2.1 conformance suite tests")](https://camo.githubusercontent.com/eb57d1d19b42ae378144cdb478d65727cd40fc97db82630e5a351fb873a309b0/68747470733a2f2f7777772e7862726c71756572792e636f6d2f74657374732f7374617475732e7068703f746573743d636f6e666f726d616e63655f323126783d79)[![XBRL dimensions conformance](https://camo.githubusercontent.com/a8dad43f6250adc9f7d6ba8abd9037f4359a2b9f1b55e5b9e644e2daf2d7afd7/68747470733a2f2f7777772e7862726c71756572792e636f6d2f74657374732f7374617475732e7068703f746573743d636f6e666f726d616e63655f78647426783d79 "XBRL Dimensions conformance suite tests")](https://camo.githubusercontent.com/a8dad43f6250adc9f7d6ba8abd9037f4359a2b9f1b55e5b9e644e2daf2d7afd7/68747470733a2f2f7777772e7862726c71756572792e636f6d2f74657374732f7374617475732e7068703f746573743d636f6e666f726d616e63655f78647426783d79)[![XBRL functions registry conformance](https://camo.githubusercontent.com/8fc5a531bfdbb97b4b11471e06c205a575b858347c6dd81e4c459e0c3e2ff54b/68747470733a2f2f7777772e7862726c71756572792e636f6d2f74657374732f7374617475732e7068703f746573743d636f6e666f726d616e63655f66756e6374696f6e7326783d79 "XBRL functions registry conformance suite tests")](https://camo.githubusercontent.com/8fc5a531bfdbb97b4b11471e06c205a575b858347c6dd81e4c459e0c3e2ff54b/68747470733a2f2f7777772e7862726c71756572792e636f6d2f74657374732f7374617475732e7068703f746573743d636f6e666f726d616e63655f66756e6374696f6e7326783d79)[![XBRL Formulas conformance](https://camo.githubusercontent.com/8aeaa309b9df6e986b2f990d5179769f1dd39381047a327ad43b1e4c30bd364f/68747470733a2f2f7777772e7862726c71756572792e636f6d2f74657374732f7374617475732e7068703f746573743d636f6e666f726d616e63655f666f726d756c617326783d79 "XBRL Formulas conformance suite tests")](https://camo.githubusercontent.com/8aeaa309b9df6e986b2f990d5179769f1dd39381047a327ad43b1e4c30bd364f/68747470733a2f2f7777772e7862726c71756572792e636f6d2f74657374732f7374617475732e7068703f746573743d636f6e666f726d616e63655f666f726d756c617326783d79)

[![Build status last run date](https://camo.githubusercontent.com/66c5b1c9f896c82905ab3f1251c9d225b1f0d5ed0d293ac7f3e8e90a2458e3ad/68747470733a2f2f7777772e7862726c71756572792e636f6d2f74657374732f7374617475732e7068703f746573743d64617465 "The date of the last run")](https://camo.githubusercontent.com/66c5b1c9f896c82905ab3f1251c9d225b1f0d5ed0d293ac7f3e8e90a2458e3ad/68747470733a2f2f7777772e7862726c71756572792e636f6d2f74657374732f7374617475732e7068703f746573743d64617465)

### Dependencies

[](#dependencies)

This project depends on [lyquidity/XPath20](https://github.com/bseddon/XPath20) and on the [lyquidity/XBRL](https://github.com/beseddon/XBRL).

License
-------

[](#license)

This project is released under [GPL version 3.0](LICENCE)

**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
------------

[](#contributing)

We welcome contributions. See our [contributions page](https://gist.github.com/bseddon/cfe04753192087c82766bee583f519aa) for more information. If you do choose to contribute we will ask you to agree to our [Contributor License Agreement (CLA)](https://gist.github.com/bseddon/cfe04753192087c82766bee583f519aa). 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](CODE_OF_CONDUCT.md).

Install
-------

[](#install)

The project can be installed by [composer](https://getcomposer.org/). First make sure the [XPath 2.0](https;//github.com/bseddon/XPath20) 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/xbrl-tests:dev-master --prefer-dist

```

Or fork or download the repository. It will also be necessary to download and install the [XML](https://github.com/bseddon/XBRL) project.

You will then need to download the test suite zip file and unzip them to some location. In your application you will also need to add defines called:

- CONFORMANCE\_TEST\_SUITE\_XBRL\_21\_LOCATION
- CONFORMANCE\_TEST\_SUITE\_FORMULA\_LOCATION
- CONFORMANCE\_TEST\_SUITE\_XDT\_LOCATION
- CONFORMANCE\_TEST\_SUITE\_XFI\_LOCATION and
- CONFORMANCE\_TEST\_SUITE\_GENERIC\_LOCATION

Give these a value which is the location you used to unzip the respective conformance test suite zip file.
See the example in the [getting started](#getting-started) section below.

Getting started
---------------

[](#getting-started)

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

```
