Composer and NPM

Overview

Introduction

Composer provide two key functions for OpenEMR:

1. A command line tool for dependency management in PHP. It allows you to declare the libraries your project depends on and it will manage (install/update) them for you.
2. An autoloader of libraries including OpenEMR classes.

End Goal

1. Centralize and organize all PHP libraries/dependencies into a single directory.
   • Use Composer to collect and organize the PHP libraries/dependencies.
   • Migrate all the PHP libraries/dependencies.
2. Setup composer to use autoloading(with end goal of PSR-4).

More Details

• Composer creates a vendor directory in the root folder. This is where all the external dependencies are kept.
• Commit the vendor directory to the codebase initially until we get composer to work with demo and build scripts.

• The workaround is to add a .gitignore line that removes all .git directories within your vendor directory. So add this line to the .gitignore file at the same level as composer.json and vendor/vendor name/.git

• Get the demo and build scripts to bring in composer dependencies and package them up and test.
• Make sure documentation on how to use composer is up to date and developers are aware of upcoming changes
• Once this is done we can remove vendor directory from the codebase

Installation

Windows

This is the easiest way to get Composer set up on your machine.

The installer will download composer for you and set up your PATH environment variable so you can simply call composer from any directory. Download and run Composer-Setup.exe - it will install the latest composer version whenever it is executed. See: https://getcomposer.org/doc/00-intro.md/

To test your installation, open up your favourite Command Line Interface (CLI) and run:

composer

And you should get output similar to this:

   ______
  / ____/___  ____ ___  ____  ____  ________  _____
 / /   / __ \/ __ `__ \/ __ \/ __ \/ ___/ _ \/ ___/
/ /___/ /_/ / / / / / / /_/ / /_/ (__  )  __/ /
\____/\____/_/ /_/ /_/ .___/\____/____/\___/_/
                    /_/
Composer version 1.1.2 2016-05-31 19:48:11

Usage:
  command [options] [arguments]

Options:
  -h, --help                     Display this help message
  -q, --quiet                    Do not output any message
  -V, --version                  Display this application version
      --ansi                     Force ANSI output
      --no-ansi                  Disable ANSI output
  -n, --no-interaction           Do not ask any interactive question
      --profile                  Display timing and memory usage information
      --no-plugins               Whether to disable plugins.
  -d, --working-dir=WORKING-DIR  If specified, use the given directory as working directory.
  -v|vv|vvv, --verbose           Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Linux & MacOS

The first step is to download Composer, which will effectively create a Phar (PHP Archive) file called composer.phar. From your terminal, run the following command:

curl -sS https://getcomposer.org/installer | php

The resulting file will be called composer.phar, a PHP Archive that can be executed directly via PHP. However, in our case, we want Composer to be accessible globally by simply typing composer. To do this, move it to /usr/bin/ and create an alias:

sudo mv composer.phar /usr/local/bin/
vim ~/.bash_profile

Add this to your .bash_profile. It may be empty or non-existent, so go ahead and create it:

alias composer="php /usr/local/bin/composer.phar"

Now, relaunch your terminal and you'll be able to access Composer simply by calling composer
See: https://www.abeautifulsite.net/installing-composer-on-os-x

To test your installation, open up your favourite Command Line Interface (CLI) and run:

composer

And you should get output similar to this:

   ______
  / ____/___  ____ ___  ____  ____  ________  _____
 / /   / __ \/ __ `__ \/ __ \/ __ \/ ___/ _ \/ ___/
/ /___/ /_/ / / / / / / /_/ / /_/ (__  )  __/ /
\____/\____/_/ /_/ /_/ .___/\____/____/\___/_/
                    /_/
Composer version 1.1.2 2016-05-31 19:48:11

Usage:
  command [options] [arguments]

Options:
  -h, --help                     Display this help message
  -q, --quiet                    Do not output any message
  -V, --version                  Display this application version
      --ansi                     Force ANSI output
      --no-ansi                  Disable ANSI output
  -n, --no-interaction           Do not ask any interactive question
      --profile                  Display timing and memory usage information
      --no-plugins               Whether to disable plugins.
  -d, --working-dir=WORKING-DIR  If specified, use the given directory as working directory.
  -v|vv|vvv, --verbose           Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Usage

1. clone the OpenEMR development version from github: https://github.com/openemr/openemr.git

git clone https://github.com/openemr/openemr.git

1. Once it’s done run the following command to move into the OpemEMR root directory and checkout the master branch.

cd openemr
git checkout master

In order to work with Composer a project must have a composer.json file within its root directory. If you take a look at the file you’ll see a list of OpenEMR package dependencies.

1. require: a list of packages (and versions) required by OpenEMR. OpenEMR will not install if any of those package dependencies are not met.
2. require-dev: a list of packages required by OpenEMR for development.

To run Composer for the first time and install your packages simply run:

composer install

When Composer has finished its install you’ll be ready to install OpenEMR.

Be aware that development requirements are always installed by default, Composer doesn’t magically know when it is being run on your production server. If you want to exclude development requirements you will need to run:

composer install --no-dev

Dependencies to migrate

Always included

1. ADODB - adodb/adodb-php (COMPLETED)
2. html2pdf - spipu/html2pdf (also need to include setasign/fpdi-tcpdf) (PENDING REMOVAL - migrating to mPDF)
3. TCPDF - tecnickcom/tcpdf (PENDING REMOVAL - migrating to mPDF)
4. FPDF - setasign/fpdf (UNABLE to do this since there is a needed minor modification to work with PDF_Label; there is no way around this since certain variables are set as protected and the prior version of FPDF that would work is not compatible with PHP7)(only plan to use FPDF for PDF_Label anyways, so not a huge deal)(is stored at library/classes/fpdf)
5. FPDI - setasign/fpdi (COMPLETED; this was brought in by mPDF; will try to remove other copy when get rid of html2pdf/TCPDF stuff)
6. Smarty - smarty/smarty (COMPLETED)
7. pdf-php - rospdf/pdf-php (COMPLETED)
8. phpseclib - phpseclib/phpseclib (COMPLETED)
9. phpmailer - phpmailer/phpmailer (COMPLETED)
10. Zend - zendframework/zendframework (COMPLETED)
11. DomPDF - dompdf/dompdf (COMPLETED)
12. Doctrine - doctrine/common (Doctrine CouchDB Dependency) (COMPLETED)
13. Doctrine - doctrine/couchdb (COMPLETED)
14. Doctrine - doctrine/orm (COMPLETED)
15. adLDAP2 - adldap2/adldap2 (COMPLETED)
16. mPDF - mpdf/mpdf (COMPLETED)
17. twig - twig/twig (COMPLETED)
18. http-foundation - symfony/http-foundation (COMPLETED)
19. yaml - symfony/yaml (COMPLETED)
20. htmlpurifier - ezyang/htmlpurifier (Sherwin plans to use to html escape editors that need to allow html code)
21. phpspreadsheet - phpoffice/phpspreadsheet (Sherwin plans to use this; note Kim was planning to use a prior deprecated package phpoffice/phpexcel for allscripts rx module and will instead need to use phpspreadsheet now)
22. knp-snappy - knplabs/knp-snappy (COMPLETED)
23. stripe-php - stripe/stripe-php (Sherwin requested this for incorporating payment collection via stripe)
24. mobiledetectlib - mobiledetect/mobiledetectlib (Ray is using this for an ongoing project that should get into codebase into the future)

Optional

1. openemr/wkhtmltopdf-openemr - Used by institutional billing (ub04) to create the pdf's. Very large (240MB) so unable to include in main codebase. Install via following command in the openemr directory:
   • composer require openemr/wkhtmltopdf-openemr

Global

This section is for developers, and these are packages that should be installed globally:

1. phing/phing (this is used by mechanism for cleaning out stuff when bring in new composer/bower packages)

Migrating

1. Add package/vendor to the composer.json file
2. run composer install
   1. (if this isn't bringing in requested package, then will need to remove the composer.lock file before running the command)
3. Remove unused files(if they are present) from the installed package (eg. git, .gitignore, tests, docs) - You must update build.xml to include directory(s). This step will require a composer global install of phing and then use the path to phing below in the call.
   1. Windows - From the command line run call vendor/bin/phing vendor-clean
   2. Linux - From the command line run ./vendor/bin/phing vendor-clean
      • (btw, if need to clean up public/assets for bower stuff, then run ./vendor/bin/phing assets-clean )
4. run composer dump-autoload -o

Autoloader

Ongoing Work

Working on using the autoloader to modernize the OpenEMR codebase. Steps:

1. Place the central libraries that are always called in OpenEMR into the autoloader. (COMPLETED)
2. Place the OpenEMR classes into the classmap autoloader.(IN PROGRESS)
   • Done with library/classes with following exceptions that plan to work on:

   • Prescription.class.php, /ClinicalTypes, /rulesets, and /smtp.

3. Convert libraries into classes and also bring these in via the classmap autoloader.
4. Above steps will allow then to do the following:
   • Remove globals from within classes.
   • Write phpunit tests.
5. Place new "modernized" OpenEMR classes into the PSR-4 autoloader.(IN PROGRESS)

Update Autoloader

If updating classes within OpenEMR to work with the autoloader, then just need to run the following command:

• run composer dump-autoload -o

Forum

• Composer