Recent changes to wiki

OOPSQL modified by Stevie G

Stevie G — Sat, 25 Feb 2017 16:27:29 -0000

OOPSQL (MySQLi Database Handler)

OOPSQL is automatically called by common.php when the define("DB_ENABLE", false); in config.php is set to on.

ie.

require_once(LOC_CLASSES."OOPSQL.class.php"); //Include OOPSQL MySQLi Database Handler
$dbo=OOPSQL::getInstance(); //Create MySQL DB Instance
$dbo->connect($cfg[LOC]["DB_HOSTNAME"], $cfg[LOC]["DB_USERNAME"], $cfg[LOC]["DB_PASSWORD"], $cfg[LOC]["DB_DATABASE"]); //Connect to DB and get Connection Object

Generic SQL can be called as follows:

//Custom SQL Query
$dbo->doQuery("SELECT * FROM people ORDER BY dob DESC");
while($ROW=$dbo->loadObjectList())
{
    echo("Firstname: $ROW[firstname] <br/>
    Surname: $ROW[surname]<br/>
    Nickname: $ROW[nickname]<br/>
    Date Of Birth: $ROW[dob]<br/>
    Hobbies: $ROW[hobbies]<hr/>");
}

OOPSQL (Object Oriented Programming SQL)
In order to objectify an SQL table in code the following must be setup beforehand:

Setup
1. Create [TABLENAME].class.php in includes/classes/oopsqltables folder (Where [TABLENAME] is the name of the MySQL Table)
2. Edit [TABLENAME].class.php (eg. people.class.php) and populate with Table Columns in this Format

<?php
//People DBT Class (Database Table Class)
class people extends table {
    var $id=NULL;
    var $firstname=NULL;
    var $surname=NULL;
    var $nickname=NULL;
    var $dob=NULL;
    var $hobbies=NULL;
    var $table="people";
}
?>

Instantiate Table Class: require_once(LOC_DBTCLASSES."people.class.php");

Usage

Init Table Class

$people=new people();

Load And Display Single Record By ID

$people->load('1'); //Load Person with id 1 from people table
echo("Firstname: $people[firstname] <br/>
    Surname: $peoplepeople[surname]<br/>
    Nickname: $people[nickname]<br/>
    Date Of Birth: $people[dob]<br/>
    Hobbies: $people[hobbies]");

Insert New Record

$data=array("firstname"=>"Steven","surname"=>"Graham","nickname"=>"Stevie G","dob"=>"1981-10-01","hobbies"=>"Singing,XBOX");
$people->bind($data);
$people->store();

Update Existing Record

$people->load('1'); //Select User id 1 (Steven Graham)
$data=array("firstname"=>"Steven","surname"=>"Graham","nickname"=>"Stevie G","dob"=>"1981-10-01","hobbies"=>"Singing,XBOX,Snooker");
$people->bind($data);
$people->store();

TimeMachine modified by Stevie G

Stevie G — Sat, 25 Feb 2017 16:25:38 -0000

TimeMachine (TimeZone/Time Conversion Manager)

Time Machine can be used as follows:

$timeMac=new TimeMachine(); //Instantiate Time Machine

Set TimeZone
Time Machine can be set to $timeMac->setTZ("Australia/Sydney");or $timeMac->setTZ("Australia/Brisbane");with no problem. But when a non existant timezone is specified it will throw an error ie $timeMac->setTZ("Hogwarts");
A list of valid timezones can be found at http://www.php.net/manual/en/timezones.php

Get TimeZone
$timezone=$timeMac->getTZ(); (or $timezone=$timeMac->getTZ("basic");)
echo $timezone;
Would return the current timezone
Example: Australia/Sydney

$TIMEZONE=$timeMac->getTZ("full");
die("<pre>".print_r($TIMEZONE,true)."</pre>");

would return an array of the current timezone and is Daylight time is active or not

Example:

Array
(
    [timezone] => Australia/Sydney
    [dstactive] => 1
)

Array
(
    [timezone] => Australia/Brisbane
    [dstactive] => 0
)

List All TimeZones

An array can be populated with a list of timezones in the Country/City Format as shown below

Example:
$RETURN=$timeMac->getTimeZones('basic');

RETURNS:

Array
(
    [0] => Africa/Abidjan
    [1] => Africa/Accra
    [2] => Africa/Addis_Ababa
    [3] => Africa/Algiers
    [4] => Africa/Asmara
    [5] => Africa/Bamako
    [6] => Africa/Bangui
    [7] => Africa/Banjul
    [8] => Africa/Bissau
    [9] => Africa/Blantyre
    [10] => Africa/Brazzaville
    [11] => Africa/Bujumbura
    [12] => Africa/Cairo
    [13] => Africa/Casablanca
    [14] => Africa/Ceuta
    [15] => Africa/Conakry
    [16] => Africa/Dakar
    ...

Example 2:
$RETURN=$timeMac->getTimeZones('full');

RETURNS:

Array
(
    [Africa] => Array
        (
            [0] => Abidjan
            [1] => Accra
            [2] => Addis_Ababa
            [3] => Algiers
            [4] => Asmara
            [5] => Bamako
            [6] => Bangui
            [7] => Banjul
            ...
        )

    [America] => Array
        (
            [0] => Adak
            [1] => Anchorage
            [2] => Anguilla
            ...

Example 3:
$RETURN=$timeMac->getTimeZones('countries');

RETURNS:

Array
(
    [0] => Africa
    [1] => America
    [2] => Antarctica
    [3] => Arctic
    [4] => Asia
    [5] => Atlantic
    [6] => Australia
    [7] => Europe
    [8] => Indian
    [9] => Pacific
    [10] => UTC
)

Time Conversion

Can be used to convert times between TimeZones.

Example 1:

$sourcetime="2000-01-01 17:30:00";
$RETURN=$timeMac->timeZoneConvert($sourcetime, "Australia/Sydney", "UTC");

RETURNS:
2000-01-01 06:30:00

Example 2:

$sourcetime=date("Y-m-d H:i:s");
$RETURN=$timeMac->timeZoneConvert($sourcetime, "Australia/Sydney", "America/New_York");

RETURNS:
2017-02-25 10:28:14

Konstruct modified by Stevie G

Stevie G — Sat, 25 Feb 2017 16:22:57 -0000

Blunder modified by Stevie G

Stevie G — Sat, 25 Feb 2017 16:22:10 -0000

Blunder (Error Logger)

Blunder Error logger is automatically started in the common.php file.

Blunder has 3 Modes:
Example 1: $elog=new errorLogger(); //Default Mode: Log to Logs Folder
Example 2: $elog=new errorLogger("user@domain.com"); //Email Errors and Log to Logs Folder
Example 3: $elog=new errorLogger(NULL,"/var/log/phperrors.php"); //No Email but specify custom path

Bluder can be tested by throwing an error such as $val=0/0; which would throw a divide by zero error.
Alternatively you can throw your own error using trigger_error("My Custom Error Message",E_USER_ERROR);

BluePrint modified by Stevie G

Stevie G — Sat, 25 Feb 2017 16:20:11 -0000

--- v1
+++ v2
@@ -1,4 +1,4 @@
-*BluePrint Template Engine**
+BluePrint Template Engine
 ===
 By default the BluePrint Engine is started in common.php
 ~~~

BluePrint modified by Stevie G

Stevie G — Sat, 25 Feb 2017 16:19:48 -0000

*BluePrint Template Engine**

By default the BluePrint Engine is started in common.php

require_once(LOC_CLASSES."BluePrint.class.php"); //Include BluePrint Template Engine
$template=new BluePrint(THEME_PATH); //BluePrint Theme Switcher

The Blueprint template engine can be called as follows

$multiset=array(
"PageTitle"=>"Welcome to ComputerM8",
"MetaDescription"=>"ComputerM8 - I.T. services, sales, support, remote assistance, web design, web hosting, troubleshooting, networking, custom built computers and more.",
"MetaKeywords"=>"Computer Repair, Computer Engineer, Web Design, Web Application Design, Web Developer, PHP, HTML, CSS",
"PageAuthor"=>"Steven Graham",
"URL_IMAGES"=>URL_IMAGES,
"URL_CSS"=>URL_CSS,
"BodyContent"=>$content
);
$template->multiSet($multiset);
echo $page->output();

You can set multiple SuperTagz at once using the multiset function shown above. This uses the array key=>value format. Each of the SuperTagz specified can then be used in the template (ie ...<head><title>[@PageTitle]</title></head><body>[@BodyContent]</body>...)

Alternatively you can specify a single tag as follows
$template->set("DATE", date("Y-m-d"));

This could then be called in the template file like this [@date]

BluePrint has the ability to output the contents of theme files or php variables, see the following example.

$myvar="The date is [@DATE] and the PHP version is [@PHP_VERSION]";
$content=$template->output($myvar);
echo $content;

common.php modified by Stevie G

Stevie G — Sat, 25 Feb 2017 16:18:15 -0000

Common.php

The Common.php is used to include or instantiate any classes/functions files that need to be loaded at startup.

Lets take a look at the default common.php

<?php
### Include every class and function set we use
require_once(LOC_CLASSES."ToolChest.class.php"); //Include ToolChest Utilities
require_once(LOC_CLASSES."Blunder.class.php"); //Include Blunder Error Handler
require_once(LOC_CLASSES."OOPSQL.class.php"); //Include OOPSQL MySQLi Database Handler
require_once(LOC_CLASSES."BluePrint.class.php"); //Include BluePrint Template Engine
require_once(LOC_CLASSES."TimeMachine.class.php"); //Include TimeMachine TimeZone/Time Conversion Manager

### Instantiate the major classes here
$utils=new ToolChest(); //Instantiate Blunder Error Handler

$elog=new Blunder(NULL,LOC_LOGPATH); //Instantiate Blunder Error Handler

if(DB_ENABLE==true)
{
    $dbo=OOPSQL::getInstance(); //Create MySQL DB Instance
    $dbo->connect($cfg[LOC]["DB_HOSTNAME"], $cfg[LOC]["DB_USERNAME"], $cfg[LOC]["DB_PASSWORD"], $cfg[LOC]["DB_DATABASE"]); //Connect to DB and get Connection Object
}

$template=new BluePrint(THEME_PATH); //BluePrint Theme Switcher

/* Make Konstruct paths available to BluePrint */
$KonstructBPPaths=array(
"BASE_URL"=>$CFG[LOC]["BASE_URL"],
"URL_CSS"=>URL_CSS,
"URL_IMAGES"=>URL_IMAGES,
"URL_JS"=>URL_JS,
"CURRENT_DATETIME"=>date("Y-m-s H:i:s"),
"PHP_VERSION"=>phpversion()
);
$template->multiSet($KonstructBPPaths);
?>

You will notice that the Konstuct paths are exported to the theme manager at startup so that they can be easily accessed within templates. This ins fantastic as it cuts down the amount of work required coding and remembering path names.

This can be done by using BluePrint SuperTagz (ie [@URL_CSS] would be populated with the CSS Path, [@URL_IMAGES]would be populated with the images path, [@URL_JS]would be populated with the JavaScript path and [@CURRENT_DATETIME] would be populated with the current date time stamp.

Konstruct modified by Stevie G

Stevie G — Sat, 25 Feb 2017 16:16:21 -0000

--- v2
+++ v3
@@ -57,7 +57,7 @@
 $CFG[1]["PROJECT_VERSION"] = "1.0.0";
 ~~~

-You will notice that each variable has a number ie $CFG[0], you can add addition server configuration set by adding $CFG[1] and so on.
+You will notice that each variable has a number ie `$CFG[0]`, you can add addition server configuration set by adding `$CFG[1]` and so on.

 Lets take a look at what each setting does:
 1. `$CFG[0]["DB_HOSTNAME"]` This setting specifies the MySQLi Database Hostname

Konstruct modified by Stevie G

Stevie G — Sat, 25 Feb 2017 16:15:14 -0000

--- v1
+++ v2
@@ -1,4 +1,4 @@
-onstruct (Intelligent Extensible Configuration Manager)
+Konstruct (Intelligent Extensible Configuration Manager)
 ===
 **Directory Structure**
 ![](http://a.fsdn.com/con/app/proj/phpbaseplate/screenshots/Screen%20Shot%202017-02-25%20at%2011.59.37%20PM.png/1)

Konstruct modified by Stevie G

Stevie G — Sat, 25 Feb 2017 16:14:52 -0000

onstruct (Intelligent Extensible Configuration Manager)

Directory Structure

The Directory Structure (shown in the image above) consists of 2 main directories, includes and resources.

The Includes directory is designed to store php server side files such as classes, functions, packages and templates.

The Resources directory is designed to store client side materials such as CSS, Images and JavaScript files.

There are 2 additional directories

The Logs directory is designed to store error logs to help debug.
The Install directory is used for the installer (currrently in development)

Configuration File
Opening config.php you will be presented with the central configuration.

ERROR HANDLING/TIMEZONE/DB/THEME CONFIG

define("SHOW_ERRORS", true);will turn on the PHP ini_set('display errors') setting
define("ERROR_LEVEL", "E_ALL ^ E_NOTICE"); will set the PHP error_reporting error level. More Information can be found here http://php.net/manual/en/function.error-reporting.php
define("TIMEZONE", "Australia/Sydney"); Allows you to set the timezoneusing PHP date_default_timezone_set(). More information in TimeZones and formats can be found here http://www.php.net/manual/en/timezones.php
define("DB_ENABLE", false); Enables/Disables OOPSQL MySQLi Database Connection
define("THEME", "default"); Sets the BluePrint Theme Name which by default points to /includes/templates/THEMENAME.theme.html (where THEMENAME is the name you specify ie. default)

Database & URL Configuration

Configuration Switch
define("LOC", 0); This setting when changed sets which configuration set is active ie. $CFG[0] or $CFG[1]etc

Below you will see an example of a server configuration

//Server 1: Development Server
$CFG[0]["DB_HOSTNAME"] = "localhost";
$CFG[0]["DB_USERNAME"] = "root";
$CFG[0]["DB_PASSWORD"] = "";
$CFG[0]["DB_DATABASE"] = "";
$CFG[0]["DB_TABLEPREFIX"] = "";
$CFG[0]["BASE_URL"] = "http://localhost/PHPBasePlate/";
$CFG[0]["ADMIN_URL"] = "http://localhost/PHPBasePlate/admin/";
$CFG[0]["ADMIN_EMAIL"] = "webmaster@computerm8.com";
$CFG[0]["PROJECT_NAME"] = "PHPBasePlate";
$CFG[0]["PROJECT_VERSION"] = "1.0.0";

//Server 2: Production Server
$CFG[1]["DB_HOSTNAME"] = "host2.example.com";
$CFG[1]["DB_USERNAME"] = "host2dbuser";
$CFG[1]["DB_PASSWORD"] = "host2dbpass";
$CFG[1]["DB_DATABASE"] = "host2db";
$CFG[1]["DB_TABLEPREFIX"] = "";
$CFG[1]["BASE_URL"] = "http://host2.example.com/";
$CFG[1]["ADMIN_URL"] = "http://host2.example.com/admin/";
$CFG[1]["ADMIN_EMAIL"] = "admin@host2.example.com";
$CFG[1]["PROJECT_NAME"] = "Example Project Name";
$CFG[1]["PROJECT_VERSION"] = "1.0.0";

You will notice that each variable has a number ie $CFG[0], you can add addition server configuration set by adding $CFG[1] and so on.

Lets take a look at what each setting does:
1. $CFG[0]["DB_HOSTNAME"] This setting specifies the MySQLi Database Hostname
2. $CFG[0]["DB_USERNAME"] This setting specifies the MySQLi Database Username
3. $CFG[0]["DB_PASSWORD"] This setting specifies the MySQLi Database Password
4. $CFG[0]["DB_DATABASE"] This setting specifies the MySQLi Database Schema
5. $CFG[0]["DB_TABLEPREFIX"] This setting specified if a table prefix (if used)
6. $CFG[0]["BASE_URL"] This setting specifies the absolute URL path where the PHPBasePlate files are located ie. http://localhost/MyWebSite/
7. $CFG[0]["ADMIN_URL"] This setting will be used when a full administraion panel is added to PHPBasePlate (in Development)
8. $CFG[0]["ADMIN_EMAIL"] This setting specifies the server Admins Email (may be used for notifications and errors)
9. $CFG[0]["PROJECT_NAME"] This setting is used to describe the website/project you are working on
10. $CFG[0]["PROJECT_VERSION"] This setting specifies the version of the website/project you are working on