Element index for package geshi
Package indexes
[ a ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ k ]
[ l ]
[ o ]
[ p ]
[ r ]
[ s ]
[ t ]
[ u ]
a
- $add_ids
- in file geshi.php, variable GeSHi::$add_ids
Whether CSS IDs should be added to the code
- $allow_multiline_span
- in file geshi.php, variable GeSHi::$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
- in file geshi.php, method GeSHi::add_keyword()
Adds a keyword to a keyword group for highlighting
- add_keyword_group
- in file geshi.php, method GeSHi::add_keyword_group()
Creates a new keyword group
- add_url_to_keyword
- in file geshi.php, method GeSHi::add_url_to_keyword()
Adds a url to a keyword where needed.
c
- $code_style
- in file geshi.php, variable GeSHi::$code_style
The style for the actual code
- change_case
- in file geshi.php, method GeSHi::change_case()
Changes the case of a keyword for those languages where a change is asked for
e
- $enable_important_blocks
- in file geshi.php, variable GeSHi::$enable_important_blocks
Whether important blocks should be recognised or not
- $encoding
- in file geshi.php, variable GeSHi::$encoding
The encoding to use for entity encoding
- $error
- in file geshi.php, variable GeSHi::$error
The error message associated with an error
- $error_messages
- in file geshi.php, variable GeSHi::$error_messages
Possible error messages
- enable_classes
- in file geshi.php, method GeSHi::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
- in file geshi.php, method GeSHi::enable_highlighting()
Enables all highlighting
- enable_ids
- in file geshi.php, method GeSHi::enable_ids()
Whether CSS IDs should be added to each line
- enable_important_blocks
- in file geshi.php, method GeSHi::enable_important_blocks()
Sets whether context-important blocks are highlighted
- enable_inner_code_block
- in file geshi.php, method GeSHi::enable_inner_code_block()
Sets whether to force a surrounding block around the highlighted code or not
- enable_keyword_links
- in file geshi.php, method GeSHi::enable_keyword_links()
Turns linking of keywords on or off.
- enable_line_numbers
- in file geshi.php, method GeSHi::enable_line_numbers()
Sets whether line numbers should be displayed.
- enable_multiline_span
- in file geshi.php, method GeSHi::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
- in file geshi.php, method GeSHi::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
- in file geshi.php, method GeSHi::error()
Returns an error message associated with the last GeSHi operation, or false if no error has occured
f
- $footer_content
- in file geshi.php, variable GeSHi::$footer_content
The content of the footer block
- $footer_content_style
- in file geshi.php, variable GeSHi::$footer_content_style
The style of the footer block
- $force_code_block
- in file geshi.php, variable GeSHi::$force_code_block
Tells if a block around the highlighted source should be forced
- finalise
- in file geshi.php, method GeSHi::finalise()
Takes the parsed code and various options, and creates the HTML surrounding it to make it look nice.
- footer
- in file geshi.php, method GeSHi::footer()
Returns the footer for the code block.
- format_footer_content
- in file geshi.php, method GeSHi::format_footer_content()
Returns the footer content, formatted for output
- format_header_content
- in file geshi.php, method GeSHi::format_header_content()
Returns the header content, formatted for output
g
- GeSHi
- in file geshi.php, method GeSHi::GeSHi()
Creates a new GeSHi object, with source and language
- GeSHi
- in file geshi.php, class GeSHi
The GeSHi Class.
- GESHI_ACTIVE
- in file geshi.php, constant GESHI_ACTIVE
Links in the source in the :active state
- GESHI_AFTER
- in file geshi.php, constant GESHI_AFTER
The key of the regex array defining what bracket group in a
- GESHI_ALWAYS
- in file geshi.php, constant GESHI_ALWAYS
Strict mode always applies
- GESHI_BEFORE
- in file geshi.php, constant GESHI_BEFORE
The key of the regex array defining what bracket group in a
- GESHI_CAPS_LOWER
- in file geshi.php, constant GESHI_CAPS_LOWER
Leave keywords found as the case that they are
- GESHI_CAPS_NO_CHANGE
- in file geshi.php, constant GESHI_CAPS_NO_CHANGE
Lowercase keywords found
- GESHI_CAPS_UPPER
- in file geshi.php, constant GESHI_CAPS_UPPER
Uppercase keywords found
- GESHI_CLASS
- in file geshi.php, constant GESHI_CLASS
The key of the regex array defining a custom keyword to use
- GESHI_COMMENTS
- in file geshi.php, constant GESHI_COMMENTS
Used in language files to mark comments
- GESHI_END_IMPORTANT
- in file geshi.php, constant GESHI_END_IMPORTANT
The ender for important parts of the source
- GESHI_ERROR_FILE_NOT_READABLE
- in file geshi.php, constant GESHI_ERROR_FILE_NOT_READABLE
GeSHi could not open a file for reading (generally a language file)
- GESHI_ERROR_INVALID_HEADER_TYPE
- in file geshi.php, constant GESHI_ERROR_INVALID_HEADER_TYPE
The header type passed to GeSHi::set_header_type() was invalid
- GESHI_ERROR_INVALID_LINE_NUMBER_TYPE
- in file geshi.php, constant GESHI_ERROR_INVALID_LINE_NUMBER_TYPE
The line number type passed to GeSHi::enable_line_numbers() was invalid
- GESHI_ERROR_NO_INPUT
- in file geshi.php, constant GESHI_ERROR_NO_INPUT
No sourcecode to highlight was specified
- GESHI_ERROR_NO_SUCH_LANG
- in file geshi.php, constant GESHI_ERROR_NO_SUCH_LANG
The language specified does not exist
- GESHI_FANCY_LINE_NUMBERS
- in file geshi.php, constant GESHI_FANCY_LINE_NUMBERS
Use fancy line numbers when building the result
- GESHI_HEADER_DIV
- in file geshi.php, constant GESHI_HEADER_DIV
Use a "div" to surround the source
- GESHI_HEADER_NONE
- in file geshi.php, constant GESHI_HEADER_NONE
Use nothing to surround the source
- GESHI_HEADER_PRE
- in file geshi.php, constant GESHI_HEADER_PRE
Use a "pre" to surround the source
- geshi_highlight
- in file geshi.php, function geshi_highlight()
Easy way to highlight stuff. Behaves just like highlight_string
- GESHI_HOVER
- in file geshi.php, constant GESHI_HOVER
Links in the source in the :hover state
- GESHI_LANG_ROOT
- in file geshi.php, constant GESHI_LANG_ROOT
The language file directory for GeSHi
- GESHI_LINK
- in file geshi.php, constant GESHI_LINK
Links in the source in the :link state
- GESHI_MAYBE
- in file geshi.php, constant GESHI_MAYBE
Strict mode *might* apply, and can be enabled or
- GESHI_MODIFIERS
- in file geshi.php, constant GESHI_MODIFIERS
The key of the regex array defining any modifiers to the regular expression
- GESHI_NEVER
- in file geshi.php, constant GESHI_NEVER
Strict mode never applies (this is the most common)
- GESHI_NORMAL_LINE_NUMBERS
- in file geshi.php, constant GESHI_NORMAL_LINE_NUMBERS
Use normal line numbers when building the result
- GESHI_NO_LINE_NUMBERS
- in file geshi.php, constant GESHI_NO_LINE_NUMBERS
Use no line numbers when building the result
- GESHI_REPLACE
- in file geshi.php, constant GESHI_REPLACE
The key of the regex array defining what bracket group in a
- GESHI_ROOT
- in file geshi.php, constant GESHI_ROOT
The root directory for GeSHi
- GESHI_SEARCH
- in file geshi.php, constant GESHI_SEARCH
The key of the regex array defining what to search for
- GESHI_START_IMPORTANT
- in file geshi.php, constant GESHI_START_IMPORTANT
The starter for important parts of the source
- GESHI_VERSION
- in file geshi.php, constant GESHI_VERSION
The version of this GeSHi file
- GESHI_VISITED
- in file geshi.php, constant GESHI_VISITED
Links in the source in the :visited state
- get_attributes
- in file geshi.php, method GeSHi::get_attributes()
Gets the CSS attributes for this code
- get_language_name
- in file geshi.php, method GeSHi::get_language_name()
Gets a human-readable language name (thanks to Simon Patterson for the idea :))
- get_language_name_from_extension
- in file geshi.php, method GeSHi::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
- in file geshi.php, method GeSHi::get_line_style()
Get's the style that is used for the specified line
- get_multiline_span
- in file geshi.php, method GeSHi::get_multiline_span()
Get current setting for multiline spans, see GeSHi::
- get_real_tab_width
- in file geshi.php, method GeSHi::get_real_tab_width()
Returns the tab width to use, based on the current language and user preference
- get_stylesheet
- in file geshi.php, method GeSHi::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_time
- in file geshi.php, method GeSHi::get_time()
Gets the time taken to parse the code
- geshi.php
- procedural page geshi.php
i
- $important_styles
- in file geshi.php, variable GeSHi::$important_styles
Styles for important parts of the code
- indent
- in file geshi.php, method GeSHi::indent()
Swaps out spaces and tabs for HTML indentation. Not needed if the code is in a pre block...
l
- $language
- in file geshi.php, variable GeSHi::$language
The language to use when highlighting
- $language_data
- in file geshi.php, variable GeSHi::$language_data
The data for the language used
- $language_path
- in file geshi.php, variable GeSHi::$language_path
The path to the language files
- $lexic_permissions
- in file geshi.php, variable GeSHi::$lexic_permissions
Array of permissions for which lexics should be highlighted
- $line_ending
- in file geshi.php, variable GeSHi::$line_ending
The line ending If null, nl2br() will be used on the result string.
- $line_nth_row
- in file geshi.php, variable GeSHi::$line_nth_row
The "nth" value for fancy line highlighting
- $line_numbers
- in file geshi.php, variable GeSHi::$line_numbers
Flag for how line nubmers are displayed
- $line_numbers_start
- in file geshi.php, variable GeSHi::$line_numbers_start
Number at which line numbers should start at
- $line_style1
- in file geshi.php, variable GeSHi::$line_style1
Line number styles
- $line_style2
- in file geshi.php, variable GeSHi::$line_style2
Line number styles for fancy lines
- $link_styles
- in file geshi.php, variable GeSHi::$link_styles
The styles for hyperlinks in the code
- $link_target
- in file geshi.php, variable GeSHi::$link_target
Default target for keyword links
- $loaded_language
- in file geshi.php, variable GeSHi::$loaded_language
Currently loaded language file
- load_from_file
- in file geshi.php, method GeSHi::load_from_file()
Given a file name, this method loads its contents in, and attempts
- load_language
- in file geshi.php, method GeSHi::load_language()
Gets language information and stores it for later use
o
- $overall_class
- in file geshi.php, variable GeSHi::$overall_class
The overall class for this code block
- $overall_id
- in file geshi.php, variable GeSHi::$overall_id
The overall ID for this code block
- $overall_style
- in file geshi.php, variable GeSHi::$overall_style
The overall style for this code block
p
- parse_code
- in file geshi.php, method GeSHi::parse_code()
Returns the code in $this->source, highlighted and surrounded by the nessecary HTML.
- parse_non_string_part
- in file geshi.php, method GeSHi::parse_non_string_part()
Takes a string that has no strings or comments in it, and highlights stuff like keywords, numbers and methods.
s
- $source
- in file geshi.php, variable GeSHi::$source
The source code to highlight
- $strict_mode
- in file geshi.php, variable GeSHi::$strict_mode
Whether highlighting is strict or not
- set_brackets_highlighting
- in file geshi.php, method GeSHi::set_brackets_highlighting()
Turns highlighting on/off for brackets
- set_brackets_style
- in file geshi.php, method GeSHi::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
- in file geshi.php, method GeSHi::set_case_keywords()
Sets the case that keywords should use when found. Use the constants:
- set_case_sensitivity
- in file geshi.php, method GeSHi::set_case_sensitivity()
Sets whether a set of keywords are checked for in a case sensitive manner
- set_code_style
- in file geshi.php, method GeSHi::set_code_style()
Sets the style for the actual code. This should be a string
- set_comments_highlighting
- in file geshi.php, method GeSHi::set_comments_highlighting()
Turns highlighting on/off for comment groups
- set_comments_style
- in file geshi.php, method GeSHi::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
- in file geshi.php, method GeSHi::set_encoding()
Sets the encoding used for htmlspecialchars(), for international support.
- set_escape_characters_highlighting
- in file geshi.php, method GeSHi::set_escape_characters_highlighting()
Turns highlighting on/off for escaped characters
- set_escape_characters_style
- in file geshi.php, method GeSHi::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
- in file geshi.php, method GeSHi::set_footer_content()
Sets the content of the footer block
- set_footer_content_style
- in file geshi.php, method GeSHi::set_footer_content_style()
Sets the style for the footer content
- set_header_content
- in file geshi.php, method GeSHi::set_header_content()
Sets the content of the header block
- set_header_content_style
- in file geshi.php, method GeSHi::set_header_content_style()
Sets the style for the header content
- set_header_type
- in file geshi.php, method GeSHi::set_header_type()
Sets the type of header to be used.
- set_highlight_lines_extra_style
- in file geshi.php, method GeSHi::set_highlight_lines_extra_style()
Sets the style for extra-highlighted lines
- set_important_styles
- in file geshi.php, method GeSHi::set_important_styles()
Sets styles for important parts of the code
- set_keyword_group_highlighting
- in file geshi.php, method GeSHi::set_keyword_group_highlighting()
Turns highlighting on/off for a keyword group
- set_keyword_group_style
- in file geshi.php, method GeSHi::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
- in file geshi.php, method GeSHi::set_language()
Sets the language for this object
- set_language_path
- in file geshi.php, method GeSHi::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
- in file geshi.php, method GeSHi::set_line_ending()
Sets the line-ending
- set_line_style
- in file geshi.php, method GeSHi::set_line_style()
Sets the styles for the line numbers.
- set_link_styles
- in file geshi.php, method GeSHi::set_link_styles()
Sets styles for links in code
- set_link_target
- in file geshi.php, method GeSHi::set_link_target()
Sets the target for links in code
- set_methods_highlighting
- in file geshi.php, method GeSHi::set_methods_highlighting()
Turns highlighting on/off for methods
- set_methods_style
- in file geshi.php, method GeSHi::set_methods_style()
Sets the styles for methods. $key is a number that references the
- set_numbers_highlighting
- in file geshi.php, method GeSHi::set_numbers_highlighting()
Turns highlighting on/off for numbers
- set_numbers_style
- in file geshi.php, method GeSHi::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
- in file geshi.php, method GeSHi::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
- in file geshi.php, method GeSHi::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
- in file geshi.php, method GeSHi::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
- in file geshi.php, method GeSHi::set_regexps_highlighting()
Turns highlighting on/off for regexps
- set_regexps_style
- in file geshi.php, method GeSHi::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_source
- in file geshi.php, method GeSHi::set_source()
Sets the source code for this object
- set_strings_highlighting
- in file geshi.php, method GeSHi::set_strings_highlighting()
Turns highlighting on/off for strings
- set_strings_style
- in file geshi.php, method GeSHi::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
- in file geshi.php, method GeSHi::set_symbols_highlighting()
Turns highlighting on/off for symbols
- set_symbols_style
- in file geshi.php, method GeSHi::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
- in file geshi.php, method GeSHi::set_tab_width()
Sets how many spaces a tab is substituted for
- set_time
- in file geshi.php, method GeSHi::set_time()
Sets the time taken to parse the code
- set_url_for_keyword_group
- in file geshi.php, method GeSHi::set_url_for_keyword_group()
Sets the base URL to be used for keywords
- set_use_language_tab_width
- in file geshi.php, method GeSHi::set_use_language_tab_width()
Sets whether or not to use tab-stop width specifed by language
- start_line_numbers_at
- in file geshi.php, method GeSHi::start_line_numbers_at()
Sets what number line numbers should start at. Should be a positive integer, and will be converted to one.
t
- $tab_width
- in file geshi.php, variable GeSHi::$tab_width
The size of tab stops
- $time
- in file geshi.php, variable GeSHi::$time
The time it took to parse the code
|
|
