Skip to content

ArefShojaei/Lite-PHP

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

654 Commits
bootstrap
bootstrap
 
 
console/commands
console/commands
 
 
core
core
 
 
hooks
hooks
 
 
modules
modules
 
 
plugins
plugins
 
 
public
public
 
 
resources
resources
 
 
storage
storage
 
 
.env.example
.env.example
 
 
.gitignore
.gitignore
 
 
.htaccess
.htaccess
 
 
README.md
README.md
 
 
cli
cli
 
 
composer.json
composer.json
 
 
gulpfile.mjs
gulpfile.mjs
 
 
init
init
 
 
package.json
package.json
 
 
robots.txt
robots.txt
 
 
server.php
server.php
 
 

Repository files navigation

Picture

Tutorial :

  1. Introduction
  2. Installation
  3. Folder Structure
  4. Root Files
  5. Modules
  6. Template Engine
  7. Helpers
  8. Hooks

Introduction

What is Lite-PHP ?

Lite-PHP is a Micro Freamework for developing Back-end Applications

Why Lite-PHP ?

Because Lite-PHP has:

Simple & Fast Development Env

Modular Strucutre

DBMS Like Mysql

Testing Module

Custom Plugins & Hooks

Custom Command-line in console

REST API Development

Functional Programming Structure

Folder Strucutre

No OOP & No Object & No Class


Installation

Using GIT

git clone https://github.com/ArefShojaei/Lite-PHP

Using Composer

composer create-project arefshojaei/lite-php

Folder Structure

Here is default folder structure for starting new project !

|- bootstrap/
|
|- console/
|
|- core/
|
|- hooks/
|
|- modules/
|
|- plugins/
|
|- public/
|
|- resources/
|
|- storage/
|
|
|- .env.example
|- .gitignore
|- .htaccess
|- cli
|- composer.json
|- gulpfile.mjs
|- init
|- package.json
|- README.md
|- robots.txt
|- server.php

core/

Main files or Lite-PHP core files that can be provided base files for every projects!

bootstrap/

Base files to boot the app

modules/

Modules that the app needs to run as main file

hooks/

Lets you to development custom hooks

plugins/

Lets you to development custom plugin

public/

Static files in production with entry point file ( index.php )

resources/

Asset and View files

storage/

Local folder & files like Log, Cache & Upload ...


Root Files

.env.example

This is a config for ENV , Then before starting the project you must changed it from .env.example to .env file!

.gitignore

This is a config to hide files to not push on Github

.htaccess

Apache web server config

cli

Console configuration to use commands

composer.json

Passport of package info

gulpfile.mjs

Task-runner configuration for assets

init

Basic setup configuration to development app

package.json

List of pacakge dependencies that the Task-runner needs to run

README.md

Lite-PHP Package info

robots.txt

This is configuration for crawlers of Google

server.php

Main file for launching the app


Modules

Alias

Provides to register custom Alias

1-Example:

# Before
require_once "../../../modules/user/_controller.php";
require_once "../console/commands/package/_main.php";

# After + without using '.php' ext
import("@modules/user/_controller")
import("@commands/package/_main")

2-How can I use that ?

Move to "bootstrap/alias.php" Then, register an Alias by this way :

createAlias([
   # Guide
   "@<alias>" => dirname(__DIR__) . "path",

   # Example
    "@core" => dirname(__DIR__) . "/core",
    "@modules" => dirname(__DIR__) . "/modules",
    ...
]);

Config

Registers new configuration for a module

1-How can I create a config ?

import("@core/modules/config/createConfig");

createConfig("name", [
    "key" => "value"
])

2-How can I use the config ?

import("@core/hooks/useConfig");


# Usage
useConfig("name.key")

Enum

Registers an Enum as constant

1-How can I create an Enum ?

import("@core/modules/enum/createEnum");

createEnum("name", [
    "KEY" => "value"
])

2-How can I use the Enum ?

import("@core/hooks/useEnum");


# Usage
useEnum("name::KEY")

Plugin

Registers new Plugin

Note: We have two types for using plugin :

  1. Runner Type needs to register in "bootstrap/providers.php"
  1. Usage Type needs to use in logic code

1-How can I create a Runner Plugin ?

import("@core/modules/plugin/createPlugin");

# Usage
createPlugin("name", function ($params) {}, false);

2-How can I use the Runner Plugin ?

Move to "bootstrap/providers.php" , then use this way to register the Runner Plugin

"plugins" => [
    # Usage
    registerPlugin("name"),
    
    
    # Examples
    registerPlugin("logger", ["level" => "short"]),
    registerPlugin("security"),
    registerPlugin("cors"),
],

3-How can I create a Usage Plugin ?

import("@core/modules/plugin/createPlugin");

# Usage
createPlugin("name", function () {});

4-How can I use the Usage Plugin ?

Note: for using the plugin, you should use this way

import("@core/hooks/usePlugin");


# Usage
list(...) = usePlugin("name");

Template Engine

Provides to work as professional with templates instead of using usual php template engine !

Examples :

Before - views/user.php

<?php foreach ($users as $user): ?>
    <div class="user-card">
        <span>ID: <?php echo $user['id'] ?> </span>
        <h3>Name: <?php echo $user['name'] ?> </h3>
        <p>CV: <?php echo $user['cv'] ?> </p>
    </div>
<?php endforeach; ?>

After - views/user.hbs

@foreach ($users as $user)
    <div class="user-card">
        <span>ID: {{ $user['id'] }} </span>
        <h3>Name: {{ $user['name'] }} </h3>
        <p>CV: {{ $user['cv'] }} </p>
    </div>
@endforeach

NOTE: We want to work it as professional with customized .hbs template engine and we don't have this like JS lib ( handlebars ) template engine and you should know about it that we have a customized template engine !

Syntaxes

{{ $variable }} # to Protect XSS attack 
{{{ $variable }}} # Not to Protect XSS attack
{{!-- comment message --}} # Writing Comment

Directives

Condition

# Directives
@if(expression)
@elseif
@else
@endif
{{!-- Example --}}
@if ($role == 'manager')
    <h3>Welcome Manager</h3>
@elseif ($role == 'admin')
    <h3>Welcome Admin</h3>
@else
    <h3>The Role is not valid!</h3>
@endif

Loop

# Directives
@foreach(expression)
@endforeach

@while(expression)
@endwhile

@break(expression)
@continue(expression)
{{!-- Example-1 --}}
@foreach($users as $user)
    <div>
        <h3>Name: {{ $user['name'] }} </h3>
        <p>Email: {{ $user['email'] }} </p>
    </div>
@endforeach


{{!-- Example-2 --}}
@while($count < 100)
    <p>Count: {{ $count }}</p>

    @countinue($count < 10)

    @break($count == 90)

    $count++;
@endwhile

Partial

# Directives
@include(partialPath)
{{!-- Example --}}
@include("/includes/header")
    <h1>Welcome Page</h1>
@include("/includes/footer")

Script

# Directives
@style
@endstyle
@linkStyle

@script
@endScript
@linkScript

@php
@endphp

@dump

@dd
{{!-- Example-1 --}}
@style
* {
    box-sizing: border-box;
    color : #e5e5e5;
}
@endStyle

@linkStyle("https://domain.com/bootstrap/styles/grid.min.css")


{{!-- Example-2 --}}
@script
    const username = promt('Enter your userName:')

    alert(username)
@endscript


@linkScript("https://domain.com/jquery/jquery.min.css")


{{!-- Example-3 --}}
@php
    $message = "Welcome to Lite PHP"

    echo $message;
@endphp


{{!-- Example-4 --}}
@dump($message, true, [])

@dd([1,2,3,4,5])

Validation

# Directives
@isset(expression)
@endisset

@empty(expression)
@endempty
{{!-- Example-1 --}}
@isset($user['isCheckedRole'])
    <p>User role is checked</p>
@endisset


{{!-- Example-2 --}}
@empty($posts)
    <p>Here we don't have any posts!</p>
@endempty

Auth

# Directives
@auth
@endauth

@authRole
@endauthRole

@guest
@endguest
{{!-- Example-1 --}}
@auth
    <a href="...">Dashboard Panel</a>
@endauth

{{!-- Example-2 --}}
@authRole("admin")
    <a href="...">Admin Dashboard</a>
@endauthRole


{{!-- Example-3 --}}
@guest
    <a href="...">Login</a>
    <a href="...">Register</a>
@endguest

Helpers

import

Loads file by Alias

import("@modules/user/_controller")


$user = getUser();

print_r($user);

Route

Adds new Route in a module

Note: You can use it by two ways:

  1. Add Single Route
  1. Group Routes
# Usage
import("@core/helpers/route");


# Single Route
addRoute("GET", "/user", "showUser"); # /user


# Group Route
groupRoute("/page", function() {
    addRoute("GET", "/", "__app__index"); # /page/home
    addRoute("GET", "/users", "__user__index"); # /page/users
    addRoute("GET", "/courses", "__course__index"); # /page/courses
});

DD

Dumps and dies an Array in browser

Note : You don't need to load the helper, Because the helper has loaded !

$user = [
    "id" => 1,
    "name" => "Robert",
    "skills" => ["PHP", ...]
];

# Usage
dd($user); # to dump and die

dd($user, false); # just to dump and no die

Parse

Gets file content

import("@core/helpers/parse");

$file = "links.txt";

# Usage
$links = prase($file);
$links = @prase($file); # use @ to get boolean or content if you don't want to get error

forach ($links as $link) {
    echo "[Link] {$link}" . PHP_EOL;
}

View

Renders view template

import("@core/helpers/view");

# Example 1
view("welcome");

# Example 2
$user = [
    "id" => 267
    "title" => "User Page",
    "name" => "Robert",
]

view("user", $user);

Command

Adds new Command to use in console

Note: You can use it by two ways:

  1. Add Single Command
  1. Group Commands
# Usage
import("@core/helpers/command");


# Single Command
addCommand("database", fn() => "Hi from Lite PHP", "Database status"); # php cli database


# Group Command
groupCommand("fake:", function() {
    addCommand("city", "action", "description"); # php cli fake:city
    addCommand("company", "action", "description"); # php cli fake:company
    addCommand("user", "action", "description"); # php cli fake:user
    addCommand("book", "action", "description"); # php cli fake:book
});

Test

Tests module

Note: You can test by two ways:

  1. Test single module by name
  1. Test all modules
# Usage
import("@core/helpers/test");


# Definition
describe('test-info', function() {
    it("test-description", function() {
        # use Asserts ...
        # Read "core/helpers/assertion.php" to use in this logic code !
    });
});


# Usage

    # Test All Modules 
    php cli test
    
    # Test Single Module 
    php cli test [module-name]

Build

Builds new path & URL

import("@core/helpers/build");

# Guide
buildURL("/products"); # [pre defined => (host:port)] + route


buildPath("/resources", "/lang/en/public"); # base path + path + file ext

Hooks

Note: You should use hooks in logic code and don't use that outer of logic code!


UseHTTP

Provides to use http as $_SERVER super global

import("@core/hooks/useHTTP");


function inspectRequest() {
    $method = useHTTP("REQUEST_METHOD");

    echo $method; # GET, POST, PUT, PATCH, DELETE
}

UseGET

Provides to use $_GET super global

import("@core/hooks/useGET");


function inspectRequest() {
    $username = useGET("username");
    $password = useGET("password");


    dd([
        "username" => $username,
        "password" => $password
    ]);
}

UsePOST

Provides to use $_POST super global

import("@core/hooks/usePOST");


function inspectRequest() {
    $token = usePOST("token");

    echo $token;
}

UseFetch

Provides to send http request

Examples :

# Send GET Request
import("@core/hooks/useFetch");

$response = useFetch("http://domain.com/end-point");


dd($response);
# Send POST Request
$params = [
    "method" => "POST",
    "body" => [],
    "headers" => [],
];

$response = useFetch("http://domain.com/end-point", $params);


dd($response);
# Send PUT Request
$params = [
    "method" => "PUT",
    "body" => [],
    "headers" => [],
];

$response = useFetch("http://domain.com/end-point", $params);


dd($response);
# Send PATCH Request
$params = [
    "method" => "PATCH",
    "body" => [],
    "headers" => [],
];

$response = useFetch("http://domain.com/end-point", $params);


dd($response);
# Send DELETE Request
$params = [
    "method" => "DELETE",
    "body" => [],
    "headers" => [],
];

$response = useFetch("http://domain.com/end-point", $params);


dd($response);

UseID

Provides to get random number ID

import("@core/hooks/useID");


function createUser($name, $email, $passowrd) {
    $id = useID();

    # logic code ...
}

UseConfig

Provides to get Config by key

Note: Sometimes you don't want to get error for getting value from the hook usage, First you should load target module configuration in current file or script !

import("@core/hooks/useConfig");


function createUser($name, $email, $passowrd) {
    $applicationName = useConfig("app.name");

    # logic code ...
}

UseEnum

Provides to get Enum by key

Note: sometimes you dont' want to get error for getting value from the hook usage, First you should load target module configuration in current file or script !

import("@core/hooks/useEnum");


function createUser($name, $email, $passowrd) {
    # User SQL Table
    $userTable = useEnum("User::TABLE");
    
    # HTTP Statuses
    $HTTP_200 = useEnum("HTTP::OK");
    $HTTP_201 = useEnum("HTTP::SUCCESS");
    $HTTP_400 = useEnum("HTTP::BAD");
    
    # logic code ...
}

UseState

Provides to define state in container as $GLOBALS['container'] super global

Note: The hook has more option that you will like that

  1. Define state as "value"
  1. Define state as "key" & "value"
  1. Define state as "key" (Nested) & "value"
import("@core/hooks/useState");


function createUser($id, $name, $email, $password) {
    $user = [
        "email" => $email,
        "password" => $password
    ];


    # First Way => Key & Value
    useState("users", [], $user);
    
    # Second Way => Key & Value
    useState("users", [$name], $user);
    
    # Third Way => Nested Keys & Value
    useState("users", [$id, $name], $user);


    # Then inspect $GLOBALS['container']['users']




    # logic code ...
}

UseGlobal

Provides to get value from container as $GLOBALS['container'] super global

import("@core/hooks/useGlobal");


function listComamnds() {
    $comamnds = useGlobal("commands"); # $GLOBALS['container']['commands']


    # logic code ...
}

UseHash

Provides to hash password

import("@core/hooks/useHash");


function createUser($name, $email, $passowrd) {
    $hashedPassword = useHash($password);

    # logic code ...
}

UseVerifyPassword

Provides to verify hashed password

import("@core/hooks/useVerifyPassword");


function checkPassword($password,  $hashedPassowrd) {
    $isValidPassword = useVerifyPassword($password, $hashedPassword);

    # logic code ...
}

UseVerifyPassword

Provides to verify hashed password

import("@core/hooks/useVerifyPassword");


function checkPassword($password,  $hashedPassowrd) {
    $isValidPassword = useVerifyPassword($password, $hashedPassword);

    # logic code ...
}

UseHTML

Provides to get html content by url

import("@core/hooks/useHTML");


function getSiteHtmlContent($url) {
    $html = useHTML($url);

    # logic code ...
}

UseMode

Provides to get current app mode from ".env" as APP_MODE ( Production | Development )

import("@core/hooks/useMode");


function getApplicationModeStatus() {
    $mode = useMode(); # Production | Development

    # logic code ...
}

UseEnv

Provides to get env from ".env" by key

import("@core/hooks/useEnv");


function createDatabaseConnection() {
    $db = useEnv("DATABASE_DB");
    $host = useEnv("DATABASE_HOST");
    $username = useEnv("DATABASE_USER");
    $password = useEnv("DATABASE_PASS");

    # logic code ...
}

UseLog

Provides to put log message

import("@core/hooks/useLog");


function showDashboardPage() {
    useLog("Admin Logged in!");

    # logic code ...
}

UsePlugin

Provides to use plugins that has usage type

import("@core/hooks/usePlugin");


function getShortLink($longURL) {
    [...] = usePlugin("shortLink");

    # logic code ...
}

UseQuery

Provides to run SQL query

import("@core/hooks/useQuery");


function createUser($name, $email, $passowrd) {
    useQuery("INSERT INTO `users` (name, email, password) VALUES (?, ?, ?)", [$name, $email, $passowrd]);
    
    # logic code ...
}

function doLogin($email, $passowrd) {
    $user = useQuery("SELECT * FROM `users` WHERE email = ?", [$email]);

    dd($user);
    # logic code ...
}

UseResponse

Provides to return content output to the response as JSON | HTML | TEXT

Note : You don't need to set content-type in header, Because the hook has done it

  • @Reference : core/hooks/useType
  • @Reference : core/hooks/useResponse
import("@core/hooks/useResponse");


function showLoginPage() {
    $form = "
        <form action='' method='POST'>
            <input type='email' name='email' />
            <input type='password' name='password' />
            <button type='submit'>Login</button>
        </form>
    ";
    
    return useResponse("html", $form);
}

UseRequest

Provides the request data

import("@core/hooks/useRequest");


function inspectRequest() {
    $host = useRequest("host"); # site.com
    $ip = useRequest("ip"); # 192.168.1.1
    $method = useRequest("method"); # GET | POST | PUT | PATCH | DELETE
    $protocol = useRequest("protocol"); # HTTP | HTTPS
    $query = useRequest("query"); # LIKE /product/?category='mobile'&limit=10
    $route = useRequest("route"); # /products
    $routeParams = useRequest("params"); # /product/{id} => ["id" => 171]
    $userAgent = useRequest("userAgent"); # ...


    # logic code ...
}

UseRedirect

Provides to redirect to a route

import("@core/hooks/useRedirect");


function inspectRequest() {
    $isValidUser = true;

    if($isValidUser) {
        useRedirect("/dashboard");
    }

    # logic code ...
}

UseURL

Provides to parse URL

import("@core/hooks/useURL");


function inspectRequest() {
    $parsedURL = useURL("http://localhost:5000/api/v1/products/?limit=25");

    dd($parsedURL);
    # logic code ...
}

UseBody

Provides to get the request body data

import("@core/hooks/useBody");


function inspectRequest() {
    $token = useBody("token");

    # logic code ...
}

UseHeader

Provides to add & remove header by key and value

import("@core/hooks/useHeader");


function inspectRequest() {
    $fakeUserAgent = "...";

    # add
    useHeader("HTTP_USER_AGENT", $fakeUserAgent);
    
    # remove
    useHeader("X-Powered-By");


    # logic code ...
}

UseMatch

Provides to use regex

import("@core/hooks/useMatch");


function isValidEmail($email) {
    $regexPattern = "/^\w+@gmail.com$/";

    $result = useMatch($regexPattern, $email);

    dd($result);

    # logic code ...
}

UseFlash

Provides to add & remove falsh message

import("@core/hooks/useFlash");


function doLogin() {
    useFlash("login", "Invalid Email or Password!");
    
    # logic code ...
}

About

Micro PHP Freamework | Modular Structure | Just Pure!

packagist.org/packages/arefshojaei/lite-php

Topics

plugin api php hook modular module backend rest-api php-framework php8 freamework lite-php

Resources

Readme
Activity

Stars

4 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

49 tags

Packages

No packages published

Languages