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
How to Automate the Copyright Year
Dec 27, 2024

Learn how to keep your website's copyright year updated automatically in Concrete CMS.

How to change the path of a group of pages
Dec 23, 2024
By myq.

Change the canonical path without breaking things

Bi-directional Express associations
Dec 18, 2024
By myq.

Set up associations between Express entries in both directions

Display Express Data Across Multiple Sites
Dec 17, 2024
By myq.

A guide to configuring Express entities and the Express Entry List block to ensure proper data display across multiple sites.

Customize locale icons
Oct 29, 2024
By myq.

How to customize locale (language region) flags

Concrete CMS Caching Guide
Oct 16, 2024

An overview of types of caching in Concrete and considerations when using them.

Improvements?

Let us know by posting here.