Alexander David P > CGI-Portal > CGI::Portal

Download:
CGI-Portal-0.12.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.12   Source  

NAME ^

CGI::Portal - MVC Framework for Multiuser Applications

SYNOPSIS ^

    use CGI::Portal;

    CGI::Portal::activate({'database_type'       => "mysql",

                           'database_name'       => "some_name",
                           'database_host'       => "localhost",
                           'database_user'       => "some_user",
                           'database_passw'      => "some_password",

                           'user_table'          => "users",
                           'user_index_field'    => "id",
                           'user_user_field'     => "user",
                           'user_passw_field'    => "passw",
                           'user_additional'     => ["email","first_name","middle_initial","last_name","city","state","country"],
                           # at least:              ["email"],

                           'session_table'       => "sessions",
                           'session_index_field' => "id",
                           'session_sid_field'   => "sid",
                           'session_user_field'  => "user",
                           'session_start_field' => "session_start",
                           'session_additional'  => "",


                           # Accessible classes, the first is the default action

                           'actions'             => ["logon", "logoff", "register", "profile", "changepw", "emailpw"],

                           'session_length'      => 7200,
                           'admin_email'         => "some_user\@some_host.com",

                           'template_dir'        => "templates/", # include trailing slash
                           'header_html'         => "header.html",
                           'footer_html'         => "footer.html",
                           'logon_success_html'  => "logon.html"});

DESCRIPTION ^

CGI::Portal is a MVC framework for the design of extensible, plug-configure-and-play multiuser web applications based on preferred object oriented coding standards. It provides authentication, session management, internal redirects and a modular architecture to build complex applications.

It requires a database including a user and a sessions table, a collection of HTML::Template style templates and a properly configured startup script. To start with CGI::Portal you may want to install the provided templates at http://cgi-portal.sourceforge.net/

All requests access through the startup script, and are handled by the class in the CGI::Portal::Scripts and CGI::Portal::Controls namespace that corresponds to the desired action.

portal.cgi?action=foo calls CGI::Portal::Scripts::foo::launch()

portal.cgi?action=foo&Submit=1 calls CGI::Portal::Controls::foo::launch()

FUNCTIONS ^

activate

CGI::Portal::activate($conf) takes a reference to the configuration hash, collects input parameters, creates a database object, and passes those on to your class for creating an object instance. It then runs your classes "launch" method and concludes by doing the printing for you. This function is called once from your startup script.

BUILDING APPLICATIONS ^

See CGI::Portal::Scripts on Building Applications

INSTALLATION ^

    perl Makefile.PL
    make
    make test
    make install

AUTHOR ^

Alexander David P <cpanalpo@yahoo.com>

syntax highlighting: