This is a PHP Portal API Client. It enables easy communication with a CHAOS Portal API (protocol version 4).
- PHP 5.3.5+ is required.
- The CURL plugin must be enabled in PHP.
- The iconv plugun must be enables in PHP (it is by default).
The source code is located in the src folder.
The file structure matches the namesspaces used and should be preserved for easy use (see examples).
All public functions and classes have been documented in-code with PHPDoc syntax,
which should enable code completion and type hinting in most modern code IDE's.
The tutorials are located in the tutorials folder.
They can also be found online on this project's Github pages.
The examples are located in the examples folder.
By default the examples will add __dir__/../src to the include path, this will allow PHP to locate the source files from the namespace.
Make sure to update this if you move the examples before running them (see How to use PortalClient).
Make sure the CHAOS folder (located in the src folder) is copied to a location where PHP is configured to look for classes. This can be the same folder as the PHP-script that is using PortalClient, or a location added to the include path. The examples all use the latter method.
The unit tests are located in the tests folder and uses PHPUnit 3.7 by Sebastian Bergmann.
With the tests comes a handy script run-tests, located under bin , which is required to run the test suite. The tests cannot simply be run by phpunit as they rely on data from the json files.
With the script you can:
- Test different service providers (e.g. api.danskkulturarv.dk or api.chaos-systems.org)
- Test different protocol versions
- Test different methods of authentication (e.i. with an accessPointGUID or with the EmailPassword extension)
- Test different users
- Test different data sets
In tests/bin/ are different sample JSON files. Those include config files, with and without authentication, and data sets. If no data file is specified when running the script, it defaults to default_data.json.
All other arguments are passed to PHPUnit (see phpunit --help for more information).
If you want to run all tests (from the tests directory), using the CHAOS API v4 (http://api.chaos-systems.com/v4/):
bin/run-tests --config chaos.v4.auth --password secret .
or, without authentication:
bin/run-tests --config chaos.v4 .
or, different data file:
bin/run-tests --config chaos.v4 --data your_data .
To run a singe file:
bin/run-tests --config chaos.v4.auth --password secret ObjectExtension.php
To include a coverage report in the output (more information):
bin/run-tests --config chaos.v4.auth --password secret --coverage-text .
For more verbose output:
bin/run-tests --config chaos.v4.auth --password secret --verbose .
For information on how to use the script:
bin/run-tests --help
To create you own config/data file, copy one of the existing and change out the information. It might be best to have at least as many objects in each section, to avoid null pointers.
If you encounter any problems using this project, please report them using the Issues section of the projects Github page.
- Official CHAOS Community website
- This project on GitHub
- Portal project on GitHub
- TypeScript (JavaScript) client on GitHub
- .NET client on GitHub
This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
Copyright 2012 CHAOS ApS