Full index

Package indexes

geshi

a

top

add_keyword: GeSHi::add_keyword() in geshi.php

Adds a keyword to a keyword group for highlighting
add_keyword_group: GeSHi::add_keyword_group() in geshi.php

Creates a new keyword group

d

top

disable_highlighting: GeSHi::disable_highlighting() in geshi.php

Disables all highlighting

e

top

enable_classes: GeSHi::enable_classes() in geshi.php

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: GeSHi::enable_highlighting() in geshi.php

Enables all highlighting
enable_ids: GeSHi::enable_ids() in geshi.php

Whether CSS IDs should be added to each line
enable_important_blocks: GeSHi::enable_important_blocks() in geshi.php

Sets whether context-important blocks are highlighted
enable_inner_code_block: GeSHi::enable_inner_code_block() in geshi.php

Sets whether to force a surrounding block around the highlighted code or not
enable_keyword_links: GeSHi::enable_keyword_links() in geshi.php

Turns linking of keywords on or off.
enable_line_numbers: GeSHi::enable_line_numbers() in geshi.php

Sets whether line numbers should be displayed.
enable_multiline_span: GeSHi::enable_multiline_span() in geshi.php

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: GeSHi::enable_strict_mode() in geshi.php

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

g

top

GeSHi: GeSHi::GeSHi() in geshi.php

Creates a new GeSHi object, with source and language
GeSHi: GeSHi in geshi.php

The GeSHi Class.
geshi.php: geshi.php in geshi.php
GESHI_ACTIVE: GESHI_ACTIVE in geshi.php

Links in the source in the :active state
GESHI_CAPS_LOWER: GESHI_CAPS_LOWER in geshi.php

Leave keywords found as the case that they are
GESHI_CAPS_NO_CHANGE: GESHI_CAPS_NO_CHANGE in geshi.php

Lowercase keywords found
GESHI_CAPS_UPPER: GESHI_CAPS_UPPER in geshi.php

Uppercase keywords found
GESHI_END_IMPORTANT: GESHI_END_IMPORTANT in geshi.php

The ender for important parts of the source
GESHI_FANCY_LINE_NUMBERS: GESHI_FANCY_LINE_NUMBERS in geshi.php

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: GESHI_HEADER_PRE_TABLE in geshi.php

Use a "table" to surround the source:
GESHI_HEADER_PRE_VALID: GESHI_HEADER_PRE_VALID in geshi.php

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_NORMAL_LINE_NUMBERS: GESHI_NORMAL_LINE_NUMBERS in geshi.php

Use normal line numbers when building the result
GESHI_NO_LINE_NUMBERS: GESHI_NO_LINE_NUMBERS in geshi.php

Use no line numbers when building the result
GESHI_ROOT: GESHI_ROOT in geshi.php

The root directory for GeSHi
GESHI_SECURITY_PARANOID: GESHI_SECURITY_PARANOID in geshi.php

Tells GeSHi to be paranoid about security settings
GESHI_START_IMPORTANT: GESHI_START_IMPORTANT in geshi.php

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_name: GeSHi::get_language_name() in geshi.php

Gets a human-readable language name (thanks to Simon Patterson for the idea :))
get_language_name_from_extension: GeSHi::get_language_name_from_extension() in geshi.php

Given a file extension, this method returns either a valid geshi language name, or the empty string if it couldn't be found
get_multiline_span: GeSHi::get_multiline_span() in geshi.php

Get current setting for multiline spans, see GeSHi->enable_multiline_span().
get_real_tab_width: GeSHi::get_real_tab_width() in geshi.php

Returns the tab width to use, based on the current language and user preference
get_stylesheet: GeSHi::get_stylesheet() in geshi.php

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_time: GeSHi::get_time() in geshi.php

Gets the time taken to parse the code

h

top

highlight_lines_extra: GeSHi::highlight_lines_extra() in geshi.php

Specifies which lines to highlight extra

l

top

load_from_file: GeSHi::load_from_file() in geshi.php

Given a file name, this method loads its contents in, and attempts

o

top

optimize_keyword_group: GeSHi::optimize_keyword_group() in geshi.php

compile optimized regexp list for keyword group

p

top

parse_code: GeSHi::parse_code() in geshi.php

Returns the code in $this->source, highlighted and surrounded by the nessecary HTML.

r

top

remove_keyword: GeSHi::remove_keyword() in geshi.php

Removes a keyword from a keyword group
remove_keyword_group: GeSHi::remove_keyword_group() in geshi.php

Removes a keyword group

s

top

set_brackets_highlighting: GeSHi::set_brackets_highlighting() in geshi.php

Turns highlighting on/off for brackets
set_brackets_style: GeSHi::set_brackets_style() in geshi.php

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: GeSHi::set_case_keywords() in geshi.php

Sets the case that keywords should use when found. Use the constants:
set_case_sensitivity: GeSHi::set_case_sensitivity() in geshi.php

Sets whether a set of keywords are checked for in a case sensitive manner
set_code_style: GeSHi::set_code_style() in geshi.php

Sets the style for the actual code. This should be a string
set_comments_highlighting: GeSHi::set_comments_highlighting() in geshi.php

Turns highlighting on/off for comment groups
set_comments_style: GeSHi::set_comments_style() in geshi.php

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: GeSHi::set_encoding() in geshi.php

Sets the encoding used for htmlspecialchars(), for international support.
set_escape_characters_highlighting: GeSHi::set_escape_characters_highlighting() in geshi.php

Turns highlighting on/off for escaped characters
set_escape_characters_style: GeSHi::set_escape_characters_style() in geshi.php

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: GeSHi::set_footer_content() in geshi.php

Sets the content of the footer block
set_footer_content_style: GeSHi::set_footer_content_style() in geshi.php

Sets the style for the footer content
set_header_content: GeSHi::set_header_content() in geshi.php

Sets the content of the header block
set_header_content_style: GeSHi::set_header_content_style() in geshi.php

Sets the style for the header content
set_header_type: GeSHi::set_header_type() in geshi.php

Sets the type of header to be used.
set_highlight_lines_extra_style: GeSHi::set_highlight_lines_extra_style() in geshi.php

Sets the style for extra-highlighted lines
set_important_styles: GeSHi::set_important_styles() in geshi.php

Sets styles for important parts of the code
set_keyword_group_highlighting: GeSHi::set_keyword_group_highlighting() in geshi.php

Turns highlighting on/off for a keyword group
set_keyword_group_style: GeSHi::set_keyword_group_style() in geshi.php

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: GeSHi::set_language() in geshi.php

Sets the language for this object
set_language_path: GeSHi::set_language_path() in geshi.php

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: GeSHi::set_line_ending() in geshi.php

Sets the line-ending
set_line_style: GeSHi::set_line_style() in geshi.php

Sets the styles for the line numbers.
set_link_styles: GeSHi::set_link_styles() in geshi.php

Sets styles for links in code
set_link_target: GeSHi::set_link_target() in geshi.php

Sets the target for links in code
set_methods_highlighting: GeSHi::set_methods_highlighting() in geshi.php

Turns highlighting on/off for methods
set_methods_style: GeSHi::set_methods_style() in geshi.php

Sets the styles for methods. $key is a number that references the
set_numbers_highlighting: GeSHi::set_numbers_highlighting() in geshi.php

Turns highlighting on/off for numbers
set_numbers_style: GeSHi::set_numbers_style() in geshi.php

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: GeSHi::set_overall_class() in geshi.php

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: GeSHi::set_overall_id() in geshi.php

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: GeSHi::set_overall_style() in geshi.php

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: GeSHi::set_regexps_highlighting() in geshi.php

Turns highlighting on/off for regexps
set_regexps_style: GeSHi::set_regexps_style() in geshi.php

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_source: GeSHi::set_source() in geshi.php

Sets the source code for this object
set_strings_highlighting: GeSHi::set_strings_highlighting() in geshi.php

Turns highlighting on/off for strings
set_strings_style: GeSHi::set_strings_style() in geshi.php

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: GeSHi::set_symbols_highlighting() in geshi.php

Turns highlighting on/off for symbols
set_symbols_style: GeSHi::set_symbols_style() in geshi.php

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: GeSHi::set_tab_width() in geshi.php

Sets how many spaces a tab is substituted for
set_url_for_keyword_group: GeSHi::set_url_for_keyword_group() in geshi.php

Sets the base URL to be used for keywords
set_use_language_tab_width: GeSHi::set_use_language_tab_width() in geshi.php

Sets whether or not to use tab-stop width specifed by language
start_line_numbers_at: GeSHi::start_line_numbers_at() in geshi.php

Sets what number line numbers should start at. Should be a positive integer, and will be converted to one.