FUEL CMS User Guide : Version 1.4.4


User Guide Helper

Contains several convenience functions for creating user documentation.

Function Reference [+]

user_guide_url(['$uri'=''])

Convenience function to easily create user guide urls.

Returns

string

Parameters

(string) $uri URI location

Example


 echo user_guide_url('libraries/assets');
 

generate_docs('$class', ['$folder'='libraries'], ['$module'=NULL], [$vars=array()])

Generates the class documentation based on the class passed to it. Shortcut to the Fuel_user_guide::generate_docs() method.

Returns

string

Parameters

(string) $class Name of class
(array) $folder Variables to be passed to the layout
(string) $module Module folder name
(string) $vars Subfolder in module. Deafult is the libraries

Example


 $vars = array('intro');
 echo generate_class_docs('Fuel_cache', $vars);
 

generate_toc(['$folder'=NULL], ['$module'=NULL], [$exclude=array()], ['$return_array'=FALSE])

Returns a table of contents for your documentation. Shortcut to the Fuel_user_guide::generate_toc() method.

Returns

string

Parameters

(stirng) $folder The name of the module to generate the table of contents. If no module is provided, it will look at the current URI path (optional)
(string) $module Module folder name (optional)
(array) $exclude An array of files to exclude from the list (optional)
(boolean) $return_array Whether to return an array of values or a view (optional)

generate_config_info(['$module'=NULL])

Returns a list of configuration parameter for the advanced module. Shortcut to the Fuel_user_guide::generate_config_info() method.

Returns

string

Parameters

(stirng) $module The name of the module to generate the table of contents. If no module is provided, it will look at the current URI path (optional)

user_guide_block('$block', [$vars=array()], ['$return'=TRUE])

Returns a single display option. Shortcut to the Fuel_user_guide::block() method.

Returns

array

Parameters

(string) $block The name of the a block to display
(array) $vars An array of variables to pass to the block (optional)
(boolean) $return A TRUE/FALSE value which determines whether to return the block as a string (TRUE) or send it to the output (FALSE)

set_user_guide_example('$func', '$example')

Sets an example for a specific method/function.

Returns

void

Parameters

(stirng) $func The name of the method/function
(string) $example The example to associate with the method/function