SimpleSiteClass Version 1.0.0

SimpleSiteClass class mini framework for simple, small websites.

SimpleSiteClass is a PHP mini framework for simple, small websites. It can be esaly combined with other frameworks or templeting engines if needed. For small websites I feel that frameworks like Laravel or Meteor etc. are just too much.

This project has several parts that can function standalone or combined.

• Database.class.php : provides a wrapper for several different database engines.
• dbMySqli.class.php : has the actual mysqli functions.
• dbTables.class.php : uses the functionality of Database.class.php to make creating tables easy.
• SimpleSiteClass.class.php : tools for making creating a site a little easier. The class provides methods to help with headers, banners, footers and more.

The following database engine is provided as the following class:

1. dbMysqli.class.php : (rigorously tested) This is the latest PHP version of the MySql database engine.

Disclamer

To start, this framework is meant for Linux not Windows. I don't use Windows, like it or have it, so nothing has been tried on Windows. Quite frankly I don't know why anyone would use a Windows server.

I use Ubuntu 22.04 Linux which is a Debian derivative. I have not tried this package on any distributions that do not evolve from Debian.

Install

There are several ways to install this project.

Download The ZIP File

Download the ZIP file from GitHub. Expand it into the /var/www dirctory that Apache2 creates. In my servers I have /var/www and then have my virtual hosts off that directory. That way the directory created when you unzip the download is easily available to all of my virtual hosts.

Use Composer

If you have Apache or Nginx installed then you should made your project root somewhere within your DocumentRoot ('/var/www/html' for Apache2 on Ubuntu). Or if you want to make a seperate Apache virtual host with a registered domain name you can make your new project in '/var/www'.

Create a directory mkdir myproject; cd myproject, this is your project root directory. Add the following to 'composer.json', just cut and past:

      
{
    "require": {
        "bartonlp/simple-site-class": "dev-master"
    }
}
      
      

Then run

composer install

OR you can just run

composer
        require bartonlp/simple-site-class:dev-master

which will create the 'composer.json' for you and load the package like 'composer install' above.

In your PHP file add $_site = require_once($PATH_TO_VENDOR . '/vendor/bartonlp/simple-site-class/includes/siteload.php'); where '$PATH_TO_VENDOR' is the path to the 'vendor' directory like './' or '../' etc.

There are some example files in the 'examples' directory at '$PATH_TO_VENDOR/vendor/bartonlp/simple-site-class/examples'. There is more documentation in the /docs directory.

Further Documentation

• SimpledbTables Documentation
• SimpleSiteClass and SimpleDatabase Methods
• Additional Files User by SimpleSiteClass
• Example Files

Contact me

Barton Phillips : bartonphillips@gmail.com
Copyright © 2024 Barton Phillips
Last modified January 6, 2024