Clase PHP para enviar texto coloreado a la consola

Hice un script para mí mismo para implementar el sitio en producción. ¿Por qué necesitabas mostrar lo que está sucediendo? Y para que quede más claro, decidí mostrar en color. Sin embargo, no pude encontrar algo adecuado. Como máximo, la biblioteca mostraba texto en color, pero no admitía relleno. Por lo tanto, hice mi propia biblioteca para esto. Quizás alguien sea útil. Una biblioteca pequeña (pero funcional) para enviar texto coloreado a la consola con soporte para sangría en este formulario

Console::indent(2)->color('brown')->bgcolor('magenta')->writeln(' Habr!'); 

1. Instalación
2. Uso
3. Sangría
4. Estilos
5. Registro
6. Azúcar sintáctica

Instalación

Puedes usar el compositor para la instalación

 composer require shasoft/console 

o descargar desde github

Uso

Lista de todos los colores admitidos. Los nombres de columna son colores de fondo, los nombres de fila son colores de texto.

Salida de texto en color

• Color de función ( valor ): establece el color del texto
• Función bgcolor ( valor ): establece el color de fondo
• La función de escritura ( valor1 , valor2 , ... ): muestra el valor en la pantalla. Si el valor no es una cadena, entonces se convierte en una cadena usando la función php var_export ( value , true )
• Función reset (): restablece los colores a los valores predeterminados
• Función setDefault (): establece los colores predeterminados. Valores predeterminados: color de fondo = negro, color de texto = blanco
• Función enter ( $ resetColor = true). Por defecto, una llamada a función restablece los colores a sus valores predeterminados. Tenga en cuenta que la línea no se muestra hasta que se llama a la función enter (). Esto se debe a que la biblioteca admite relleno.
• Función writeln ( ... ) - write ( ... ) + enter ()

 use Shasoft\Console\Console; //      Console::color('red')->bgcolor('green')->write('    ')->enter(); //      Console::color('green')->bgcolor('red')->writeln('    '); //      Console::color('red')->bgcolor('white')->write('     ')->reset()->writeln('    '); 

Sangría

Para trabajar con sangría, use la función de sangría ( valor de sangría [, valor absoluto ]): si se especifica el segundo parámetro y es = verdadero, entonces la sangría es absoluta. De lo contrario, la sangría es relativa. Para obtener la sangría actual, debe llamar a la función indent () sin parámetros.

Un ejemplo:

 use Shasoft\Console\Console; Console::indent(0,true); //  0 Console::indent(1)->color('red')->writeln(' 1'); Console::indent(3,true)->color('green')->writeln(' 3'); Console::indent(-1)->color('blue')->writeln(' 2'); 

     = 2 indent(1)  = 3     = 2 indent(-1)  = 2     = 2 indent(10)  = 10     = 2 indent(1)  = 1 

conclusión:

• Función setTabSize ( tamaño de pestaña ): establece el tamaño de la pestaña. Predeterminado = 3
• Función setSpace ( símbolo ): establece el carácter de tabulación. Predeterminado = '' (espacio)

la función de sangría se aplica a la línea de salida y el valor cambiará hasta que se llame a la función enter (). Es decir este código imprimirá la línea sangrada 3

 Console::indent(0,true)->color('red')->indent(1)->bgcolor('blue')->indent(1)->write(' 3')->indent(1)->enter(); 

Estilos

Puedes especificar estilos. El estilo de error predeterminado es "error"

• Función SetStyle ( nombre de estilo , color de texto = nulo, color de fondo = nulo) - establece parámetros de estilo
• Estilo de función ( nombre de estilo ): use el estilo especificado

Ejemplo de uso:

 Console::indent(1,true)->style("error")->writeln('- '); 

conclusión:

Registro

Hay funciones especiales para el control de registro.

• Función setLogLevel ( $ value = null): establece / obtiene el nivel de registro global. Predeterminado = 0
• Función logLevel ( $ value = null): establece / obtiene el nivel de registro. Predeterminado = 0

Los valores se muestran utilizando la función write () solo si el nivel de registro actual es menor que el nivel de registro global.

Un ejemplo:

 Console::setLogLevel(0)->logLevel(1)->writeln(' ,     = 1   0'); Console::setLogLevel(2)->logLevel(1)->writeln(',     = 1  - 2'); Console::setLogLevel(2)->logLevel(3)->write('   ')->logLevel(1)->write('  ')->enter(); 

Azúcar sintáctica

Para no escribir color ('rojo') -> bgcolor ('verde') se puede escribir en forma corta

 Console::red()->bg_green()->writeln('     .'); 

La función puede establecer el color de fondo sin subrayar. Sin embargo, visualmente separa el color del prefijo y, en mi opinión, es muy conveniente.

Página de la biblioteca

upd : como señalaron un error en el nombre de la función de identificación en lugar de sangría , lo arreglé para no avergonzar a los que saben bien inglés :)