Pelzini

This is the code documentation for the Pelzini project

file /processor/functions.php

Namespace: processor

Available since:

View source


Useful functions

Authors

Functions

get_filenames

Gets all the filenames in a directory and in the subdirectories

htmlify_check_tag

Does processing on a single HTML tag, as provided by a regex in htmlify_text

htmlify_text

This will take the provided text, and turn it into HTML
If it contains HTML, it will validate it, otherwise it
will wrap everything in a PRE

This function also removes extra spaces from the beginning of lines
but will do so in a manner that indenting is preserved

output_status

Outputs a status message

parse_doc_comment

Parses a DocBlock comment tag
Accepts the raw comment text of the comment straight from the file, including all the stars in the middle
Returns an array of tags. Each paremeter will contain an array of the tags that existed, one for each tag
The summary is returned in a 'summary' tag.

The output for a function with two param tags, a return tag and a summary will be something like the following:
array {
  ['@summary'] = '...',
  ['@param'] {
    [0] = '...',
    [1] = '...'
  },
  ['@return'] {
    [0] = '...',
  }
}

parse_tag

Processes the parsing of an individual tag

processor_autoload

Automatically loads the classes that are needed

process_javadoc_tags

Processes the javadoc tags for a specific parser item