steverobbins/magento-shell

Magento Improved Shell

Magento Shell

, _(*1)

, _(*2)

OMG COLORS

, _(*3)

Add some style to your Magento scripts., _(*4)

, _(*5)

Usage

Extend the shell/local/abstract.php class and put your logic in the run() method, like you normally would with a Magento shell script., _(*6)

Output

Instead of echoing, use the $this->log object. You can output messages using one of Zend_Log's levels, _(*7)

<?php

class Zend_Log
{
    const EMERG   = 0;  // Emergency: system is unusable
    const ALERT   = 1;  // Alert: action must be taken immediately
    const CRIT    = 2;  // Critical: critical conditions
    const ERR     = 3;  // Error: error conditions
    const WARN    = 4;  // Warning: warning conditions
    const NOTICE  = 5;  // Notice: normal but significant condition
    const INFO    = 6;  // Informational: informational messages
    const DEBUG   = 7;  // Debug: debug messages
}

Example:, _(*8)

<?php

require_once 'abstract.php';

class Local_Shell_MyScript extends Local_Shell_Abstract
{
    public function run()
    {
        $this->log->debug('Hello World!');
    }
}

Progress Bar

Create a progress bar with $bar = $this->progressBar($count);, where $count is an integer of how many items you will iterate over. $bar->update($i); as you walk through, then $bar->finish(); when complete., _(*9)

Example:, _(*10)

<?php

require_once 'abstract.php';

class Local_Shell_MyScript extends Local_Shell_Abstract
{
    public function run()
    {
        $collection = Mage::getModel('catalog/product')->getCollection();
        $count      = $collection->count();
        $bar        = $this->progressBar($count);
        $i          = 0;
        foreach ($collection as $product) {
            $product->setDescription(strip_tags($product->getDescription()))
                ->save();
            $bar->update(++$i);
        }
        $bar->finish();
    }
}

Logging

Output is automatically logged to var/log/shell_local_<scriptName>.log., _(*11)

Alternatively, you can specify your own log file by setting the public $logFile variable in you script., _(*12)

Support

Please create an issue for all bugs and feature requests, _(*13)

Contributing

Fork this repository and send a pull request to the dev branch, _(*14)

License

WTF Public License 2.0, _(*15)