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

  1. Install Composer.

  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.

  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.

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.

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

Recent Tutorials
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

Express Form Styling
Apr 11, 2024
By myq.

Different ways to style Express forms

Setting addon/theme version compatibility in the marketplace
Jan 9, 2024

For developers worn out with setting the latest addon or theme version manually across too many core versions, here is a JavaScript bookmarklet to do it for you.

How to get the locale of a page
Jan 8, 2024
By wtfdesign.

Now, why don't we just have a getLocale() method on Page objects beats me, but here's how you work around it

Using a Redis Server
Jun 16, 2023
By mlocati.

How to configure Concrete to use one or more Redis servers to persist the cache.


Let us know by posting here.