Download the PHP package 5pm-hdh/churchtools-api without Composer

On this page you can find all versions of the php package 5pm-hdh/churchtools-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of 5pm-hdh/churchtools-api

Informations about the package churchtools-api

ChurchTools-API Client

static-code-analysis workflow

unit-test workflow

integarion-test workflow

The ChurchTools-API Client is a PHP-based wrapper for the ChurchTools API and has been tested with ChurchTools version 3.104.3.

[!NOTE] Version 2 has been launched, featuring a restructured code base and numerous new features. If you're upgrading from version 1 to 2, please consult the Upgrade Guide.

Installation

Go to the project-root and install ChurchTools-API via composer:

Load all dependency packages into the PHP project using the following code:

Usage

Before you can start to request data from the API you need to configure the CT-Client (ChurchTools client) with the CTConfig-interface:

For more information visit the CTConfig documentation From now on all features of the ChurchTools-API are available.

Requests and Models

The whole ChurchTools-API client is build on top of the Requests and Models. Requests provide an interface to specify your api call by adding filtering, pagination and sorting. Models represent the data, that the Requests retrieve. More informations can be found in the documentation:

All APIs with examples:

The following brief examples demonstrate the capabilities of the ChurchTools-API client and provide a general overview of its potential uses:

Example: Person-API

Example: Event-API

Example: Wiki-API

Result:

Support / Contribute

We welcome your support and contributions to this project.

CTLog - Logging Request

The CTLog provides a facade to log Informations. By default it logs all important infos, warnings and errors in the log-file: churchtools-api.log. The creation of a logfile can be enabled and disabled with the method:

By default, the console will display all logs of Error, Critical, Alert, and Emergency levels. If you wish to display additional log levels on the console, you may use the CTConfig-Debug option or set it directly in the CTLog facade:

To log a message, use the getLog-method:

Further information on CTLog-Page:

Error-Handling

The API-Wrapper provides custom exceptions. More on this page: Error-Handling

Unit- and Integration-Tests

To access the unit tests, navigate to the "tests/unit" directory. You may use the standard PHPUnit\Framework\TestCase to test small sections of code, or use TestCaseHttpMocked to simulate an HTTP request.

For integration tests, requests are sent directly to a ChurchTools instance. The "integration-test-data.json" file contains all available test data scenarios. All integration tests are automatically executed via Github Actions.

Doc-Generator

The Doc-Generator parses all documentation files and runs the PHP code examples to verify their validity. For additional information, please refer to this page: Doc-Generator

License

This project is licensed under MIT-License feel free to use it or to contribute.

Showcase:

To provide you with an idea of the ChurchTools-API Client's potential uses, here are a few examples. If you're working on a project too, please consider contributing and adding it to this list:

Administration Tools:

Wordpress Plugins:

Other Applications:

All versions of churchtools-api with dependencies

PHP Build Version
Package Version
Requires guzzlehttp/guzzle Version ^7
php Version >=8.1
monolog/monolog Version ^3
doctrine/cache Version ^1.11
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package 5pm-hdh/churchtools-api contains the following files

Loading the files please wait ....