core
Packages:
Smarty
default
core
bBlog
SmartBee
forsell
PHPMailer

Files:
geshi.php

Classes:
GeSHi

Element index for package core

Package indexes

[ a ] [ d ] [ e ] [ g ] [ h ] [ l ] [ p ] [ r ] [ s ]

a

a

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
d

d

disable_highlighting
in file geshi.php, method GeSHi::disable_highlighting()
    Disables all highlighting
e

e

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_line_numbers
in file geshi.php, method GeSHi::enable_line_numbers()
    Sets whether line numbers should be displayed.
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
g

g

geshi.php
procedural page geshi.php
GeSHi
in file geshi.php, class GeSHi
    The GeSHi Class.
GeSHi
in file geshi.php, method GeSHi::GeSHi()
    Creates a new GeSHi object, with source and language
GESHI_ACTIVE
in file geshi.php, constant GESHI_ACTIVE
    Links in the source in the :active state
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_DIR_SEPARATOR
in file geshi.php, constant GESHI_DIR_SEPARATOR
    Set the correct directory separator
GESHI_END_IMPORTANT
in file geshi.php, constant GESHI_END_IMPORTANT
    The ender for important parts of the source
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
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_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_OUTPUT_HTML
in file geshi.php, constant GESHI_OUTPUT_HTML
    For the future (though this may never be realised)
GESHI_ROOT
in file geshi.php, constant GESHI_ROOT
    The root directory for GeSHi
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_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_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
h

h

highlight_lines_extra
in file geshi.php, method GeSHi::highlight_lines_extra()
    Specifies which lines to highlight extra
l

l

load_from_file
in file geshi.php, method GeSHi::load_from_file()
    Given a file name, this method loads its contents in, and attempts
p

p

parse_code
in file geshi.php, method GeSHi::parse_code()
    Returns the code in $this->source, highlighted and surrounded by the nessecary HTML.
r

r

remove_keyword
in file geshi.php, method GeSHi::remove_keyword()
    Removes a keyword from a keyword group
remove_keyword_group
in file geshi.php, method GeSHi::remove_keyword_group()
    Removes a keyword group
s

s

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_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_url_for_keyword_group
in file geshi.php, method GeSHi::set_url_for_keyword_group()
    Sets the base URL to be used for keywords
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.