https://github.com/jubianchi/hoathissymfonyconsolebridge

https://github.com/jubianchi/hoathissymfonyconsolebridge

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/jubianchi/hoathissymfonyconsolebridge
• Owner: jubianchi
• Created: 2013-11-03T23:16:31.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2014-01-30T20:27:34.000Z (almost 11 years ago)
• Last Synced: 2024-10-30T06:58:08.027Z (3 months ago)
• Language: PHP
• Size: 156 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
![Hoa](http://static.hoa-project.net/Image/Hoa_small.png)

Hoa is a **modular**, **extensible** and **structured** set of PHP libraries.

Moreover, Hoa aims at being a bridge between industrial and research worlds.

# Hoathis\SymfonyConsoleBridge [![Build Status](https://travis-ci.org/jubianchi/HoathisSymfonyConsoleBridge.png?branch=master)](https://travis-ci.org/jubianchi/HoathisSymfonyConsoleBridge)

* [Installation](#installation)

* [How to use](#how-to-use)

  * [Symfony](#symfony)

  * [Output](#output)

  * [Formatter](#formatter)

  * [Helpers](#helpers)

    * [Window](#window)

    * [Cursor](#cursor)

    * [Readline](#readline)

    * [Pager](#pager)

## Installation

Add these lines to your `require-dev` section:

```json

{

    "require": {

        "hoa/core": "*@dev",

        "hoa/console": "*@dev",

        "hoa/string": "*@dev",

        "hoa/stream": "*@dev",

        "hoathis/symfony-console-bridge": "dev-master"

    }

}

```

Then install dependencies:

```sh

$ composer update hoathis/symfony-console-bridge

```

## How to use

### Symfony

### Output

`Hoathis\SymfonyConsoleBridge\Output\ConsoleOutput` is an alternative to the native `ConsoleOutput` which is able to detect

output type and automatically configure verbosity and text decoration.

Given you have the following command:

```php

register('example:output')

    ->setCode(function(InputInterface $input, OutputInterface $output) {

        $output->writeln('I\'m a decorated text only in the console');

        if ($output->getVerbosity() === OutputInterface::VERBOSITY_NORMAL) {

            $output->writeln('I\'ll with the normal verbosity level');

        }

        if ($output->getVerbosity() === OutputInterface::VERBOSITY_VERBOSE) {

            $output->writeln('I\'ll with the verbose verbosity level');

        }

        if ($output->getVerbosity() === OutputInterface::VERBOSITY_VERY_VERBOSE) {

            $output->writeln('I\'ll with the very verbose verbosity level');

        }

        if ($output->getVerbosity() === OutputInterface::VERBOSITY_DEBUG) {

            $output->writeln('I\'ll with the debug verbosity level');

        }

    })

;

$app->run(new ArgvInput(), new ConsoleOutput());

```

Running:

```sh

$ php app.php

# I'm a decorated text only in the console

# I'll be displayed with the verbose verbosity level

```

As you will see in your terminal, output will be decorated and verbose by default. But if you run:

```sh

$ php app.php > output

$ cat -vet output

# I'm a decorated text only in the console$

# I'll be displayed with the very verbose verbosity level$

```

The verbosity level will automitaclly be switched to very verbose because the output has detected that you were

redirecting it to a file.

Here are the rules used to determine verbosity level and text decoration support:

|          | Verbosity    | Decoration |

| -------- | ------------ | ---------- |

| Pipe     | normal       | false      |

| Redirect | very verbose | false      |

| Terminal | verbose      | true       |

Those rules will only be used if you do not provide any verbosity level using command line arguents. If you want to

redirect outputs to a file using the debug verbosity level, simply run:

```sh

$ php app.php -vvv > output

$ cat -vet output

# I'm a decorated text only in the console$

# I'll be displayed with the debug verbosity level$

```

You can still force ansi output using the `--ansi` option:

```sh

$ php app.php -vvv --ansi | xargs -0 echo -n | cat -vet

# ^[[38;5;189mI'm a decorated text only in the console^[[39;49;0m$

# I'll be displayed with the ^[[38;5;96mdebug^[[39;49;0m verbosity level$

```

### Formatter

`Hoathis\SymfonyConsoleBridge\Formatter\OutputFormatterStyle` will let you do everything you were able to do with the native `symfony/console` style with some more things:

* Supports `xterm-8color` color names

* Supports `xterm-256color` color codes

* **Automatically translates hex color codes**

* Supports text styling (normal, bold, underlined, blink and inverse)

To use those new `OutputFormatterStyle`, you the usual API :

```php

getFormatter();

        $formatter->setStyle('info', new OutputFormatterStyle('#e4cbf4'));

        $formatter->setStyle('comment', new OutputFormatterStyle('#795290'));

        $formatter->setStyle('question', new OutputFormatterStyle('#de8300'));

        $formatter->setStyle('error', new OutputFormatterStyle('white', '#ff3333', array(OutputFormatterStyle::STYLE_BOLD)));

    }

    //...

}

```

As you can see in the previous example, you can replace built-in styles by simply redifining them with the new formatter.

### Helpers

The real power of the library are its helpers: they let you manager every terminal components. You will first have to

manually load them:

```php

set(new Helper\WindowHelper());

        $set->set(new Helper\CursorHelper());

        $set->set(new Helper\ReadlineHelper());

        $set->set(new Helper\PagerHelper());

        return $set;

    }

    //...

}

```

#### Window

The window helper will let you manipulate the current terminal window. It provides several utility methods, each one

being bound to an action:

```php

register('example:window')

    ->setCode(function(InputInterface $input, OutputInterface $output) use ($app) {

        $window = $app->getHelperSet()->get('window');

        $output->writeln('I\'m going to bring your window to the foreground and back to the foreground after one second');

        sleep(1);

        $window->lower($output);

        sleep(1);

        $window->raise($output);

        $output->writeln('I\'m going to minimize your window and restore it after one second');

        sleep(1);

        $window->minimize($output);

        sleep(1);

        $window->restore($output);

    })

;

```

Many other utility method are available

* `setTitle`, `getTitle`, `getLabel` to manipulate terminal title

* `setSize`, `getSize`, `move`, `setPosition`, `getPosition` to manipulate window position

* `minimize`, `restore`, `lower`, `raise` to manipulate window placement

* `scroll`, `refresh`, `copy` to manipulate window content

#### Cursor

#### Readline

#### Pager