Sample|Download|Installation Process

Sample

Here is a sample of comPollBuilder:

To enter into the administration area, please use the following user and password:
• User: demo
• Password: test
  

View for the administration:

View for the common users:

Download

Installation process

How to install

Congratulations, you’ve just downloaded the comPollBuilder.zip file, which contains a sample set of files that will allow you to quickly set up your own Poll Builder component on your server and web pages.
This process will detail the steps needed to install and use comPollBuilder on your web server.

The comPollBuilder.zip file contains the following files:

• Common components
• comLoginC.php: allows the admin to login as it has been configured during the installation process. It also allows to retrieve or change the admin password.
• comLoginF.js: Set of JavaScript functions for the local control of the login class.
• comSettingsC.php: allows the admin to change the general configuration of parameters.
• comSettingsF.js: Set of JavaScript functions for the local control of the settings class.
• Poll Builder specific components
• install.php: is the script that will help you to install the component on the server. Run this script first in order to proceed,
• config.php: is created dynamically by the install process and should not be manually changed,
• session.php: stores any session variables during login time when available,
• logged.php: controls if the admin user is logged to grant access to certain pages,
• comLoginP.php: contains the specific parameters for the login class,
• comPollBuilderP.php: contains the specific parameters for the Poll Builder class,
• comPollBuilderC.php: draws the comPollBuilder component according to defined parameters,
• comPollBuilderF.js: Set of JavaScript functions for the local control of the Poll Builder class.,

Once the comPollBuilder.zip downloaded into your computer, you should unpack the content into a folder, or into HTDOCS folder if you have a localhost server. Note that the original hierarchy will have to be maintained; all scripts should be copied into a comPollBuilder folder and standard components into the comStandardObjects folder.

If you have a localhost folder you can try to install the component locally by running the install script (http://locahost/…/comPollBuilder/install.php). If not, FTP all scripts to your web server, respecting the folder hierarchy. At this point, the installation procedure should work the same way (http://yoursite/…/comPollBuilder/install.php) (note that on Unix based servers, the respect of capital letter is important).

The install.php script should be the first one to be ran since the other scripts are not supposed to work without a proper installation (table definitions and config.php construction).

The data for the comPollBuilder adminstration will be stored into the database you’ve chosen in the installation process.

• Name of the host (ex.: localhost),
• Name of the database,
• Name of the admin user of the database,
• Password of the admin user of the database,
• Prefix of the table name of the component (ex.: “PhotoViewer_”),
• Name of the admin user of the comPollBuilder component,
• Password of the admin user of the comPollBuilder component,
  
• Email of the admin user of the comPollBuilder component to enable password retrieval,
  

The instalation process will perform 2 steps on the server:

• It will create one new table in the database, you’ve just specified:
  • Prefix + “User”: to store information about the administrator of the component.
• inside the comPollBuilder folder, it will create a config.php file that will store your configuration.

Please note the following:

• Due to level of security on the server you use, you might not be able to create a file or a folder by script. At this point you have 2 solutions:
  • Install the component on your local server first then upload your files, or
  • Try to perform the installation on your remote server, if it fails to create some components, the install.php process will help guide you to the solution.

How to re-install.

To re-install the component on your server, the first step to perform is to remove the components created by the previous installation. This has to be done manually.
Then run install.php again and it will make a fresh installation of the component. Please note that your previous data will not be taken care of, unless you migrate them manually into the new structure.
Note that it is important to remove the file install.php from your server when definitive installation has been sucessfully performed, in order to prevent non-authorized executions from users, that would result in lose of data.

How to create a Poll.

You can use the sample file comPollBuilder.php in order to create a Poll.
You only have to define the title and the questions you wish to ask to your users. The comPollBuilder class will automatically deal with the data table creation. Additionally, the adminstrator will have the possibility to reset all Poll data and the change the appearence of the Poll.

You can use this simple code:

The administration window will help you to modify the design of the Poll:

Some sample of presentations:

Improving the Design

The component has been designed so it could stay the most general possible, allowing the user to easily apply its own requirements. You can use the classes of your main CSS into the configuration file.