Core Boxx Modular PHP Framework (Plug & Play System)

Core Boxx is a PHP framework built with the concept of simplicity and modularity. Install and load only what you need, not bloated with unused features.

TLDR – “Jumpstart your project with a collection of predefined plug-and-play modules”.

 

TABLE OF CONTENTS

 

 

 

LICENSE & DOWNLOAD

GitHub | Source Forge

Core Boxx is released under the MIT License. You are free to use it for personal and commercial projects, modify it as you see fit. On the condition that the software is provided “as-is”. There are no warranties provided and “no strings attached”. Code Boxx and the authors are not liable for any claims, damages, or liabilities.

 

SYSTEM REQUIREMENTS

• LAMP/WAMP/MAMP/XAMPP
• Apache Mod Rewrite
• PHP MYSQL PDO Extension
• PHP OpenSSL Extension
• At least PHP 8.0

 

INSTALLATION

1. Just copy/unzip into your HTTP folder, access http://YOUR-SITE.com in the browser to launch the installer.
2. It will automatically create a project database with a settings table and generate the necessary .htaccess file.

Done! You now have a basic skeleton framework. Do at least run through the quick tutorial below.

 

SORRY FOR THE ADS...

But someone has to pay the bills, and sponsors are paying for it. I insist on not turning Code Boxx into a "paid scripts" business, and I don't "block people with Adblock". Every little bit of support helps.

Buy Me A Coffee Code Boxx eBooks

 

 

 

LIBRARY REFERENCES & DOCUMENTATION

• Core Engine & Concepts
• Database
• URL & API Routes
• JWT Sessions
• Mail, Pagination, Settings
• HTML/Javascript Template

 

CORE BOXX MODULES

Download, plugin, and expand your system.

1. Users – User register, login, logout, forgot password.
2. Login With Google – An addition to the user login system.
3. Login With NFC – Create an NFC “staff card” or “student card”. Login by scanning the card.
4. Passwordless Login – Login with fingerprint, pin code, face recognition, USB passkey, etc…
5. Admin Panel – HTML admin template.
6. One Time Password – For added security.
7. Resumable Upload – Resumable uploads with FlowJS and FlowPHP.
8. Dynamic Content – Store and retrieve contents from the database.
9. Reactions – Likes & dislikes, or was it “upvote & downvote”?
10. Star Rating – Let users review your posts/products/audio/video/image/whatever.
11. Comments – Allow registered users to comment on your posts/products/images/videos.
12. Calendar – Show and manage events.
13. Web Push – Use the force. Send push notifications.
14. Autocomplete – Or “suggestions”.

 

 

 

TUTORIAL CODE DOWNLOAD

GitHub | Source Forge

 

FOLDERS OVERVIEW

Core Boxx only has 3 folders:

• assets Public CSS, Javascript, images, video, audio, and whatever else.
• pages HTML pages and templates.
• lib Library, API, config, and SQL files should be kept in this folder.

 

DEVELOPMENT WORKFLOW

Development with Core Boxx commonly involves 4 steps:

• Database tables.
• Library.
• API endpoint.
• User interface.

 

STEP 1) CREATE DATABASE TABLES

CREATE TABLE `items` (
  `item_id` bigint(20) NOT NULL AUTO_INCREMENT,
  `item_name` varchar(255) NOT NULL,
  PRIMARY KEY (`item_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

Let’s keep things simple with a dummy items table:

• item_id Primary key and auto-increment.
• item_name The item itself.

 

 

STEP 2) DEVELOP THE LIBRARY MODULE

<?php
class Items extends Core {
  // (A) GET ALL ITEMS
  function getAll () {
    return $this->DB->fetchKV(
      "SELECT * FROM `items`", null,
      "item_id", "item_name"
    );
  }
 
  // (B) SAVE ITEM
  function save ($name, $id=null) : void {
    // (B1) DATA SETUP
    $fields = ["item_name"];
    $data = [$name];
    if ($id!=null) { $data[] = $id; }
 
    // (B2) INSERT OR UPDATE
    if ($id==null) { $this->DB->insert("items", $fields, $data); }
    else { $this->DB->update("items", $fields, "`item_id`=?", $data); }
  }
 
   // (C) DELETE ITEM
  function del ($id) : void {
    $this->DB->delete("items", "`item_id`=?", [$id]);
  }
}

• Since we are working with list items, we will create a lib/LIB-Items.php library. Take note of the capital I.
• Set the class name to the same as the file name, extend the core – class Items extends Core. Take note of the capital I.

Yes, we are pretty much using the database module LIB-DB.php to build this library. Modules can access each other. For example, if you want to use this items library in the future:

class Foo extends Core {
  function bar () {
    $this->Core->load("Items");
    $items = $this->Items->getAll();
  }
}

That’s the whole idea of “modular” in Core Boxx. Build the library once, load it only when needed, and reuse it everywhere.

 

STEP 3) DEVELOP THE API ENDPOINTS

<?php
// (A) API ENDPOINTS
$_CORE->autoAPI([
  "getAll" => ["Items", "getAll"],
  "save" => ["Items", "save"],
  "del" => ["Items", "del"]
]);
 
// (B) INVALID REQUEST
$_CORE->respond(0, "Invalid request", null, null, 400);

• API endpoints in Core Boxx have a structure of http://site.com/api/MODULE/ACTION. Examples:
  • Access http://site.com/api/items/getAll to get all the list items.
  • Send $_POST["name"]="DEMO" to http://site.com/api/items/save to add a new list item.
  • Send $_POST["id"]=123 to http://site.com/api/items/del to delete the list item.
• So, API-items.php will deploy the endpoint at http://site.com/api/items/ACTION.
• $_CORE->autoAPI() will map the respective ACTION => ["MODULE", "FUNCTION"].

 

 

STEP 4) USER INTERFACE

4A) CORE BOXX HTML ENGINE

<?php
// (A) HTML TOP HALF
require PATH_PAGES . "TEMPLATE-top.php";

// (B) YOUR CONTENT
$_CORE->load("items");

// (B1) GET ALL ITEMS
$items = $_CORE->items->getAll();
foreach ($items as $id=>$name) { /* DRAW HTML */ }

// (B2) SAVE ITEM
$_CORE->items->save("ANOTHER");
$_CORE->items->save("ANOTHERZZ", 123);

// (B3) DELETE ITEM
$_CORE->items->del(456);

// (C) HTML BOTTOM HALF
require PATH_PAGES . "TEMPLATE-bottom.php"; ?>

• If you want to add an HTML page in Core Boxx:
  • http://site.com/foo will map to pages/PAGE-foo.php.
  • http://site.com/foo/bar will map to pages/PAGE-foo-bar.php.
  • So, http://site.com/items will map to pages/PAGE-items.php.
• All pages have access to $_CORE. You can load your modules, and use that to fetch/process data accordingly.

P.S. The default HTML template is made with Bootstrap and IcoMoon. No hard rules that you must use it. Feel free to redevelop TEMPLATE-top.php and TEMPLATE-bottom.php as you see fit.

 

4B) WORK WITH THE API “EXCLUSIVELY”

// (A) HELPER - CALL API
function ajax (mod, act, data, after) {
  // (A1) FORM DATA
  let form = new FormData();
  if (data) {
    for (let [k,v] of Object.entries(data)) { form.append(k, v); }
  } 

  // (A2) AJAX FETCH
  fetch(`http://site.com/api/${mod}/${act}`, { method:"POST", body:form })
  .then(res => res.json())
  .then(res => {
    if (res.status) { after(res.data); }
    else { alert(res.message); }
  })
  .catch(err => console.error(err));
}

// (B) ADD/UPDATE ITEM
ajax("items", "save", { name: "Test" }, () => alert("OK"));
ajax("items", "save", { name: "Testzzz", id: 1 }, () => alert("OK"));

// (C) DELETE ITEM
ajax("items", "del", { id: 123 }, () => alert("OK"));

// (D) GET ALL
ajax("items", "getAll", null, data => {
  for (let [i,n] of Object.entries(data)) { BUILD HTML LIST }
});

Yep, the API is pretty much “a complete system without the user interface”. It does not matter what programming language or platform you use for the client – So long as you can communicate with the API and get a response.

 

 

 

CHANGED DOMAIN OR PATH

• Update SITE_NAME and HOST_BASE in lib/CORE-Config.php. Include the path (with a trailing slash) if not deployed at the base URL. E.G. http://site.com/coreboxx/
• Delete the existing .htaccess file.
• Create init.php.
  • require "lib/CORE-Go.php";
  • $_CORE->Route->init();
• Access http://site.com/init.php, this will automatically regenerate .htaccess and update CB-manifest.json.
• Delete init.php.
• Clear the service worker, flush the browser cache, and do a hard reload if you want to be “totally safe”.

 

PAGES ARE NOT RESOLVING OR SHOWING PROPERLY

• Make sure that MOD_REWRITE is enabled in Apache.
• Make sure that AllowOverride is set properly in Apache.
• If using https://, make sure that your SSL cert and host are properly set.
• In Mac/Linux, make sure that Apache and PHP have permission to read the files and folders.

Here is a quick “working example” of a test site on my WAMP server:

<VirtualHost site.com:443>
  DocumentRoot "D:\http"
  ServerName site.com:443
  SSLEngine On
  SSLCertificateFile "C:/xampp/apache/conf/ssl.crt/server.crt"
  SSLCertificateKeyFile "C:/xampp/apache/conf/ssl.key/server.key"
  <Directory "D:\http">
    Options Indexes FollowSymLinks Includes ExecCGI
    AllowOverride All
    Require all granted
  </Directory>
</VirtualHost>

 

SUPPORTING MULTIPLE HOST/DOMAIN NAMES

• In CORE-Config.php, detect the origin and set HOST_BASE accordingly.
• If you have different paths, you are going to face problems with the manifest. E.G. https://sitea.com and https://siteb.com/coreboxx.
  • You can create multiple CB-manifest.json, each with a different start_url and scope. In TEMPLATE-top.php, point to the “correct manifest” accordingly.
  • Alternatively, generate the manifest dynamically using PHP.

 

SETTING TIMEZONES

• You can change the default timezone in CORE-Config.php, SYS_TZ and SYS_TZ_OFFSET. Beware though, this can mess up the timestamps in the database if you already have entries.
• If you have to support multiple timezones, it will be wise to keep the system default to UTC. Calculate the offset in PHP or MYSQL queries instead.

 

I WANT TO CHANGE THE DATE FORMAT

• Login > System Settings > There are 4 “MYSQL date/time format” settings, change them accordingly. These are simply formats for the MYSQL DATE_FORMAT() function.
• Use the respective date/time format in your SQL – "SELECT DATE_FORMAT(`col`, '".DT_LONG."') FROM `table`".

 

UNABLE TO GENERATE JSON WEB TOKEN KEYS

Make sure that your OpenSSL is properly installed.

• Linux
  • It is as simple as sudo apt-get install openssl.
  • Or yum install openssl for the CentOS users.
  • Then, php -i | grep -i openssl.
• Windows – I am using XAMPP and OpenSSL is already included. But a hiccup got me stumped for a while.
  • Start > Search for “system environment” > “Edit the system environment variables” > “Environment variables”.
  • Add a new system variable called OPENSSL_CONF and point it to the openssl.cnf file. By default, it is located at xampp\php\extras\openssl\openssl.cnf.

 

NOT WORKING. DON’T KNOW WHY.

Open the developer’s console, reload the page, and see the error message.

• How To Debug Javascript – Very Simple Guide
• How To Debug PHP – Very Simple Guide