[geshi] element index

Package indexes

All elements
a b c d e f g h i k l m o p r s t u _
_
top
$_hmr_after
GeSHi::$_hmr_after in geshi.php
$_hmr_before
GeSHi::$_hmr_before in geshi.php
some "callback parameters" for handle_multiline_regexps
$_hmr_key
GeSHi::$_hmr_key in geshi.php
$_hmr_replace
$_kw_replace_group
Work around for Suhosin Patch with disabled /e modifier
$_rx_key
GeSHi::$_rx_key in geshi.php
_genCSSName
_optimize_regexp_list_tokens_to_string
this function creates the appropriate regexp string of an token array you should not call this function directly, @see $this->optimize_regexp_list().
a
top
$add_ids
GeSHi::$add_ids in geshi.php
Whether CSS IDs should be added to the code
$allow_multiline_span
Flag to decide if multi line spans are allowed. Set it to false to make sure each tag is closed before and reopened after each linefeed.
add_keyword
Adds a keyword to a keyword group for highlighting
add_keyword_group
Creates a new keyword group
b
top
build_parse_cache
Setup caches needed for parsing. This is automatically called in parse_code() when appropriate.
build_style_cache
Setup caches needed for styling. This is automatically called in
c
top
$code_style
GeSHi::$code_style in geshi.php
The style for the actual code
change_case
Changes the case of a keyword for those languages where a change is asked for
d
top
disable_highlighting
Disables all highlighting
e
top
$enable_important_blocks
Whether important blocks should be recognised or not
$encoding
GeSHi::$encoding in geshi.php
The encoding to use for entity encoding
$error
GeSHi::$error in geshi.php
The error message associated with an error
$error_messages
Possible error messages
enable_classes
Sets whether CSS classes should be used to highlight the source. Default is off, calling this method with no arguments will turn it on
enable_highlighting
Enables all highlighting
enable_ids
GeSHi::enable_ids() in geshi.php
Whether CSS IDs should be added to each line
enable_important_blocks
Sets whether context-important blocks are highlighted
enable_inner_code_block
Sets whether to force a surrounding block around the highlighted code or not
enable_keyword_links
Turns linking of keywords on or off.
enable_line_numbers
Sets whether line numbers should be displayed.
enable_multiline_span
Sets wether spans and other HTML markup generated by GeSHi can span over multiple lines or not. Defaults to true to reduce overhead.
enable_strict_mode
Enables/disables strict highlighting. Default is off, calling this method without parameters will turn it on. See documentation for more details on strict mode and where to use it.
error
GeSHi::error() in geshi.php
Returns an error message associated with the last GeSHi operation, or false if no error has occured
f
top
$footer_content
The content of the footer block
$footer_content_style
The style of the footer block
$force_code_block
Tells if a block around the highlighted source should be forced
finalise
GeSHi::finalise() in geshi.php
Takes the parsed code and various options, and creates the HTML surrounding it to make it look nice.
footer
GeSHi::footer() in geshi.php
Returns the footer for the code block.
g
top
GeSHi
GeSHi in geshi.php
The GeSHi Class.
GeSHi
GeSHi::GeSHi() in geshi.php
Creates a new GeSHi object, with source and language
GESHI_ACTIVE
GESHI_ACTIVE in geshi.php
Links in the source in the :active state
GESHI_AFTER
GESHI_AFTER in geshi.php
The key of the regex array defining what bracket group in a
GESHI_ALWAYS
GESHI_ALWAYS in geshi.php
Strict mode always applies
GESHI_BEFORE
GESHI_BEFORE in geshi.php
The key of the regex array defining what bracket group in a
GESHI_CAPS_LOWER
GESHI_CAPS_LOWER in geshi.php
Leave keywords found as the case that they are
GESHI_CAPS_NO_CHANGE
Lowercase keywords found
GESHI_CAPS_UPPER
GESHI_CAPS_UPPER in geshi.php
Uppercase keywords found
GESHI_CLASS
GESHI_CLASS in geshi.php
The key of the regex array defining a custom keyword to use
GESHI_COMMENTS
GESHI_COMMENTS in geshi.php
Used in language files to mark comments
GESHI_END_IMPORTANT
GESHI_END_IMPORTANT in geshi.php
The ender for important parts of the source
GESHI_ERROR_FILE_NOT_READABLE
GeSHi could not open a file for reading (generally a language file)
GESHI_ERROR_INVALID_HEADER_TYPE
The header type passed to GeSHi->set_header_type() was invalid
GESHI_ERROR_INVALID_LINE_NUMBER_TYPE
The line number type passed to GeSHi->enable_line_numbers() was invalid
GESHI_ERROR_NO_INPUT
No sourcecode to highlight was specified
GESHI_ERROR_NO_SUCH_LANG
The language specified does not exist
GESHI_FANCY_LINE_NUMBERS
Use fancy line numbers when building the result
GESHI_HEADER_DIV
GESHI_HEADER_DIV in geshi.php
Use a "div" to surround the source
GESHI_HEADER_NONE
GESHI_HEADER_NONE in geshi.php
Use nothing to surround the source
GESHI_HEADER_PRE
GESHI_HEADER_PRE in geshi.php
Use a "pre" to surround the source
GESHI_HEADER_PRE_TABLE
Use a "table" to surround the source:
GESHI_HEADER_PRE_VALID
Use a pre to wrap lines when line numbers are enabled or to wrap the whole code.
geshi_highlight
geshi_highlight() in geshi.php
Easy way to highlight stuff. Behaves just like highlight_string
GESHI_HOVER
GESHI_HOVER in geshi.php
Links in the source in the :hover state
GESHI_LANG_ROOT
GESHI_LANG_ROOT in geshi.php
The language file directory for GeSHi
GESHI_LINK
GESHI_LINK in geshi.php
Links in the source in the :link state
GESHI_MAX_PCRE_LENGTH
it's also important not to generate too long regular expressions
GESHI_MAX_PCRE_SUBPATTERNS
some old PHP / PCRE subpatterns only support up to xxx subpatterns in
GESHI_MAYBE
GESHI_MAYBE in geshi.php
Strict mode *might* apply, and can be enabled or
GESHI_MODIFIERS
GESHI_MODIFIERS in geshi.php
The key of the regex array defining any modifiers to the regular expression
GESHI_NEVER
GESHI_NEVER in geshi.php
Strict mode never applies (this is the most common)
GESHI_NORMAL_LINE_NUMBERS
Use normal line numbers when building the result
GESHI_NO_LINE_NUMBERS
Use no line numbers when building the result
GESHI_NUMBER_BIN_PREFIX_0B
Number format to highlight binary numbers with a prefix 0b (C)
GESHI_NUMBER_BIN_PREFIX_PERCENT
Number format to highlight binary numbers with a prefix %
GESHI_NUMBER_BIN_SUFFIX
Number format to highlight binary numbers with a suffix "b"
GESHI_NUMBER_FLT_NONSCI
Number format to highlight floating-point numbers without support for scientific notation
GESHI_NUMBER_FLT_NONSCI_F
Number format to highlight floating-point numbers without support for scientific notation
GESHI_NUMBER_FLT_SCI_SHORT
Number format to highlight floating-point numbers with support for scientific notation (E) and optional leading zero
GESHI_NUMBER_FLT_SCI_ZERO
Number format to highlight floating-point numbers with support for scientific notation (E) and required leading digit
GESHI_NUMBER_HEX_PREFIX
Number format to highlight hex numbers with a prefix 0x
GESHI_NUMBER_HEX_PREFIX_DOLLAR
Number format to highlight hex numbers with a prefix $
GESHI_NUMBER_HEX_SUFFIX
Number format to highlight hex numbers with a suffix of h
GESHI_NUMBER_INT_BASIC
Basic number format for integers
GESHI_NUMBER_INT_CSTYLE
Enhanced number format for integers like seen in C
GESHI_NUMBER_OCT_PREFIX
Number format to highlight octal numbers with a leading zero
GESHI_NUMBER_OCT_PREFIX_0O
Number format to highlight octal numbers with a prefix 0o (logtalk)
GESHI_NUMBER_OCT_PREFIX_AT
Number format to highlight octal numbers with a leading @ (Used in HiSofts Devpac series).
GESHI_NUMBER_OCT_SUFFIX
Number format to highlight octal numbers with a suffix of o
GESHI_PHP_PRE_433
GESHI_PHP_PRE_433 in geshi.php
Used to work around missing PHP features *
GESHI_REPLACE
GESHI_REPLACE in geshi.php
The key of the regex array defining what bracket group in a
GESHI_ROOT
GESHI_ROOT in geshi.php
The root directory for GeSHi
GESHI_SEARCH
GESHI_SEARCH in geshi.php
The key of the regex array defining what to search for
GESHI_SECURITY_PARANOID
Tells GeSHi to be paranoid about security settings
GESHI_START_IMPORTANT
The starter for important parts of the source
GESHI_VERSION
GESHI_VERSION in geshi.php
The version of this GeSHi file
GESHI_VISITED
GESHI_VISITED in geshi.php
Links in the source in the :visited state
get_language_fullname
Get full_name for a lang or false.
get_language_name
Gets a human-readable language name (thanks to Simon Patterson for the idea :))
get_language_name_from_extension
Given a file extension, this method returns either a valid geshi language name, or the empty string if it couldn't be found
get_line_style
Get's the style that is used for the specified line
get_multiline_span
Get current setting for multiline spans, see GeSHi->enable_multiline_span().
get_real_tab_width
Returns the tab width to use, based on the current language and user preference
get_stylesheet
Returns a stylesheet for the highlighted code. If $economy mode is true, we only return the stylesheet declarations that matter for this code block instead of the whole thing
get_supported_languages
Get supported langs or an associative array lang=>full_name.
get_time
GeSHi::get_time() in geshi.php
Gets the time taken to parse the code
geshi.php
geshi.php in geshi.php
h
top
$header_content
The content of the header block
$header_content_style
The style of the header block
$header_type
GeSHi::$header_type in geshi.php
The type of header to use. Can be one of the following values:
$highlight_extra_lines
Lines that should be highlighted extra
$highlight_extra_lines_style
Styles of extra-highlighted lines
$highlight_extra_lines_styles
Styles of lines that should be highlighted extra
handle_keyword_replace
Handles replacements of keywords to include markup and links if requested
handle_multiline_regexps
handles newlines in REGEXPS matches. Set the _hmr_* vars before calling this
handle_regexps_callback
handles regular expressions highlighting-definitions with callback functions
header
GeSHi::header() in geshi.php
Creates the header for the code block (with correct attributes)
highlight_lines_extra
Specifies which lines to highlight extra
hsc
GeSHi::hsc() in geshi.php
Secure replacement for PHP built-in function htmlspecialchars().
i
top
$important_styles
Styles for important parts of the code
indent
GeSHi::indent() in geshi.php
Swaps out spaces and tabs for HTML indentation. Not needed if the code is in a pre block...
k
top
$keyword_links
Should keywords be linked?
l
top
$language
GeSHi::$language in geshi.php
The language to use when highlighting
$language_data
The data for the language used
$language_path
The path to the language files
$lexic_permissions
Array of permissions for which lexics should be highlighted
$line_ending
GeSHi::$line_ending in geshi.php
The line ending If null, nl2br() will be used on the result string.
$line_nth_row
The "nth" value for fancy line highlighting
$line_numbers
Flag for how line numbers are displayed
$line_numbers_start
Number at which line numbers should start at
$line_style1
GeSHi::$line_style1 in geshi.php
Line number styles
$line_style2
GeSHi::$line_style2 in geshi.php
Line number styles for fancy lines
$link_styles
GeSHi::$link_styles in geshi.php
The styles for hyperlinks in the code
$link_target
GeSHi::$link_target in geshi.php
Default target for keyword links
$loaded_language
Currently loaded language file
load_from_file
Given a file name, this method loads its contents in, and attempts
load_language
Gets language information and stores it for later use
m
top
merge_arrays
Merges arrays recursively, overwriting values of the first array with values of later arrays
o
top
$overall_class
The overall class for this code block
$overall_id
GeSHi::$overall_id in geshi.php
The overall ID for this code block
$overall_style
The overall style for this code block
optimize_keyword_group
compile optimized regexp list for keyword group
optimize_regexp_list
this functions creates an optimized regular expression list of an array of strings.
p
top
$parse_cache_built
Wether the caches needed for parsing are built or not
parse_code
GeSHi::parse_code() in geshi.php
Returns the code in $this->source, highlighted and surrounded by the nessecary HTML.
parse_non_string_part
Takes a string that has no strings or comments in it, and highlights stuff like keywords, numbers and methods.
r
top
remove_keyword
Removes a keyword from a keyword group
remove_keyword_group
Removes a keyword group
replace_keywords
Replaces certain keywords in the header and footer with certain configuration values
s
top
$source
GeSHi::$source in geshi.php
The source code to highlight
$strict_mode
GeSHi::$strict_mode in geshi.php
Whether highlighting is strict or not
set_brackets_highlighting
Turns highlighting on/off for brackets
set_brackets_style
Sets the styles for brackets. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority
set_case_keywords
Sets the case that keywords should use when found. Use the constants:
set_case_sensitivity
Sets whether a set of keywords are checked for in a case sensitive manner
set_code_style
Sets the style for the actual code. This should be a string
set_comments_highlighting
Turns highlighting on/off for comment groups
set_comments_style
Sets the styles for comment groups. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority
set_encoding
Sets the encoding used for htmlspecialchars(), for international support.
set_escape_characters_highlighting
Turns highlighting on/off for escaped characters
set_escape_characters_style
Sets the styles for escaped characters. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority
set_footer_content
Sets the content of the footer block
set_footer_content_style
Sets the style for the footer content
set_header_content
Sets the content of the header block
set_header_content_style
Sets the style for the header content
set_header_type
Sets the type of header to be used.
set_highlight_lines_extra_style
Sets the style for extra-highlighted lines
set_important_styles
Sets styles for important parts of the code
set_keyword_group_highlighting
Turns highlighting on/off for a keyword group
set_keyword_group_style
Sets the style for a keyword group. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority
set_language
Sets the language for this object
set_language_path
Sets the path to the directory containing the language files. Note that this path is relative to the directory of the script that included geshi.php, NOT geshi.php itself.
set_line_ending
Sets the line-ending
set_line_style
Sets the styles for the line numbers.
set_link_styles
Sets styles for links in code
set_link_target
Sets the target for links in code
set_methods_highlighting
Turns highlighting on/off for methods
set_methods_style
Sets the styles for methods. $key is a number that references the
set_numbers_highlighting
Turns highlighting on/off for numbers
set_numbers_style
Sets the styles for numbers. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority
set_overall_class
Sets the overall classname for this block of code. This class can then be used in a stylesheet to style this object's output
set_overall_id
Sets the overall id for this block of code. This id can then be used in a stylesheet to style this object's output
set_overall_style
Sets the styles for the code that will be outputted when this object is parsed. The style should be a string of valid stylesheet declarations
set_regexps_highlighting
Turns highlighting on/off for regexps
set_regexps_style
Sets the styles for regexps. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority
set_script_style
Sets the styles for strict code blocks. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority
set_source
GeSHi::set_source() in geshi.php
Sets the source code for this object
set_strings_highlighting
Turns highlighting on/off for strings
set_strings_style
Sets the styles for strings. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority
set_symbols_highlighting
Turns highlighting on/off for symbols
set_symbols_style
Sets the styles for symbols. If $preserve_defaults is true, then styles are merged with the default styles, with the user defined styles having priority
set_tab_width
Sets how many spaces a tab is substituted for
set_time
GeSHi::set_time() in geshi.php
Sets the time taken to parse the code
set_url_for_keyword_group
Sets the base URL to be used for keywords
set_use_language_tab_width
Sets whether or not to use tab-stop width specifed by language
start_line_numbers_at
Sets what number line numbers should start at. Should be a positive integer, and will be converted to one.
t
top
$table_linenumber_style
Style for line numbers when GESHI_HEADER_PRE_TABLE is chosen
$tab_width
GeSHi::$tab_width in geshi.php
The size of tab stops
$time
GeSHi::$time in geshi.php
The time it took to parse the code
u
top
$use_classes
GeSHi::$use_classes in geshi.php
Whether to use CSS classes in output
$use_language_tab_width
Should we use language-defined tab stop widths?
a b c d e f g h i k l m o p r s t u _