PHP download

Download the PHP package aliirfaan/citronel-external-service without Composer

On this page you can find all versions of the php package aliirfaan/citronel-external-service. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download aliirfaan/citronel-external-service
More information about aliirfaan/citronel-external-service
Files in aliirfaan/citronel-external-service

Vendor aliirfaan
Package citronel-external-service
Short Description Consume external APIs using a standard interface using Laravel http client. Log requests and responses for API calls in database and log file for auditing/debugging purposes.
License MIT

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 aliirfaan/citronel-external-service

Informations about the package citronel-external-service

Citronel external service

Consume external APIs using a standard interface.

Features

Contract class to consume external APIs.
Takes configuration from a configuration file that follows a standard format.
Helper function for caching responses.
Helper classes for events and subscribers.
You can use aliirfaan/citronel-external-service-generator package as dev dependency to generate config file, service class, migrations, models, events, listeners for your external service.

Requirements

Installation

Install the package using composer:
Install the package with dev dependency:

Contracts

AbstractExternalService.php
Your main service class must extend this abstract class.

Traits

ExternalServiceLogTrait
Use this trait if we want to log request and responses for external services
ExternalServiceEventTrait
Use this trait in your event class
ExternalServiceEventSubscriberTrait
Use this trait in your subscriber class

Steps

Create a configuration file with proper values for your external service that follows the format expected by the AbstractExternalService.
Create your service class and extend AbstractExternalService.
Use ExternalServiceLogTrait if you want to log requests and responses. This trait expects events, listeners and models to exist for the external service.
Use ExternalServiceCacheTrait if you want to cache requests and responses.

Usage

An example of how to consume an example external service httpbin.

Configuration

app/config/http-bin.config

Service class

All versions of citronel-external-service with dependencies

PHP Build Version

Package Version

Version 1.0.1 Release 07. Apr 2025
create-project require 0 people chose require and
0 people chose create-project.

Download

Download latest version of citronel-external-service from vendor aliirfaan

Requires php Version >=8.0.0

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 aliirfaan/citronel-external-service contains the following files

Loading the files please wait ...