2017 © Pedro Peláez
 

library php_component_command

free as in freedom php component command is a thin and generic wrapper to easy up using system (shell) command usage

image

net_bazzline/php_component_command

free as in freedom php component command is a thin and generic wrapper to easy up using system (shell) command usage

  • Wednesday, February 14, 2018
  • by artodeto
  • Repository
  • 5 Watchers
  • 0 Stars
  • 1,287 Installations
  • PHP
  • 3 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 18 Versions
  • 1 % Grown

The README.md

PHP Command Component

This free as in freedom project aims to deliver a easy to use php command component., (*1)

The build status of the current master branch is tracked by Travis CI: Build Status Latest stable, (*2)

The scrutinizer status are: code quality | build status, (*3)

The versioneye status is: Dependency Status, (*4)

Take a look on openhub.net., (*5)

The current change log can be found here., (*6)

Usage

You can find a lot of examples here., (*7)

class Zip extends Command
{
    /** 
     * @param string $archiveName
     * @param array $items
     * @return array
     * @throws RuntimeException
     */
    public function __invoke($archiveName, array $items)
    { 
        return $this->zip($archiveName, $items);
    }

    /** 
     * @param string $archiveName
     * @param array $items
     * @return array
     * @throws RuntimeException
     * @todo implement parameter validation
     */
    public function zip($archiveName, array $items)
    {   
        $command = '/usr/bin/zip -r ' . $archiveName . ' ' . implode(' ' , $items);

        return $this->execute($command);
    }

    /** 
     * @param string $pathToArchive
     * @param null|string $outputPath
     * @return array
     * @throws RuntimeException
     * @todo implement parameter validation
     */
    public function unzip($pathToArchive, $outputPath = null)
    {   
        if (!is_null($outputPath)) {
            $command = '/usr/bin/unzip ' . $pathToArchive . ' -d ' . $outputPath;
        } else {
            $command = '/usr/bin/unzip ' . $pathToArchive;
        }

        return $this->execute($command);
    }

    /** 
     * @param string $pathToArchive
     * @return array
     * @throws RuntimeException
     * @todo implement parameter validation
     */
    public function listContent($pathToArchive)
    {   
        $command = '/usr/bin/unzip -l ' . $pathToArchive;

        return $this->execute($command);
    }

    /**
     * @throws InvalidSystemEnvironmentException
     */
    public function validateSystemEnvironment()
    {
        if (!is_executable('/usr/bin/zip')) {
            throw new InvalidSystemEnvironmentException(
                '/usr/bin/zip is mandatory'
            );
        }

        if (!is_executable('/usr/bin/unzip')) {
            throw new InvalidSystemEnvironmentException(
                '/usr/bin/unzip is mandatory'
            );
        }
    }
}

$zip = new Zip();

$pathToZipArchive = '/tmp/my.zip';

$zip->validateSystemEnvironment();

echo 'list archive content' . PHP_EOL;
$lines = $zip->listContent($pathToZipArchive);
foreach ($lines as $line) {
    echo $line . PHP_EOL;
}

echo 'unzip archive' . PHP_EOL;
$zip->unzip($pathToZipArchive, '/tmp/my_directory');

echo 'zip directory' . PHP_EOL;
//also valid call since we implemented __invoke
//$zip($pathToZipArchive, array('/tmp/my_directory'));
$zip->zip($pathToZipArchive, array('/tmp/my_directory'));

Install

By Hand

mkdir -p vendor/net_bazzline/php_component_command
cd vendor/net_bazzline/php_component_command
git clone https://github.com/bazzline/php_component_command .

With Composer

composer require net_bazzline/php_component_command:dev-master

Benefits

  • easy and robust way of dealing with system commands
  • return value validation by using exceptions
  • hopefully the thinnest possible layer between system commands

API

API is available at bazzline.net., (*8)

Final Words

Star it if you like it :-). Add issues if you need it. Pull patches if you enjoy it. Write a blog entry if you use it :-D., (*9)

The Versions

14/02 2018

dev-master

9999999-dev

free as in freedom php component command is a thin and generic wrapper to easy up using system (shell) command usage

  Sources   Download

LGPL-3.0 LGPL-3.0-only

The Requires

  • php ~7.0

 

The Development Requires

by Stev Leibelt

psr component php command wrapper job php7 shell psr-4 bazzline free as in freedom lgpl system command php56

13/01 2018

2.0.0

2.0.0.0

free as in freedom php component command is a thin and generic wrapper to easy up using system (shell) command usage

  Sources   Download

LGPL-3.0

The Requires

  • php ~7.0

 

The Development Requires

by Stev Leibelt

psr component php command wrapper job php7 shell psr-4 bazzline free as in freedom lgpl system command

22/02 2016

1.2.2

1.2.2.0

free as in freedom php component command is a thin and generic wrapper to easy up using system (shell) command usage

  Sources   Download

LGPL-3.0

The Requires

  • php >=5.3.3

 

The Development Requires

by Stev Leibelt

psr component php command wrapper job shell psr-4 bazzline free as in freedom lgpl system command

18/09 2015

1.2.0

1.2.0.0

free as in freedom php component command is a thin and generic wrapper to easy up using system (shell) command usage

  Sources   Download

LGPLv3

The Requires

  • php >=5.3.3

 

The Development Requires

by Stev Leibelt

component php command wrapper job shell free as in freedom lgpl system command

13/09 2015

1.1.0

1.1.0.0

free as in freedom php component command is a thin and generic wrapper to easy up using system (shell) command usage

  Sources   Download

LGPLv3

The Requires

  • php >=5.3.3

 

The Development Requires

by Stev Leibelt

component php command wrapper job shell free as in freedom lgpl system command

23/08 2015

1.0.11

1.0.11.0

free as in freedom php component command is a thin and generic wrapper to easy up using system (shell) command usage

  Sources   Download

LGPLv3

The Requires

  • php >=5.3.3

 

The Development Requires

by Stev Leibelt

component php command wrapper job shell free as in freedom lgpl system command

30/07 2015

1.0.10

1.0.10.0

free as in freedom php component command is a thin and generic wrapper to easy up using system (shell) command usage

  Sources   Download

LGPLv3

The Requires

  • php >=5.3.3

 

The Development Requires

by Stev Leibelt

component php command wrapper job shell free as in freedom lgpl system command

04/07 2015

1.0.9

1.0.9.0

free as in freedom php component command is a thin and generic wrapper to easy up using system (shell) command usage

  Sources   Download

LGPLv3

The Requires

  • php >=5.3.3

 

The Development Requires

by Stev Leibelt

component php command wrapper job shell free as in freedom lgpl system command

29/06 2015

1.0.8

1.0.8.0

free as in freedom php component command is a thin and generic wrapper to easy up using system (shell) command usage

  Sources   Download

LGPLv3

The Requires

  • php >=5.3.3

 

The Development Requires

by Stev Leibelt

component php command wrapper job shell free as in freedom lgpl system command

26/05 2015

1.0.7

1.0.7.0

free as in freedom php component command is a thin and generic wrapper to easy up using system (shell) command usage

  Sources   Download

LGPLv3

The Requires

  • php >=5.3.3

 

The Development Requires

by Stev Leibelt

component php command wrapper job shell free as in freedom lgpl system command

08/02 2015

dev-develop

dev-develop

php component command is a thin and generic wrapper to easy up using system (shell) command usage

  Sources   Download

LGPLv3

The Requires

  • php >=5.3.3

 

The Development Requires

by Stev Leibelt

component php command wrapper job shell system command

08/02 2015

1.0.6

1.0.6.0

php component command is a thin and generic wrapper to easy up using system (shell) command usage

  Sources   Download

LGPLv3

The Requires

  • php >=5.3.3

 

The Development Requires

by Stev Leibelt

component php command wrapper job shell system command

08/02 2015

1.0.5

1.0.5.0

php component command is a thin and generic wrapper to easy up using system (shell) command usage

  Sources   Download

LGPLv3

The Requires

  • php >=5.3.3

 

The Development Requires

by Stev Leibelt

component php command wrapper job shell system command

18/12 2014

1.0.4

1.0.4.0

php component command is a thin and generic wrapper to easy up using system (shell) command usage

  Sources   Download

LGPLv3

The Requires

  • php >=5.3.3

 

The Development Requires

by Stev Leibelt

component php command wrapper job shell system command

17/12 2014

1.0.3

1.0.3.0

php component command is a thin and generic wrapper to easy up using system (shell) command usage

  Sources   Download

LGPLv3

The Requires

  • php >=5.3.3

 

The Development Requires

by Stev Leibelt

component php command wrapper job shell system command

14/12 2014

1.0.2

1.0.2.0

php component command is a thin and generic wrapper to easy up using system (shell) command usage

  Sources   Download

LGPLv3

The Requires

  • php >=5.3.3

 

The Development Requires

by Stev Leibelt

component php command wrapper job shell system command

12/12 2014

1.0.1

1.0.1.0

php component command is a thin and generic wrapper to easy up using system (shell) command usage

  Sources   Download

LGPLv3

The Requires

  • php >=5.3.3

 

The Development Requires

by Stev Leibelt

component php command wrapper job shell system command

11/12 2014

1.0.0

1.0.0.0

php component command to easy up system command usage

  Sources   Download

LGPLv3

The Requires

  • php >=5.3.3

 

by Stev Leibelt

component php command system command