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

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
Updating Concrete Themes from Version 8 to Version 9
Nov 24, 2022

This tutorial covers commonly encountered issues when upgrading a Concrete CMS theme from version 8 to version 9

Transferring ownership of an add-on and a theme
Nov 15, 2022
By katzueno.

If you encounter a Concrete CMS add-on or theme that you love but not being maintained, you may want to ask the author to help or take over the add-on or theme. Here is the quick step-by-step guide of how to transfer the ownership.

How to update Add-Ons if not on the Update Add-Ons Menu item
Jul 4, 2022

How to manually download an add-on and update it when your site's core versions isn't considered compatible with the add-on version.

Generate a report with author information and form summaries in Concrete CMS.
May 9, 2022

In Concrete CMS, you can use a form to initiate contact between logged-in users and then create helpful reports. After form submissions are collected, they can be searched, sorted, and exported as a spreadsheet. This tutorial will detail how to add author information to a report using the advanced search.

How to clone and customize Atomik theme
Feb 14, 2022
By linuxoid.

How to clone and customize Atomik theme

Update jQuery to 3.5 on Concrete CMS version 8.5.x
Dec 1, 2021
By hissy.

If you have to take some time to fix your site to work with version 9 and want to update jQuery immediately, you can override it.

Was this information useful?
Thank you for your feedback.