How to add a third party library to a package using Composer in 5.7

This is a community-contributed tutorial. This tutorial is over a year old and may not apply to your version of Concrete CMS.
Jun 21, 2015

Here is an example of downloading the Stripe PHP library with Composer

https://github.com/stripe/stripe-php

  1. Install Composer.
    OSX/Linux/Unix
    https://getcomposer.org/doc/00-intro.md#installation-linux-unix-osx
    Windows
    https://getcomposer.org/doc/00-intro.md#installation-windows

  2. Create a composer.json file in your package root.

  3. Open composer.json and paste this code into it to declare your dependencies. The Composer dependencies will be listed on the GitHub project site, Packagist, or main project website.

    {
        "require": {
            "stripe/stripe-php": "2.*"
        }
    }
    
  4. Run Composer to download the dependencies.
    https://getcomposer.org/doc/00-intro.md#using-composer

  5. Once Composer finishes downloading, you will see a new folder called vendor and a new file called composer.lock.

  6. In your package controller, require the Composer autoloader inside the on_start() method, using $this->getPackagePath() for the path.

    public function on_start()
    {
        require $this->getPackagePath() . '/vendor/autoload.php';
    }
    

Now you should be able to create a new Stripe\Stripe object in local scope and \Stripe\Stripe object in global scope. Optionally, Composer can be used again in the future to update the dependencies to the current version.

composer.lock
This file locks the dependencies of your project to a known state. It is a list of the exact versions of the dependencies it installed in the vendor file.

vendor
The vendor folder contains all your dependencies, an autoload.php file, and a composer folder that contains additional autoload files.

Recent Tutorials
Upgrading Concrete from 8.5 to 9.x
Jun 21, 2024
By myq.

How to avoid problems upgrading from 8.5 to 9.x

How to change the default date format
May 30, 2024
By myq.

Change the format of the default date

WebOps Tutorial on Running and Upgrading a Concrete CMS Website
May 2, 2024
By myq.

Describes how to deploy, manage, and upgrade a Concrete CMS website

Using the Concrete Migration Tool Addon
Apr 27, 2024

How to use the Concrete CMS Migration Tool

Create custom Site Health tasks
Apr 19, 2024
By myq.

This tutorial will guide you through the creation of a new Site Health task

Reusing the same Express entity in multiple associations
Apr 11, 2024
By myq.

How to create and manage multiple associations in Express

Improvements?

Let us know by posting here.