Flash - The PHP Framework

Created by Ingo Andelhofs
Student at UHasselt (2019)

Installation
Router Usage
Database Usage
Templating Engines Usage
JavaScript Helpers
In Development

Installation

Simple dowload & require

To start using FlashPHP, u first need to add the /_modules folder to your project.
Then you only need to require the index.php file.

require_once './_modules/index.php';

Composer install

Comming soon...

Router Usage

The biggest part of FlashPHP is the Router. You can easily create RESTful routes and use their given $request and $response objects to handle basic route functionalities.

Initialization

index.php

// Create a base router. In this case the home route.
$home = new Router('/home');

// Include other route files (see later) or use the same file for small Routers.
// Here we create a simple GET route '/index' for the home route.
// You can access this route by going to '{hostname}/home/index'.
$home->get('/index', function (Request $request, Response $response) {
  // Code for route here...
});

// Start the router. It is IMPORTANT that you start the Router at the end.
Router::start();

Default config

Config::default('PATH_COMPONENTS', './components');
Config::default('PATH_MODELS', './models');
Config::default('PATH_VIEWS', './views');
Config::default('PATH_TEMPLATES', './templates');
Config::default('PATH_ROUTES', './routes');
Config::default('PATH_MIDDLEWARE', './middleware');

Config::default('DEFAULT_ROUTER_METHOD', 'index');
Config::default('DEFAULT_ROUTER_ROUTE', 'home');

Config::default_obj('TEMPLATE_ENGINE', new MTemplatingEngine());

Request methods

$base_route = new Router('/base');

// GET (read) requests
$base_route->get('/index', function(Request $req, Response $res) {/* Code here... */});

// POST (write/create) requests
$base_route->post('/index', function(Request $req, Response $res) {/* Code here... */});

// PUT (update) requests
$base_route->put('/index', function(Request $req, Response $res) {/* Code here... */});

// DELETE (delete) requests
$base_route->delete('/index', function(Request $req, Response $res) {/* Code here... */});

The Request object

$route->get('/index/:param1/:param2', function(Request $req, Response $res) {
  // Returns an object of $_REQUEST, $_POST, $_GET, ($_PUT, $_DELETE)
  $req->body;
  $req->body->name;

  // Returns the parameter value given in the url or null if not given. 
  $req->params;
  $req->params->param2;

  // Returns the Database object. See later.
  $req->db;
  $req->db->create('User', ['name' => 'Jhon Doe', 'email' => 'jhond@example.com']);

  // Returns the uploaded files
  $req->files;
  $req->files->name->store('private/images/upload');

  // Returns the Session object
  $req->session;
  $req->session->username = 'ingo_andelhofs';
  $req->session->username; // returns 'ingo_andelhofs' (also set in $_SESSION['username'])

  // Returns the Cookie object
  $req->cookie;
  $req->cookie->firstname = 'Ingo';
  $req->cookie->firstname; // returns 'Ingo' (also set in $_COOKIE['firstname'])
})

The Response object

$route->get('/index', function(Request $req, Response $res) {
  // Send text data to route via htmlspecialchars
  $res->send('Hello World!');

  // Send datastructures as text data to route (print_r).
  $res->send_r([3, 4, 5]);

  // Send error
  $res->error('An error occured!');

  // Log a JavaScript message to the js console.
  $res->js_log('A console message.');

  // Convert a datastructure (array, ...) to json and send to route.
  $res->json(['name' => 'Ingo', 'age' => 19]); // -> {"name": "Ingo", "age": 19}

  // Render a view using the Template Engine. View files are in the view folder.
  $res->render('home/homepage');
  $res->view('home/homepage', ['title' => 'Welcome to the homepage.']);
  
  // End the script with a last message.
  $res->end();
  $res->end('End of the script');

  // Redirect to a given url. Or redirect back to the last visited url.
  $res->redirect('/home/index');
  $res->redirect_back();
  
  // Read a file
  $res->readfile('private/images/uploads/img.jpg');

  // Download a file
  $res->download('private/images/uploads/img.jpg');
});

Middleware & Auth

class Auth {
  public static function is_user($param) {
    return function() use($param) {
      ...
      return Middleware::next();
      return Middleware::block();
    };
  }
};

$auth->post('/admin_only', [Auth::is_user_logged_in(), Auth::is_user("admin")], function(Request $req, Response $res) {
  // Code for admin only here... 
});

File handeling

in $route_callback(Request $req, Response $res)

// check for files
$req->hasFiles();

// returns uploaded files
$req->files;

// file info
$req->files->profile_picture->extension;
$req->files->upload->type;
$req->files->image->...;

// file storing
$filename = $req->files->profile_picture->store('public/images');
$filename = $req->files->profile_picture->storeAs('public/images', 'filename'); // filename.jpeg -> autocomplete extention

// Downloading
$res->download($path);

Sessions and cookies

$home->get('/index', function(Request $req, Response $res) {
    // Cookies
    $req->cookie->username = 'Ingo';
    $res->send($req->cookie->user);

    // Sessions
    $req->session->user = [
        'fname' => 'Ingo',
        'lname' => 'Andelhofs',
        'pwd' => '**********'
    ];
});

Internal working

You can see this structure by using the Router::print_all() function.

./routes/home.php

// When u create a Router, it is added to Router::$routes_data. 
// All the information about the route is saved there.
$home = new Router('/home');
$home->get('/index/:id', function(Request $req, Response $res) {
  // Code here...
});

./_modules/core/Router.php

Router::$routes_data = [
    'home' => ['index' => ['get' => ['callback' => function($request, $response) {},
                                     'params' => [0 => 'id'],
                                     'path' => '/home/index', 
                                     'request_method' => 'GET', 
                                     'options' => [...]]
        ]
    ]
];

Database Usage

Initialization

It is simple to create a new DataBase, you just need to add some constants to your config.php file. These constants are the default arguments.

./_modules/config/config.php

define('DB_DRIVER', 'mysql');
define('DB_HOST', 'localhost');
define('DB_PORT', '3306');
define('DB_NAME', 'db-name');
define('DB_USERNAME', 'root');
define('DB_PASSWORD', '********');

$db = new DataBase();
$db2 = new DataBase($driver, $hostname, $port, $database_name, $username, $password);

DataBaseSchemas

Create these database schemas for better prepared statements (comming soon...) and to get a visual representation of your table.

new DataBaseSchema('User', [
  'id' => PDO::PARAM_INT,
  'firstname' => PDO::PARAM_STR,
  'lastname' => PDO::PARAM_STR,
  'email' => PDO::PARAM_STR,
  'password' => PDO::PARAM_STR
]);

New

You can create a new database function by using the new() function.

DataBase::new('select_query', function($db, $table_name) {
  return $db->query("SELECT * FROM $table_name;");
});

$db = new DataBase();
$db->select_query('User'); // -> Array(User1, User2, ...);

Query

A simple but save way to query.

// Result contains an array with Users or in the case of an Insert the inserted Id property.
$result = $db->query("SELECT * FROM User WHERE id=:id AND firstname=:firstname;", [
  'id' => 3,
  'firstname' => 'Ingo'
]);

Get

A simple select, read query.

// WHERE id=5
$db->get('User', ['id' => 5]);

// WHERE id=3 OR id=4 OR id=5
$db->get('User', ['id' => [3, 4, 5]]);

// WHERE id=5 AND firstname='Ingo'
$db->get('User', ['id' => 5, 'firstname' => 'Ingo']);

// Comming soon...
$db->getUser(['id' => 5]);
$db->getUserById(5);
$db->getUserById([3, 4, 5]);
$db->getUserByIdAndFirstname(5, 'Ingo');

Create

A simple insert, create query.

$id = $db->create('User', ['firstname' => 'Ingo', 'Lastname' => 'A.']);

// Coming soon...
$db->createUser(['firstname' => 'Ingo', 'Lastname' => 'A.']);

Delete

A simple delete query.

$db->delete('User', ['id' => 3]);

// Coming soon...
$db->deleteUser(['id' => 3]);
$db->deleteUserById(3);

Update

A simple update query.

$db->update('User', ['id' => 3], ['firstname' => 'Ingo']);

// Coming soon...
$db->updateUser(['id' => 3], ['firstname' => 'Ingo']);
$db->updateUserById(3, ['firstname' => 'Ingo']);

Exists

A simple check if an item exists.

$db->exists('User', ['id' => 5, 'firstname' => 'Ingo']);

// Coming soon...
$db->existsUser(['id' => 5, 'firstname' => 'Ingo']);
$db->existsUserWithId(5);
$db->existsUserWithIdAndFirstname(5, 'Ingo');

Duplicate

A simple duplicate query that returns the new id.

$id = $db->duplicate('User', ['id' => 5]);

// Coming soon...
$db->duplicateUser(['id' => 5]);
$db->duplicateUserById(5);

Templating Engines

BaseTemplatingEngine
NTemplatingEngine (No)
STemplatingEngine (Simple)
MTemplatingEngine (Medium)
Components

BaseTemplatingEngine

Simple rendering for views width data.

Rendering

./routes/home

$home->get('/index', function(Request $req, Response $res) {
  ...
  $res->view('home/homepage', [
    'title' => 'Welcome to the homepage.'
  ]);
});

./views/home/homepage

...
<h1><?php print($title); ?></h1>
...
<h1><?= $title ?></h1>

NTemplatingEngine

Simple rendering for views width data.
Var prefixing

STemplatingEngine

Simple rendering for views width data.
Var prefixing
Pretty printing
Templates

Pretty printing

./views/home/homepage

<!-- print via htmlspecialchars -->
<h1>{{ $title }}</h1>

<!-- print without htmlspecialchars -->
<h1>{{! $title }}</h1>

<!-- print via print_r -->
<h1>{{r $title }}</h1>

Templating

./templates/TemplateName

<html> 
  <head>
    @section scripts
  </head> 
  <body class="app">
    @section main
  </body>  
</html>

./views/home/template

@extends TemplateName

@section scripts
<script src="./public/app.js"></script>

@section main
<h1>Welcom</h1>

MTemplatingEngine

Simple rendering for views width data.
Var prefixing
Pretty printing
Templates
Conditionals
Components

Conditionals

./views/home/homepage

<!-- If statements -->
@if(condition):
  <p>If is true</p>
@else if(condition):
  <p>Else if is true</p>
@elif(condition):
  <p>Elif is true</p>
@endif

<!-- Foreach loops -->
@foreach($names as $name):
  <p>{{ $name }}</p>
@endforeach

Components

./views/home/homepage

<!-- Via component::render -->
<?php Component::render('banner', ['title' => 'Welcome']); ?>

<!-- Via component::compName -->
<?php Component::compName(['title' => 'Welcome']); ?>

<!-- Via MTemplatingEngine -->
@component compName('title' => 'Welcome')
@component compName['title' => 'Welcome']

JavaScript Helpers

RESThelper.js

Support for REST forms.
Supported methods: GET, POST, PUT and DELETE.

<form action='/home/index' method='PUT'>
  <!-- Input fields -->
  <input type='submit' value='Click'>
</form>

Support for REST links.
Supported attributes: href, data-req, data-body (except for DELETE) and data-async (coming soon...).

<a href='/homs/index' data-req='PUT' data-body='{"name": "Ingo Andelhofs", "id": 5}'>Link to somewehere.</a>
<a href='/homs/index' data-req='DELETE' data-async='true'>Click and async.</a>

In Development

Validation

in $route_callback(Request $req, Response $res)

$req->validate();
$req->body()->validate();

Flash messages

in $route_callback(Request $req, Response $res)

$res->flash($name, $message);

Component::flash_message();

flash-php/express-php

Flash - The PHP Framework

Table of Contents

Installation

Simple dowload & require

Composer install

Router Usage

Initialization

Default config

Request methods

The Request object

The Response object

Middleware & Auth

File handeling

Sessions and cookies

Internal working

Database Usage

Initialization

DataBaseSchemas

New

Query

Get

Create

Delete

Update

Exists

Duplicate

Templating Engines

BaseTemplatingEngine

Rendering

NTemplatingEngine

STemplatingEngine

Pretty printing

Templating

MTemplatingEngine

Conditionals

Components

JavaScript Helpers

RESThelper.js

In Development

Validation

Flash messages