apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]

Class: Text_Wiki_Render_Xhtml_Function

Source Location: /Text_Wiki-0.24.0/Text/Wiki/Render/Xhtml/Function.php

Class Overview

Text_Wiki_Render
   |
   --Text_Wiki_Render_Xhtml_Function



Variables

Methods


Inherited Variables

Inherited Methods

Class: Text_Wiki_Render

Text_Wiki_Render::Text_Wiki_Render()
Constructor for this render format or rule.
Text_Wiki_Render::formatConf()
Simple method to wrap a configuration in an sprintf() format.
Text_Wiki_Render::getConf()
Simple method to safely get configuration key values.

Class Details

[line 5]


[ Top ]


Class Variables

$conf = array(
       // list separator for params and throws
        'list_sep' => ', ',
        
        // the "main" format string
        'format_main' => '%access %return <b>%name</b> ( %params ) %throws',
        
        // the looped format string for required params
        'format_param' => '%type <i>%descr</i>',
        
        // the looped format string for params with default values
        'format_paramd' => '[%type <i>%descr</i> default %default]',
        
        // the looped format string for throws
        'format_throws' => '<b>throws</b> %type <i>%descr</i>'
    )

[line 7]


Type:   mixed
Overrides:   Array


[ Top ]



Method Detail

token   [line 37]

string token( array $options)

Renders a token into text matching the requested format.
  • Return: The text rendered from the token options.
  • Access: public

Parameters:

array   $options   —  The "options" portion of the token (second element).

[ Top ]


Documentation generated on Mon, 11 Mar 2019 14:22:31 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.