Ubiquity 2.5.2
php rapid development framework
Loading...
Searching...
No Matches
ConsoleFormatter Class Reference

Ubiquity\devtools\cmd$ConsoleFormatter This class is part of Ubiquity. More...

Static Public Member Functions

static colorize ($string, $color=null, $bgColor=null)
 Returns a colored string.
 
static showInfo ($content, $dColor=self::CYAN)
 
static isSupported ()
 
static formatContent ($content, $prefix=" · ")
 Format a multilines content.
 
static showMessage ($content, $type='info', $title=null)
 Return a formated message.
 
static formatHtml ($str)
 Format an html message (only for bold values).
 

Data Fields

const BLACK = '0;30'
 
const DARK_GREY = '1;30'
 
const BLUE = '0;34'
 
const LIGHT_BLUE = '1;34'
 
const GREEN = '0;32'
 
const LIGHT_GREEN = '1;32'
 
const CYAN = '0;36'
 
const LIGHT_CYAN = '1;36'
 
const RED = '0;31'
 
const LIGHT_RED = '1;31'
 
const PURPLE = '0;35'
 
const LIGHT_PURPLE = '1;35'
 
const BROWN = '0;33'
 
const YELLOW = '1;33'
 
const LIGHT_GRAY = '0;37'
 
const WHITE = '1;37'
 
const BG_BLACK = '40'
 
const BG_RED = '41'
 
const BG_GREEN = '42'
 
const BG_YELLOW = '43'
 
const BG_BLUE = '44'
 
const BG_MAGENTA = '45'
 
const BG_CYAN = '46'
 
const BG_LIGHT_GRAY = '47'
 
const BOLD = '1'
 
const END_BOLD = '22'
 
const CLEAR = '0'
 

Static Private Member Functions

static prefixLines ($str, $prefix)
 
static escape ($value)
 

Detailed Description

Ubiquity\devtools\cmd$ConsoleFormatter This class is part of Ubiquity.

Author
jc
Version
1.0.0

Definition at line 12 of file ConsoleFormatter.php.

Member Function Documentation

◆ colorize()

static colorize (   $string,
  $color = null,
  $bgColor = null 
)
static

Returns a colored string.

Parameters
string$string
string$color
string$bgColor
Returns
string

Definition at line 28 of file ConsoleFormatter.php.

◆ escape()

static escape (   $value)
staticprivate

Definition at line 52 of file ConsoleFormatter.php.

◆ formatContent()

static formatContent (   $content,
  $prefix = "    · " 
)
static

Format a multilines content.

Parameters
string$content
string$prefix
Returns
string

Definition at line 84 of file ConsoleFormatter.php.

◆ formatHtml()

static formatHtml (   $str)
static

Format an html message (only for bold values).

Parameters
string$str
Returns
mixed

Definition at line 135 of file ConsoleFormatter.php.

◆ isSupported()

static isSupported ( )
static
Returns
boolean

Definition at line 64 of file ConsoleFormatter.php.

◆ prefixLines()

static prefixLines (   $str,
  $prefix 
)
staticprivate

Definition at line 43 of file ConsoleFormatter.php.

◆ showInfo()

static showInfo (   $content,
  $dColor = self::CYAN 
)
static

Definition at line 56 of file ConsoleFormatter.php.

◆ showMessage()

static showMessage (   $content,
  $type = 'info',
  $title = null 
)
static

Return a formated message.

Parameters
string$content
string$type
?string$title
Returns
string

Definition at line 99 of file ConsoleFormatter.php.

Field Documentation

◆ BG_BLACK

const BG_BLACK = '40'

Definition at line 16 of file ConsoleFormatter.php.

◆ BG_BLUE

const BG_BLUE = '44'

Definition at line 16 of file ConsoleFormatter.php.

◆ BG_CYAN

const BG_CYAN = '46'

Definition at line 16 of file ConsoleFormatter.php.

◆ BG_GREEN

const BG_GREEN = '42'

Definition at line 16 of file ConsoleFormatter.php.

◆ BG_LIGHT_GRAY

const BG_LIGHT_GRAY = '47'

Definition at line 16 of file ConsoleFormatter.php.

◆ BG_MAGENTA

const BG_MAGENTA = '45'

Definition at line 16 of file ConsoleFormatter.php.

◆ BG_RED

const BG_RED = '41'

Definition at line 16 of file ConsoleFormatter.php.

◆ BG_YELLOW

const BG_YELLOW = '43'

Definition at line 16 of file ConsoleFormatter.php.

◆ BLACK

const BLACK = '0;30'

Definition at line 14 of file ConsoleFormatter.php.

◆ BLUE

const BLUE = '0;34'

Definition at line 14 of file ConsoleFormatter.php.

◆ BOLD

const BOLD = '1'

Definition at line 18 of file ConsoleFormatter.php.

◆ BROWN

const BROWN = '0;33'

Definition at line 14 of file ConsoleFormatter.php.

◆ CLEAR

const CLEAR = '0'

Definition at line 18 of file ConsoleFormatter.php.

◆ CYAN

const CYAN = '0;36'

Definition at line 14 of file ConsoleFormatter.php.

◆ DARK_GREY

const DARK_GREY = '1;30'

Definition at line 14 of file ConsoleFormatter.php.

◆ END_BOLD

const END_BOLD = '22'

Definition at line 18 of file ConsoleFormatter.php.

◆ GREEN

const GREEN = '0;32'

Definition at line 14 of file ConsoleFormatter.php.

◆ LIGHT_BLUE

const LIGHT_BLUE = '1;34'

Definition at line 14 of file ConsoleFormatter.php.

◆ LIGHT_CYAN

const LIGHT_CYAN = '1;36'

Definition at line 14 of file ConsoleFormatter.php.

◆ LIGHT_GRAY

const LIGHT_GRAY = '0;37'

Definition at line 14 of file ConsoleFormatter.php.

◆ LIGHT_GREEN

const LIGHT_GREEN = '1;32'

Definition at line 14 of file ConsoleFormatter.php.

◆ LIGHT_PURPLE

const LIGHT_PURPLE = '1;35'

Definition at line 14 of file ConsoleFormatter.php.

◆ LIGHT_RED

const LIGHT_RED = '1;31'

Definition at line 14 of file ConsoleFormatter.php.

◆ PURPLE

const PURPLE = '0;35'

Definition at line 14 of file ConsoleFormatter.php.

◆ RED

const RED = '0;31'

Definition at line 14 of file ConsoleFormatter.php.

◆ WHITE

const WHITE = '1;37'

Definition at line 14 of file ConsoleFormatter.php.

◆ YELLOW

const YELLOW = '1;33'

Definition at line 14 of file ConsoleFormatter.php.


The documentation for this class was generated from the following file: