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
Installs: 10 055
Dependents: 3
Suggesters: 0
Security: 0
Stars: 1
Watchers: 5
Forks: 0
Open Issues: 0
Requires
- php: ~7.0
Requires (Dev)
- mockery/mockery: 0.9.*
- phpunit/phpunit: ~6.0
README
This free as in freedom project aims to deliver a easy to use php command component.
The build status of the current master branch is tracked by Travis CI:
Take a look on openhub.net.
The current change log can be found here.
Usage
You can find a lot of examples here.
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.
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.