phix/taskslib

TasksLib is a library of classes for automating repetitive tasks

Maintainers

Details

github.com/stuartherbert/TasksLib

Homepage

Source

Issues

Installs: 15

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 2

Forks: 0

Open Issues: 0

2.0.2 2013-06-09 11:55 UTC

Requires

Requires (Dev)

BSD-3-Clause a3b43cdf1423ebf0ca5aa8cd3c7cfb0cd6a89aa4

This package is not auto-updated.

Last update: 2024-12-17 07:10:11 UTC

README

TasksLib2 is a simple-to-use PHP component that provides a collection of classes that automate common repetitive tasks. It was originally created to stop individual Phix commands duplicating code, but it's generic enough to be useful to a wider range of projects.

System-Wide Installation

TasksLib should be installed using the PEAR Installer. This installer is the PHP community's de-facto standard for installing PHP components.

sudo pear channel-discover pear.phix-project.org
sudo pear install --alldeps phix/TasksLib2

As A Dependency On Your Component

If you are creating a component that relies on TasksLib2, please make sure that you add TasksLib2 to your component's package.xml file:

<dependencies>
  <required>
    <package>
      <name>TasksLib2</name>
      <channel>pear.phix-project.org</channel>
      <min>2.0.0</min>
      <max>2.999.9999</max>
    </package>
  </required>
</dependencies>

Usage

The best documentation for TasksLib are the unit tests, which are shipped in the package. You will find them installed into your PEAR repository, which on Linux systems is normally /usr/share/php/test.

Development Environment

If you want to patch or enhance this component, you will need to create a suitable development environment. The easiest way to do that is to install phix4componentdev:

# phix4componentdev
sudo apt-get install php5-xdebug
sudo apt-get install php5-imagick
sudo pear channel-discover pear.phix-project.org
sudo pear -D auto_discover=1 install -Ba phix/phix4componentdev

You can then clone the git repository:

# TasksLib
git clone git@github.com:stuartherbert/TasksLib.git

Then, install a local copy of this component's dependencies to complete the development environment:

# build vendor/ folder
phing build-vendor

To make life easier for you, common tasks (such as running unit tests, generating code review analytics, and creating the PEAR package) have been automated using phing. You'll find the automated steps inside the build.xml file that ships with the component.

Run the command 'phing' in the component's top-level folder to see the full list of available automated tasks.

License

See LICENSE.txt for full license details.