Tag: Class Reference

Class Reference

  • Class Reference

    Class Reference

    Class : block_ip_address

    Blocks an ip address range from database

     
    Variables
    none
    Functions
    constructor : block_ip_address
    void block_ip_address( void )
    
    Read ip addresses from ipadress_block table and print error message if the user is blocked
    lock
    bool lock( $ip , $ip1 , $ip2) 
    
    Check whether user ip address should be blocked or not

    Class : configuration

    Load configuration from database into constant variables

     
    Variables
    none
    Functions
    constructor : configuration
    void configuration( void ) 
    
    Read configuration table and define them as php constants

    Class : left_box

    Form left vertical menu or sidebar in admin panel

     
    Extends
    Variables
    heading
    Associative array storing info about menu items

     $heading  [$index]   ['link']
                          ['text']
    
    contents
    Associative array storing info about sub-menu items which opens when a particular menu is active

     $contents [$index]   ['link']
                          ['text']
    
    Functions
    constructor : left_box

    Reset menu and sub-menu

    void left_box( void )
    
    menuBox

    Returns left aligned vertical menu and sub-menu markups as single string

    string menuBox( $heading , $contents)
    

    Class : messageStack

    Create custom notifications

     
    Extends
    Variables
    size
    Number of errors
    errors
    Associative array storing error content and html attributes

     $contents [$index]   ['params']
                          ['text']
    
    Functions
    constructor : messageStack
    void messageStack( void )
    
    Move notifications from session vars to class vars
    add
    void add( $message, $type = 'error' )
    
    Determine type of notification and copy them to local variable with HTML styling
    add_session
    void add_session( $message, $type = 'error' )
    
    Create session variable for notification
    reset
    void reset( void )
    
    Reset class variables
    output
    string output( void )
    
    Form html table markup for notification
    size
    int size( string $class )
    
    Find number of messages having a particular type/class eg error type/class

    Class : right_box

    Form left vertical menu or sidebar in admin panel

     
    Extends
    Variables
    heading
    Markup of infobox heading
    contents
    Markup of infobox body, which is a form inside table
    Functions
    constructor : right_box
    void right_box( void )
    
    Reset heading and body variables
    infoBox
    string menuBox( $heading , $contents )
    
    Return heading and body HTML markups as one single string

    Function : block_ip_address

    Form generic table in html

     
    Variables
    table_border
    Border in pixels
    table_width
    Width param of table
    table_cellspacing
    Cell spacing attribute of table
    table_cellpadding
    Cell padding attribute of table
    table_parameters
    Additional atributes of table
    table_row_parameters
    Attributes for row of table ie tr
    table_data_parameters
    Attributes of table data ie td
    Functions
    constructor : tableBlock
    void tableBlock( array contents )
    
    Form generic table HTML markup

    Class : tableBlockLeft

    Form left aligned table in html

     
    Variables
    table_border
    Border in pixels
    table_width
    Width param of table
    table_cellspacing
    Cell spacing attribute of table
    table_cellpadding
    Cell padding attribute of table
    table_parameters
    Additional atributes of table
    table_row_parameters
    Attributes for row of table ie tr
    table_data_parameters
    Attributes of table data ie td
    Functions
    constructor : tableBlockLeft
    void tableBlockLeft( array contents )
    
    Form left aligned table HTML markup

    Class : tableBlockRight

    Form right aligned table in html

     
    Variables
    table_border
    Border in pixels
    table_width
    Width param of table
    table_cellspacing
    Cell spacing attribute of table
    table_cellpadding
    Cell padding attribute of table
    table_parameters
    Additional atributes of table
    table_row_parameters
    Attributes for row of table ie tr
    table_data_parameters
    Attributes of table data ie td
    Functions
    constructor : tableBlockRight
    void tableBlockRight( array contents )
    
    Form right aligned table HTML markup