ipunkt/composer-about

Parses composer.lock and returns informations about the used packages

Retrieve Information from composer.lock

, _(*1)

Parses composer.lock and returns informations about the used packages, _(*2)

Usage

Mainly developed for Laravel, but can still be used in all other Frameworks or Vanilla PHP applications., _(*3)

1. Add service provider to app.config, _(*4)

   'Ipunkt\ComposerAbout\ComposerAboutServiceProvider',, _(*5)

2. Use it in your routes.php or Controller action, _(*6)

   /** @var \Ipunkt\ComposerAbout\Structure\ComposerStructure $composerAbout */, _(*7)

   $composerAbout = App::make('composer-about');, _(*8)

API

ComposerStructure::$hash

Hash of the current installed packages., _(*9)

ComposerStructure::$packages

A Collection of Package object instances for the packages used., _(*10)

ComposerStructure::$devpackages

A Collection of Package object instances for the dev packages used., _(*11)

ComposerStructure::licenses()

An array of all unique licenses for all required packages. Perhaps for a summary of used licenses. Can be very useful, if you want to check, that there is a defined license that you do not want to have., _(*12)

Package

For current methods please see Ipunkt\ComposerAbout\Structure\Data\Package.php, _(*13)

Package::getName()

Returns the name of the package., _(*14)

Package::getVersion()

Returns the version of the package., _(*15)

Package::getDescription()

Returns the description of the package., _(*16)

Package::getAuthors()

Returns an array of alle Authors...each author has 'name' and 'email' set, if possible., _(*17)

Package::getLicenses()

Returns the licenses of the package., _(*18)

Package::getType()

Returns the type of the package. E.g. library, _(*19)

Package::getName()

Returns the name of the package., _(*20)