Pelzini

This is the code documentation for the Pelzini project

namespace viewer

Namespaces

Classes

FieldTreeNodeMatcher

Finds nodes in the tree which have a specified field which matches a specified value

PHPCodeRenderer

Does code rendering for PHP

RootTreeNode

The root node in a tree

SelectQuery

This class simplifies the creation of select queries

TreeNode

A node in a tree

Interfaces

TreeNodeMatcher

The generic interface for classes which look for nodes that match specific conditions

Functions

clearParams

Clears all named parameters that are used by the str function

create_classes_tree

Loads a tree of the classes, based on 'extends'

db_affected_rows

Returns the number of rows affected by the last SQLite query that was executed.
SQLite has no affected rows system. Assume if there is a result, that rows were affected.

db_affected_rows

Returns the number of rows affected by the last MySQL query that was executed

db_affected_rows

Returns the number of rows affected by the last PostgreSQL query that was executed

db_connect

Connects to the SQLite database

db_connect

Connects to the MySQL database

db_connect

Connects to the PostgreSQL database

db_escape

Escapses a string for use by the SQLite database

db_escape

Escapses a string for use by the MySQL database

db_escape

Escapses a string for use by the PostgreSQL database

db_fetch_assoc

Fetches a SQLite result set as an associative array

db_fetch_assoc

Fetches a MySQL result set as an associative array

db_fetch_assoc

Fetches a PostgreSQL result set as an associative array

db_insert_id

Returns the last unique ID generated by a query

db_insert_id

Returns the last unique ID generated by a query

db_insert_id

Returns the last unique ID generated by a query

db_num_rows

Returns the number of rows in a SQLite result set

db_num_rows

Returns the number of rows in a MySQL result set

db_num_rows

Returns the number of rows in a PostgreSQL result set

db_query

Makes a query to the SQLite database

db_query

Makes a query to the MySQL database

db_query

Makes a query to the PostgreSQL database

db_quote

Quotes a string as nessasary for use by hte SQLite database
The result will be different depending on the type of the input.
 - a number will be left as is
 - a string will be quoted
 - a null value will be returned as NULL

db_quote

Quotes a string as nessasary for use by hte MySQL database
The result will be different depending on the type of the input.
 - a number will be left as is
 - a string will be quoted
 - a null value will be returned as NULL

db_quote

Quotes a string as nessasary for use by hte PostgreSQL database
The result will be different depending on the type of the input.
 - a number will be left as is
 - a string will be quoted
 - a null value will be returned as NULL

delink_inline

Replaces an inline @link or @see with the plain-text version of that @link or @see.
This is used in places where excessive links are overkill.

fix_magic_quotes

Fixes all magically quoted strings in the given array or string

getOriginalString

Returns the original string from the string table, without any parameter replacement

get_class_link

Return a link to a given class

get_file_link

Return a link to a given file

get_function_link

Return a link to a given function

get_interface_link

Return a link to a given interface

get_namespace_link

Return a link to a given namespace

get_object_link

Determines the link for a specified name (might be a class, an interface or a function)

get_since_version

Gets HTML for a version, based on the version id

get_source_link

Return a link to the source view for a file

loadLanguage

Loads a language file

If you are using a language which may not be complete, it is advisable
to load another language which you know is complete first (e.g. English)
This will prevent empty strings being returned.

param_replace

Replaces params in strings

Replacements can be in the following forms:
  {PARAM}
  Does a replacement with a named parameter, PARAM, specified in any case

  {#PLURAL|PARAM|SINGLE|MULTIPLE}
  Does a replacement with SINGLE if PARAM (any case) is 1, and with MULTIPLE if PARAM is anything else

  {#NL}
  Adds a new line to the output

  {#URLENC|PARAM}
  Returns the specified parameter, urlencode()ed.

  {#HTMLENC|PARAM}
  Returns the specified parameter, htmlspecialchars()ed.

param_replace_inner

Does the actual legwork for param_replace

process_inline

Processes inline tags within text

process_inline_delink

Replaces the content of a @link or @see tag with the plain text version of the link
The content is defines as the part after @link or @see, up to the closing curly bracket

process_inline_link

Replaces the content of a @link or @see tag with its actual link.
The content is defines as the part after @link or @see, up to the closing curly bracket

search_source

Does a source search.

setParam

Sets a named param for use by the str function

show_authors

Echos a list of all of the authors of a specifc item

show_examples

Shows the examples a specific file, function or class

show_see_also

Shows the 'see also' things for a specific file, function or class

show_tables

Shows the tables used by a specific file, function or class

show_tags

Echos a list of all of the authors of a specifc item

str

Outputs a string, and sets arguments

This function also allows additional functions after the string constant, printf style.
Because the language system uses named arguments, arguments should be specified in pairs
The first argument should be the param name, the second argument should be the param