Documentation

Highlighter
in

Table of Contents

Constants

HIGHLIGHT_BACKTICK_QUOTE  = 'backtickQuote'
HIGHLIGHT_BOUNDARY  = 'boundary'
HIGHLIGHT_COMMENT  = 'comment'
HIGHLIGHT_ERROR  = 'error'
HIGHLIGHT_NUMBER  = 'number'
HIGHLIGHT_QUOTE  = 'quote'
HIGHLIGHT_RESERVED  = 'reserved'
HIGHLIGHT_VARIABLE  = 'variable'
HIGHLIGHT_WORD  = 'word'
TOKEN_TYPE_TO_HIGHLIGHT  = [\Doctrine\SqlFormatter\Token::TOKEN_TYPE_BOUNDARY => self::HIGHLIGHT_BOUNDARY, \Doctrine\SqlFormatter\Token::TOKEN_TYPE_WORD => self::HIGHLIGHT_WORD, \Doctrine\SqlFormatter\Token::TOKEN_TYPE_BACKTICK_QUOTE => self::HIGHLIGHT_BACKTICK_QUOTE, \Doctrine\SqlFormatter\Token::TOKEN_TYPE_QUOTE => self::HIGHLIGHT_QUOTE, \Doctrine\SqlFormatter\Token::TOKEN_TYPE_RESERVED => self::HIGHLIGHT_RESERVED, \Doctrine\SqlFormatter\Token::TOKEN_TYPE_RESERVED_TOPLEVEL => self::HIGHLIGHT_RESERVED, \Doctrine\SqlFormatter\Token::TOKEN_TYPE_RESERVED_NEWLINE => self::HIGHLIGHT_RESERVED, \Doctrine\SqlFormatter\Token::TOKEN_TYPE_NUMBER => self::HIGHLIGHT_NUMBER, \Doctrine\SqlFormatter\Token::TOKEN_TYPE_VARIABLE => self::HIGHLIGHT_VARIABLE, \Doctrine\SqlFormatter\Token::TOKEN_TYPE_COMMENT => self::HIGHLIGHT_COMMENT, \Doctrine\SqlFormatter\Token::TOKEN_TYPE_BLOCK_COMMENT => self::HIGHLIGHT_COMMENT]

Methods

highlightError()  : string
Highlights a token which causes an issue
highlightErrorMessage()  : string
Highlights an error message
highlightToken()  : string
Highlights a token depending on its type.
output()  : string
Helper function for building string output

Constants

HIGHLIGHT_BACKTICK_QUOTE

public mixed HIGHLIGHT_BACKTICK_QUOTE = 'backtickQuote'

HIGHLIGHT_BOUNDARY

public mixed HIGHLIGHT_BOUNDARY = 'boundary'

HIGHLIGHT_COMMENT

public mixed HIGHLIGHT_COMMENT = 'comment'

HIGHLIGHT_ERROR

public mixed HIGHLIGHT_ERROR = 'error'

HIGHLIGHT_NUMBER

public mixed HIGHLIGHT_NUMBER = 'number'

HIGHLIGHT_QUOTE

public mixed HIGHLIGHT_QUOTE = 'quote'

HIGHLIGHT_RESERVED

public mixed HIGHLIGHT_RESERVED = 'reserved'

HIGHLIGHT_VARIABLE

public mixed HIGHLIGHT_VARIABLE = 'variable'

TOKEN_TYPE_TO_HIGHLIGHT

public mixed TOKEN_TYPE_TO_HIGHLIGHT = [\Doctrine\SqlFormatter\Token::TOKEN_TYPE_BOUNDARY => self::HIGHLIGHT_BOUNDARY, \Doctrine\SqlFormatter\Token::TOKEN_TYPE_WORD => self::HIGHLIGHT_WORD, \Doctrine\SqlFormatter\Token::TOKEN_TYPE_BACKTICK_QUOTE => self::HIGHLIGHT_BACKTICK_QUOTE, \Doctrine\SqlFormatter\Token::TOKEN_TYPE_QUOTE => self::HIGHLIGHT_QUOTE, \Doctrine\SqlFormatter\Token::TOKEN_TYPE_RESERVED => self::HIGHLIGHT_RESERVED, \Doctrine\SqlFormatter\Token::TOKEN_TYPE_RESERVED_TOPLEVEL => self::HIGHLIGHT_RESERVED, \Doctrine\SqlFormatter\Token::TOKEN_TYPE_RESERVED_NEWLINE => self::HIGHLIGHT_RESERVED, \Doctrine\SqlFormatter\Token::TOKEN_TYPE_NUMBER => self::HIGHLIGHT_NUMBER, \Doctrine\SqlFormatter\Token::TOKEN_TYPE_VARIABLE => self::HIGHLIGHT_VARIABLE, \Doctrine\SqlFormatter\Token::TOKEN_TYPE_COMMENT => self::HIGHLIGHT_COMMENT, \Doctrine\SqlFormatter\Token::TOKEN_TYPE_BLOCK_COMMENT => self::HIGHLIGHT_COMMENT]

Methods

highlightError()

Highlights a token which causes an issue

public highlightError(string $value) : string
Parameters
$value : string
Return values
string

highlightErrorMessage()

Highlights an error message

public highlightErrorMessage(string $value) : string
Parameters
$value : string
Return values
string

highlightToken()

Highlights a token depending on its type.

public highlightToken(int $type, string $value) : string
Parameters
$type : int
$value : string
Return values
string

output()

Helper function for building string output

public output(string $string) : string
Parameters
$string : string

The string to be quoted

Return values
string —

The quoted string


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results