Download the PHP package openagenda/sdk-php without Composer

On this page you can find all versions of the php package openagenda/sdk-php. 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 openagenda/sdk-php

Informations about the package sdk-php

OpenAgenda PHP SDK

OpenAgendaSDK is a PHP wrapper for OpenAgenda API v2.

Prerequisites

Composer is required as well as a PHP 7.1 or higher version running on your web server. Composer installation instructions can be found at https://getcomposer.org/doc/00-intro.md#installation-linux-unix-macos.

Installation

Install OpenAgendaSdk as a dependency to your project:

Basic usage

Creating an OpenAgendaSdk instance

First create an OpenAgendaSdk instance using your OpenAgenda publicKey as parameter:

Additionally, you can set some client options such as proxy settings:

As OpenAgenda uses Guzzle Client, read its documention to learn more about request options: https://docs.guzzlephp.org/en/stable/

Requesting OpenAgenda data

OpenAgendaSdk currently comes with 3 methods to get agenda configuration, agenda events or a single agenda event. These methods return OpenAgenda API data as JSON. Decoding json or deserializing object(s) is up to you.

Get an agenda configuration

Get the event list of an agenda

You can add some parameters to your request such as filters, sort, search, pagination. Read OpenAgenda API documentation to get the full list of options: https://developers.openagenda.com/10-lecture/

Get an agenda event

Tests

Prerequisites

In order to run tests, you have to set OPENAGENDA_SDK_ENV value to 'test' in a PHP dotenv file (.env) or using command line. Methods depends on the framework you use.

PHP dotenv example:

Using command line:

Running tests

OpenAgendaSdk tests are based on JSON mocks.

Run tests:

Reset to 'default' env to get back real API data when tests are over.

OpenAgenda API documention

OpenAgenda API v2 documention is available here: https://developers.openagenda.com

All versions of sdk-php with dependencies

PHP Build Version
Package Version
Requires php Version ^7.1.10 || ^8.0
guzzlehttp/guzzle Version >=6.5
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 openagenda/sdk-php contains the following files

Loading the files please wait ....