PHPackages                             cypresslab/compass-elephant - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. cypresslab/compass-elephant

AbandonedLibrary

cypresslab/compass-elephant
===========================

A library to manage a compass project with PHP

v0.3.4(11y ago)8112.0k↓46.4%62LGPL-3.0+PHPPHP >=5.3.3

Since Jan 31Pushed 11y ago1 watchersCompare

[ Source](https://github.com/matteosister/CompassElephant)[ Packagist](https://packagist.org/packages/cypresslab/compass-elephant)[ Docs](http://matteosister.github.com/CompassElephant)[ RSS](/packages/cypresslab-compass-elephant/feed)WikiDiscussions develop Synced 1mo ago

READMEChangelog (7)Dependencies (3)Versions (23)Used By (2)

CompassElephant [![License](https://camo.githubusercontent.com/4a0b39f2398e892a39ad1486ee89f14f369f4d8baee86d086904c4d39950b846/68747470733a2f2f706f7365722e707567782e6f72672f637970726573736c61622f636f6d706173732d656c657068616e742f6c6963656e73652e737667)](https://packagist.org/packages/cypresslab/compass-elephant)
==========================================================================================================================================================================================================================================================================================================================

[](#compasselephant-)

[![Build Status](https://camo.githubusercontent.com/4c5dfcb6f2aec7edc552962d04951d65c3e4dffdb60c079a85150a222745f6bc/68747470733a2f2f7472617669732d63692e6f72672f6d617474656f7369737465722f436f6d70617373456c657068616e742e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/matteosister/CompassElephant) [![Total Downloads](https://camo.githubusercontent.com/3696873306a7221fadbf250a487e95f1384c9ccf1921d0871a766f00f13286ce/68747470733a2f2f706f7365722e707567782e6f72672f637970726573736c61622f636f6d706173732d656c657068616e742f646f776e6c6f6164732e737667)](https://packagist.org/packages/cypresslab/compass-elephant) [![SensioLabsInsight](https://camo.githubusercontent.com/39b4c2f091fdb199a997cbc1a76330bd99f1cee686e394e0593f5cf862e1696d/68747470733a2f2f696e73696768742e73656e73696f6c6162732e636f6d2f70726f6a656374732f39363535313033332d633030662d346338612d626334362d6465343663316234643132362f6d696e692e706e67)](https://insight.sensiolabs.com/projects/96551033-c00f-4c8a-bc46-de46c1b4d126)

A wrapper for the compass binary written in PHP

Requirements
------------

[](#requirements)

- php >= 5.3
- \*nix system with compass installed

Dependencies
------------

[](#dependencies)

- [Symfony Finder](https://github.com/symfony/Finder)
- [Symfony Process](https://github.com/symfony/Process)

*for tests*

- [PHPUnit](https://github.com/sebastianbergmann/phpunit)

Installation
------------

[](#installation)

**composer**

To install CompassElephant with composer you simply need to create a *composer.json* in your project root and add:

```
{
    "require": {
        "cypresslab/compass-elephant": ">=0.1.0"
    }
}
```

Then run

```
$ wget -nc http://getcomposer.org/composer.phar
$ php composer.phar install
```

You have now CompassElephant installed in *vendor/cypresslab/compasselephant*

And an handy autoload file to include in you project in *vendor/.composer/autoload.php*

**pear**

Add the Cypresslab channel

```
$ pear channel-discover pear.cypresslab.net
```

And install the package. *By now CompassElephant is in alpha state. So remember the -alpha in the library name*

```
$ pear install cypresslab/CompassElephant-alpha
```

On [Cypresslab pear channel homepage](http://pear.cypresslab.net/) you can find other useful information

Testing
-------

[](#testing)

The library is fully tested with PHPUnit.

Go to the base library folder and run the test suites

```
$ phpunit
```

Code style
----------

[](#code-style)

- CompassElephant follows the [Symfony2 Coding Standard](https://github.com/opensky/Symfony2-coding-standard)
- I'm using [gitflow](https://github.com/nvie/gitflow) so, if you want to contribute, please send a pull-request on develop branch

How to use
----------

[](#how-to-use)

Remember to **give the user the right permissions to access the filesystem**. If you are using a web server give permissions to both your user and the web server user.

**constructor**

```