pygments.lexers.php.PhpLexer

class documentation

class PhpLexer(RegexLexer): (source)

For PHP source code. For PHP embedded in HTML, use the `HtmlPhpLexer`. Additional options accepted: `startinline` If given and ``True`` the lexer starts highlighting with php code (i.e.: no starting ``<?php`` required). The default is ``False``. `funcnamehighlighting` If given and ``True``, highlight builtin function names (default: ``True``). `disabledmodules` If given, must be a list of module names whose function names should not be highlighted. By default all modules are highlighted except the special ``'unknown'`` module that includes functions that are known to php but are undocumented. To get a list of allowed modules have a look into the `_php_builtins` module: .. sourcecode:: pycon >>> from pygments.lexers._php_builtins import MODULES >>> MODULES.keys() ['PHP Options/Info', 'Zip', 'dba', ...] In fact the names of those modules match the module names from the php documentation.

Method	`__init__`	Undocumented
Method	`analyse_text`	Has to return a float between ``0`` and ``1`` that indicates if a lexer wants to highlight this text. Used by ``guess_lexer``. If this method returns ``0`` it won't highlight it in any case, if it returns ``1`` highlighting with this lexer is guaranteed.
Method	`get_tokens_unprocessed`	Split ``text`` into (tokentype, text) pairs.
Class Variable	`aliases`	Undocumented
Class Variable	`filenames`	Undocumented
Class Variable	`flags`	Undocumented
Class Variable	`mimetypes`	Undocumented
Class Variable	`name`	Undocumented
Class Variable	`tokens`	Undocumented
Class Variable	`url`	Undocumented
Instance Variable	`disabledmodules`	Undocumented
Instance Variable	`funcnamehighlighting`	Undocumented
Instance Variable	`startinline`	Undocumented
Class Variable	`_ident_inner`	Undocumented
Class Variable	`_ident_nons`	Undocumented
Instance Variable	`_functions`	Undocumented

Inherited from Lexer (via RegexLexer):

Method	`__repr__`	Undocumented
Method	`add_filter`	Add a new stream filter to this lexer.
Method	`get_tokens`	Return an iterable of (tokentype, value) pairs generated from `text`. If `unfiltered` is set to `True`, the filtering mechanism is bypassed even if filters are defined.
Class Variable	`alias_filenames`	Undocumented
Class Variable	`priority`	Undocumented
Instance Variable	`encoding`	Undocumented
Instance Variable	`ensurenl`	Undocumented
Instance Variable	`filters`	Undocumented
Instance Variable	`options`	Undocumented
Instance Variable	`stripall`	Undocumented
Instance Variable	`stripnl`	Undocumented
Instance Variable	`tabsize`	Undocumented

def __init__(self, **options): (source) ¶

overrides pygments.lexer.Lexer.__init__

Undocumented

def analyse_text(text): (source) ¶

overrides pygments.lexer.Lexer.analyse_text

Has to return a float between ``0`` and ``1`` that indicates if a lexer wants to highlight this text. Used by ``guess_lexer``. If this method returns ``0`` it won't highlight it in any case, if it returns ``1`` highlighting with this lexer is guaranteed. The `LexerMeta` metaclass automatically wraps this function so that it works like a static method (no ``self`` or ``cls`` parameter) and the return value is automatically converted to `float`. If the return value is an object that is boolean `False` it's the same as if the return values was ``0.0``.

def get_tokens_unprocessed(self, text): (source) ¶

overrides pygments.lexer.RegexLexer.get_tokens_unprocessed

Split ``text`` into (tokentype, text) pairs. ``stack`` is the initial stack (default: ``['root']``)

aliases: list[str] = (source) ¶

overrides pygments.lexer.Lexer.aliases

Undocumented

filenames: list[str] = (source) ¶

overrides pygments.lexer.Lexer.filenames

Undocumented

flags = (source) ¶

Undocumented

mimetypes: list[str] = (source) ¶