Skip to content

Base service class for MODX packages including common utilities, available via composer as `modmore/alpacka`

License

Notifications You must be signed in to change notification settings

modmore/Alpacka

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Apr 21, 2022
bf06ab5 · Apr 21, 2022

History

55 Commits
Apr 28, 2021
Apr 21, 2022
Apr 21, 2022
Apr 21, 2022
Jan 22, 2018
May 30, 2016
Jan 22, 2018
Apr 18, 2022
Jan 28, 2016
Jan 28, 2016
Aug 4, 2016
Dec 18, 2015
Jan 28, 2016

Repository files navigation

modmore/Alpacka

Alpacka by modmore is a base service class for MODX packages, and a (growing) collection of common utilities for MODX packages. It is meant to be included as a composer package.

Build Status

To use Alpacka, your base service class will need to extend the modmore\Alpacka\Alpacka class. There is a (very) simple example service implementation in tests/Example.php.

The service class includes a Pimple dependency injection container as $class->services.

Documentation (work in progress) can be found in the wiki.

Installation

composer require modmore/alpacka

Contributions are more than welcome

To contribute to Alpacka you will first need to install the local dependencies:

composer install

Please follow the existing coding style. In particular:

  • Array properties and MODX settings are in snake_case
  • Variable, property and method names are in camelCase
  • Inline documentation please! At the very least PHPDoc on every method and public properties.

One pull request per feature/improvement/bugfix.