index.php File Reference

Go to the source code of this file.

Enumerations

enum  BASE_URL
 BASE_URL is used to specify location of base folder wrt which all the URLs for examples would be generated. More...
enum  EXAMPLES_DIR
 EXAMPLES_DIR is used to specify location of examples directory. More...

Functions

 display_index_page ()
 This function displays proper index page in HTML format.
 main ()
 This function just displays index page by calling display_index_page() function.
 read_example_dir ()
 This function reads examples dir whose location is defined using constant EXAMPLES_DIR.


Enumeration Type Documentation

enum BASE_URL

BASE_URL is used to specify location of base folder wrt which all the URLs for examples would be generated.

Definition at line 21 of file index.php.

enum EXAMPLES_DIR

EXAMPLES_DIR is used to specify location of examples directory.

Definition at line 15 of file index.php.


Function Documentation

display_index_page (  ) 

This function displays proper index page in HTML format.

This page includes links to all example dirs in alphabetical order.

Returns:
Nothing

Definition at line 73 of file index.php.

References read_example_dir().

Referenced by main().

main (  ) 

This function just displays index page by calling display_index_page() function.

Returns:
Nothing

Definition at line 115 of file index.php.

References display_index_page().

read_example_dir (  ) 

This function reads examples dir whose location is defined using constant EXAMPLES_DIR.

It than prepares a sorted array of all sub-folders stored in EXAMPLES_DIR excluding . and .. in global array named $example_array.

Returns:
Nothing

Definition at line 31 of file index.php.

Referenced by display_index_page().


Generated on Fri Nov 4 14:16:55 2011 for PHP example documentation by  doxygen 1.4.7