PHP Plugin System Example

0-PHP-PLUGIN.MD

PHP PLUGIN SYSTEM EXAMPLE

https://code-boxx.com/php-plugin-module-system/

NOTES

1. GIST does not allow folders. Create a lib folder and add a .htaccess file inside with only one line - Deny from all.
2. Then move all the files into lib, except for demo.php.

LICENSE

Copyright by Code Boxx

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

CORE-Go.php

<?php
// (A) ERROR HANDLING
error_reporting(E_ALL & ~E_NOTICE);
ini_set("display_errors", 1);
//ini_set("log_errors", 0);
//ini_set("error_log", "PATH/error.log");

// (B) DATABASE SETTINGS - CHANGE TO YOUR OWN
define("DB_HOST", "localhost");
define("DB_NAME", "test");
define("DB_CHARSET", "utf8mb4");
define("DB_USER", "root");
define("DB_PASSWORD", "");

// (C) AUTO FILE PATHS
define("PATH_LIB", __DIR__ . DIRECTORY_SEPARATOR);
define("PATH_BASE", dirname(PATH_LIB) . DIRECTORY_SEPARATOR);

// (D) START SESSION
session_start();

// (E) INIT SYSTEM CORE
require PATH_LIB . "LIB-Core.php";
$_CORE = new Core();

DB-Users.sql

CREATE TABLE `users` (
  `user_id` bigint(20) NOT NULL,
  `user_name` varchar(255) NOT NULL,
  `user_email` varchar(255) NOT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

ALTER TABLE `users`
  ADD PRIMARY KEY (`user_id`),
  ADD UNIQUE KEY `user_email` (`user_email`),
  ADD KEY `user_name` (`user_name`);

ALTER TABLE `users`
  MODIFY `user_id` bigint(20) NOT NULL AUTO_INCREMENT, AUTO_INCREMENT=1;

demo.php

<?php
// (A) LOAD CORE LIBRARY
require "lib/CORE-Go.php";

// (B) LOAD USER MODULE
$_CORE->load("User");

// (C) ADD USER
echo $_CORE->User->add("Jon Doe", "jon@doe.com") ? "OK" : $_CORE->error;

// (D) GET USER
$user = $_CORE->User->get("jon@doe.com");
print_r($user);

LIB-Core.php

<?php
class Core {
  // (A) PROPERTIES
  public $error = "";  // last error message
  public $pdo = null;  // database connection
  public $stmt = null; // sql statement
  public $loaded = []; // loaded modules

  // (B) CONNECT TO DATABASE
  function __construct () {
    $this->pdo = new PDO(
      "mysql:host=".DB_HOST.";charset=".DB_CHARSET.";dbname=".DB_NAME,
      DB_USER, DB_PASSWORD, [
      PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
      PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC
    ]);
  }

  // (C) CLOSE CONNECTION WHEN DONE
  function __destruct () {
    if ($this->stmt !== null) { $this->stmt = null; }
    if ($this->pdo !== null) { $this->pdo = null; }
  }

  // (D) RUN SQL QUERY
  //  $sql : sql query
  //  $data : array of parameters
  function exec ($sql, $data=null) : void {
    $this->stmt = $this->pdo->prepare($sql);
    $this->stmt->execute($data);
  }

  // (E) FETCH SINGLE ROW
  //  $sql : sql query
  //  $data : array of parameters
  function fetch ($sql, $data=null) {
    $this->exec($sql, $data);
    return $this->stmt->fetch();
  }

  // (F) FETCH MULTIPLE ROWS
  //  $sql : sql query
  //  $data : array of parameters
  //  $arrange : (string) arrange by [$arrange] => results
  //             (array) arrange by [$arrange[0] => $arrange[1]]
  //             (none) default - whatever is set in pdo
  function fetchAll ($sql, $data=null, $arrange=null) {
    // (F1) RUN SQL QUERY
    $this->exec($sql, $data);

    // (F2) FETCH ALL AS-IT-IS
    if ($arrange===null) { return $this->stmt->fetchAll(); }

    // (F3) ARRANGE BY $DATA[$ARRANGE] => RESULTS
    else if (is_string($arrange)) {
      $data = [];
      while ($r = $this->stmt->fetch()) { $data[$r[$arrange]] = $row; }
      return $data;
    }

    // (F4) ARRANGE BY $DATA[$ARRANGE[0]] => $ARRANGE[1]
    else {
      $data = [];
      while ($r = $this->stmt->fetch()) { $data[$r[$arrange[0]]] = $r[$arrange[1]]; }
      return $data;
    }
  }

  // (G) LOAD SPECIFIED MODULE
  //  $module : module to load
  function load ($module) : void {
    // (G1) CHECK IF MODULE IS ALREADY LOADED
    if (isset($this->loaded[$module])) { return; }

    // (G2) EXTEND MODULE
    $file = PATH_LIB . "LIB-$module.php";
    if (file_exists($file)) {
      require $file;
      $this->loaded[$module] = new $module($this);
    } else { throw new Exception("$module module not found!"); }
  }

  // (H) "MAGIC LINK" TO MODULE
  function __get ($name) {
    if (isset($this->loaded[$name])) { return $this->loaded[$name]; }
  }
}

// (I) ALL MODULES SHOULD EXTEND THIS CORE CLASS
class Ext {
  // (I1) LINK MODULE TO CORE
  public $Core;
  public $error;
  function __construct ($core) {
    $this->Core =& $core;
    $this->error =& $core->error;
  }

  // (I2) MAKE MODULES LINKING EASIER
  function __get ($name) {
    if (isset($this->Core->loaded[$name])) { return $this->Core->loaded[$name]; }
  }
}

LIB-User.php

<?php
class User extends Ext {
  // (A) GET ALL USERS
  function getAll () {
    return $this->Core->fetchAll(
      "SELECT * FROM `users`", null, "user_id"
    );
  }

  // (B) GET USER BY ID OR EMAIL
  //  $id : user id or email
  function get ($id) {
    return $this->Core->fetch(
      "SELECT * FROM `users` WHERE `user_". (is_numeric($id)?"id":"email") ."`=?",
      [$id]
    );
  }

  // (C) ADD A NEW USER
  function add ($name, $email) {
    // (C1) CHECK IF ALREADY REGISTERED
    if (is_array($this->get($email))) {
      $this->error = "$email is already registered!";
      return false;
    }

    // (C2) PROCEED ADD
    return $this->Core->exec(
      "INSERT INTO `users` (`user_name`, `user_email`) VALUES (?, ?)",
      [$name, $email]
    );
  }

  // (D) UPDATE AN EXISTING USER
  function edit ($name, $email, $id) {
    return $this->Core->exec(
      "UPDATE `users` SET `user_name`=?, `user_email`=? WHERE `user_id`=?",
      [$name, $email, $id]
    );
  }

  // (E) DELETE USER
  function del ($id) {
    return $this->Core->exec(
      "DELETE FROM `users` WHERE `user_id`=?",
      [$id]
    );
  }
}