Tag: Function Reference

Function Reference

  • Function Reference

    Function Reference

    Function : add

     
    Description
    void add( $message, $type = 'error' )
    

    Member function of class messageStack
    Create session variable for notification

    Parameters

    message string

    Notification message to be displayed

    type string

    Type of notification, Default is ‘error’
    Flowchart

    Source Code

    Function : add_session

     
    Description
    void add_session( $message, $type = 'error' )
    

    Member function of class messageStack
    Create session variable for notification

    Parameters

    message string

    Notification message to be displayed

    type string

    Type of notification, Default is ‘error’
    Flowchart

    Source Code

    Function : block_ip_address

     
    Description
    void block_ip_address( void )
    

    Constructor of class block_ip_address
    Read ip addresses from ipadress_block table and print error message if the user is blocked

    Flowchart

    Source Code

    Function : configuration

     
    Description
    void configuration( void )
    

    Constructor of class configuration
    Read configuration table and define them as php constants

    Flowchart

    Source Code

    Function : infoBox

     
    Description
    string infoBox( string $heading , string $contents )
    

    Member function of class right_box
    Return right aligned heading and body HTML markups as single string

    Parameters

    heading string

    HTML markup of infobox heading

    contents string

    HTML markup of infobox body which is a form inside a table
    Return

    string contaning html markup of right side info box and its body

    Flowchart

    Source Code

    Function : left_box

     
    Description
    void left_box( void )
    

    Constructor of class left_box

    Reset menu and sub-menu

    Flowchart

    Source Code

    Function : lock

     
    Description
    bool lock( string $ip , string $ip1 , string $ip2)
    

    Member function of class block_ip_address
    Check whether user ip address should be blocked or not

    Parameters

    ip string

    User IP address to be checked

    ip1 string

    Lower bound of IP address range to be blocked

    ip2 string

    Upper bound of IP address range to be blocked
    Return

    true when user should be blocked and false when user should be allowed

    Flowchart

    Source Code

    Function : menuBox

     
    Description
    string menuBox( array $heading , array $contents)
    

    Member function of class left_box
    Returns left aligned vertical menu and sub-menu markups as single string

    Parameters

    heading array

    Associative array storing info about menu items

     $heading  [$index]   ['link']
                          ['text']
    

    contents array

    Associative array storing info about sub-menu items which opens when a particular menu is active

     $contents [$index]   ['link']
                          ['text']
    
    Return

    string contaning html markup of left side menu and its sub-menu

    Flowchart

    Source Code

    Function : messageStack

     
    Description
    void messageStack( void )
    

    Constructor of class messageStack
    Move notifications from session vars to class vars

    Flowchart

    Source Code

    Function : output

     
    Description
    string output( void )
    

    Constructor of class messageStack
    Form html table markup for notification

    Return

    string Return html table markup for notification

    Flowchart

    Source Code

    Function : reset

     
    Description
    void reset( void )
    

    Member function of class messageStack
    Reset class variables

    Flowchart

    Source Code

    Function : right_box

     
    Description
    void right_box( void )
    

    Constructor of class right_box
    Reset menu and sub-menu

    Flowchart

    Source Code

    Function : size

     
    Description
    int size( string $class )
    

    Member function of class messageStack
    Find number of notifications having a particular type/class eg error type/class

    Parameters

    class string

    The class style name for the notification which is same as the type of the notification
    Return

    int number of matched notifications

    Flowchart

    Source Code

    Function : tableBlock

     
    Description
    string tableBlock( array $contents )
    

    Constructor of class tableBlock
    Form generic table HTML markup

    Parameters

    contents array

    Store table data values and column parameters

     $contents['form']
    	  [$row_index]	['params']
    	     		['text']
    			[$column_index]	['params']
    					['text']
    					['align']
    					['form']
    
    Return

    string containing HTML markup of desired generic table

    Flowchart

    Source Code

    Function : tableBlockLeft

     
    Description
    string tableBlockLeft( array $contents )
    

    Constructor of class tableBlockLeft
    Form left aligned table HTML markup

    Parameters

    contents array

    Store table data values and column parameters

     $contents['form']
    	  [$row_index]	['params']
    	     		['text']
    			[$column_index]	['params']
    					['text']
    					['align']
    					['form']
    
    Return

    string containing HTML markup of desired left aligned table

    Flowchart

    Source Code

    Function : tableBlockRight

     
    Description
    string tableBlockRight( array $contents )
    

    Constructor of class tableBlockRight
    Form left aligned table HTML markup

    Parameters

    contents array

    Store table data values and column parameters

     $contents['form']
    	  [$row_index]	['params']
    	     		['text']
    			[$column_index]	['params']
    					['text']
    					['align']
    					['form']
    
    Return

    string containing HTML markup of desired right aligned table

    Flowchart

    Source Code