You can select version on branch list.
Install packages (Vendors included because modified some modules)
cmd> composer installPHP VERSION
PHP>=7.0.23You can read detailed documention(only Turkish) or read here.
- 1. Route
- 2. Model
- 3. Date
- 4. Mail
- 5. Controller
- 6. View
- 7. zhelper (deprecated)
- 8. Terminal
- 9. Csrf
- 10. Language
- 11. Crypter
- 12. Config
- 13. Alerts
- 14. Validator
- 15. Middleware
- 16. Cache
- 17. API
- 18. Development
- 19. Helper Methods
- 20. Run Project
- 21. Run WS Server
// Any METHOD Route
Route::any('/', function() {
return 'Method: ' . method();
});
// Get METHOD Route
Route::get('/', function() {
return 'Hi 👋';
});
// POST METHOD Route
Route::post('/', function() {
return 'You verified CSRF Token.';
});
// PATCH METHOD Route
Route::patch('/', function() {
return 'patch.';
});
// PUT METHOD Route
Route::put('/', function() {
return 'put.';
});
// DELETE METHOD Route
Route::delete('/', function() {
return 'delete.';
});
// Also you can use like that: (2. Parameter: 'Controller@method')
Route::get('/', 'HomeController@index');
// you can use parameters in uri.
Route::get('/test/{name}/{?surname}', function($name, $surname = null) {
echo "Hey $name $surname";
});
// if you create resource controller it's like that simple
Route::resource('/', TestController::class, ['name' => 'home']);
Resource Route list:
|--------------|-------------|---------------------|---------------|
| URL | METHOD | Callback Function | Route Name |
| ------------ | ----------- | ------------------- | ------------- |
| / | GET | index() | home.index |
| / | POST | store() | home.store |
| /{id} | GET | show($id) | home.show |
| /{id}/edit | GET | edit($id) | home.edit |
| /create | GET | create() | home.create |
| /{id} | PUT/PATCH | update($id) | home.update |
| /{id} | DELETE | delete($id) | home.delete |
| ------------ | ----------- | ------------------- | ------------- |
# if you wanna simple use route names for resource
Route::resource('/test', ResourceController::class);
# result:
test.index
test.store
test.show
test.edit
test.create
test.update
test.delete
// two example for select name.
Route::findRoute('test.index'); // output: www.host.com/test
Route::findRoute('test.edit', ['id' => 1]); // output: www.host.com/test/1/edit
// for Group usage:
// prefix_URL
Route::pre('/admin')->group(function() {
Route::resource('/', ResourceController::class);
});
Route::findRoute('admin.index'); // output www.host.com/admin
// url: /admin/user/...
Route::pre('/admin')->group(function() {
Route::pre('/user')->group(function() {
Route::post(..., ...);
});
});
Route::noCSRF()->group(function() {
Route::post(..., ...); // that not need a csrf token allow all request like GET method.
});
// merge using
Route::pre('/admin')->noCSRF()->group(function() {
Route::post(..., ...); // that not need a csrf token allow all request like GET method. and have /admin prefix.
});
// And you can use for findRoute
route('admin.index') // output www.host.com/admin You must use csrf token for POST methods. (if you not add "no-csrf" option.)
<!-- for store() method -->
<form method="POST">
{{ Csrf::csrf() }}
<input type="submit">
</form>
<!-- for update() method -->
<form action="/1" method="POST">
{{ Csrf::csrf() }}
{{ inputMethod('PATCH') }}
<input type="submit">
</form>
<!-- for delete() method -->
<form action="/1" method="POST">
{{ Csrf::csrf() }}
{{ inputMethod('DELETE') }}
<input type="submit">
</form>
Also you can use `csrf()` method
<form method="POST">
{{ csrf() }}
...
</form>Callback function can be a Controller class example:
// App\Controllers\TestController.php
class ...{
public function index() {
return 'Hi 👋';
}
}
// Route/web.php
Route::get('/', [TestController::class, 'index']);How i use parameters? (it's same for Controller's functions)
Route::get('/{id}', function($id) {
return "ID: $id";
})ALSO you can normal query like /1?test=true
Route::post('/store', [TestController::class, 'store']);
// Other way for middleware (if you use that way you can not find route name.)
Middleware::middleware([Auth::class, Guest::class], function ($declined) {
if (count($declined)) return;
Route::get('/test', function () {
return "Hey 👋";
})->name('test'); // if middleware not verify you can not find that name.
});
// if you want use route with middleware and name still findable.
Route::pre('/admin')->middleware([Auth::class, Admin::class], function($declines) { # Optional callback method.
abort(403, 'Access Forbidden');
})->group(function() {
Route::get('/dashboard')->name('dashboard');
});
echo route('admin.dashboard'); # i can still find route but i cant access with out middlewares verify.
Route::pre('/admin')->group(function() {
Route::get('/any-page', AnyController::class)->name('any-page');
Route::resource('/', DashboardController::class);
}); // Route/web.php
Route::get('/test/{id}/{username}', function ($id, $username) {
echo "$id - $username";
})->name('test');
// Usage:
echo Route::findRoute('test', ['id' => 1, 'username' => 'Admin']); // output: www.host.com/test/1/Admin
# or
echo route('test', ['id' => 1, 'username' => 'Admin']) // same output. class User extends Model {
use softDelete; // (optional) if you are need soft delete a table's row use this. that mean delete you can not seen but not delete in db.
public $table = "users";
public $db = "local"; // (optional) if you do not write that it's connect your first connection.
// do not show that columns but if you use ->select('guarded_column_name') you can see it
public $guard = ['password', 'api_token'];
public $primary = "column_name" // (optional) select table primary key it's default is null and select automatic primary key
public $updated_at = "custom_updated_at_name" // (optional) if you use updated_at attribute it's default = updated_at
public $created_at = "custom_created_at_name" // (optional) if you use created_at attribute it's default = created_at
public $deleted_at = "custom_deleted_at_name" // (optional) if you use deleted_at attribute it's default = deleted_at
}
// if you wanna see your deleted_at items
$users = (new DB)->table('users')->get(); // return with deleted_at items.
// Usage:
use App\Models\User;
$user = new User;
echo "<pre>";
print_r([
"get" => $user->get(),
"count" => $user->count(),
"first" => $user->where('id', 1)->first(),
"firstOrFail" => $user->where('id', '=', 1)->firstOrFail(), // If can not find a row abort 404
"paginate" => $user->paginate(20, 'page_request_name'),
"insert" => $user->insert(['username' => 'username', 'password' => 'password','email' => '[email protected]']),
"update" => $user->where('id', 1)->update(['email' => '[email protected]']),
"delete" => $user->where('id', '>', 2)->delete()
]);
// if you wanna get type class = ->get(true) | ->first(true);
// Where example
$user->where('id', '=', 1)->where('email', '=', '[email protected]', 'OR')->get();
// Find example that is for first key my users table's first key is id
$user->find(1);
// Select example
$user->select('id, username')->get();
// OrderBy example
$user->orderBy(['id' => 'ASC', 'username' => 'DESC'])->get();
// GroupBy example
$user->groupBy('username');
// Limit example args: 10(startCount), 10(rowCount)
$user->limit(5, 10)->get();
// paginate example for return class or array
$user->paginate(20, 'request_id', true|false);
// Joins example
$user->join('LEFT|RIGHT|OUTER|FULL|NULL', App\Models\User::class, ['table_name.id', '=', 'this_table.id'])->get();
// OR Joins example
$user->join('LEFT|RIGHT|OUTER|FULL|NULL', App\Models\User::class, ['table_name.id = this_table.id'])->get();
var_dump($result); // row count Auth::login($user) // login with $user->first()
Auth::api_login($token) // login with api_token
Auth::logout() // logout user
Auth::check() // check is logged in?
Auth::user() // (if logged in) get user
Auth::attempt(array, true|false) // example ['username' => 'test', 'password' => 'test'], true (for stay in)
Auth::id() // get user id
// An example model
class User extends Model
{
use softDelete;
public $observe = UserObserver::class; // Put here that because we must do select observer.
public $table = "users";
public function getAttributes()
{
return [$this->attributes, $this->attrCount];
}
}
// create observer
> php terminal make observer UserObserver
// created a observer like that
class UserObserver extends Observer
{
/**
* Insert before run that
*/
public function oninsert(array $args)
{
echo "inserting";
print_r($args);
return $args;
}
/**
* Insert after run that
*/
public function oninserted(array $args)
{
echo "inserted: ";
print_r($args);
}
/**
* Update before run that
*/
public function onupdate(array $args)
{
echo "updating:";
var_dump($args);
}
/**
* Update after run that
*/
public function onupdated(array $args)
{
echo "updated:";
var_dump($args);
}
/**
* Delete before run that
*/
public function ondelete(array $args)
{
echo "deleting:";
var_dump($args);
}
/**
* Delete after run that
*/
public function ondeleted(array $args)
{
echo "deleted:";
var_dump($args);
}
} // You can find how create a migration in zhelper section
// Folder path: database/migrations
// Example: (that file is real)
// (Folder path)/Users.php
class Users
{
static $storageEngine = "InnoDB"; // you can change that what are you want to store your sql engine.
static $charset = "utf8_general_ci"; // set default charset for table (so that effect all columns)
static $table = "users"; // create table name
static $db = "local"; // db key from database/connections.php
public static function columns() // Insert columns
{
return [
'id' => ['primary'],
'username' => ['varchar:50', 'charset:utf8mb4_general_ci'],
'password' => ['varchar:50', 'charset:utf8mb4_general_ci'],
'email' => ['varchar:50', 'charset:utf8mb4_general_ci', 'unique'],
'api_token' => ['varchar:60', 'required', 'charset:utf8mb4_general_ci'],
'timestamps', // create updated_at, created_at columns
'softDelete' // Use soft delete column
];
}
}
// can use parameters:
[
'primary',
'unique',
'text',
'bigint',
'int',
'smallint',
'tinyint',
'decimal',
'float',
'varchar', // default 255
'char', // default 50
'char:numeric_length',
'varchar:numeric_length',
'date',
'datetime',
'time',
'required',
'nullable',
'default', // default NULL
'default:default value',
'charset:utf8mb4_general_ci',
'timestamps', // create updated_at, created_at columns
'softDelete' // Use soft delete column
] // You can find how create a seeder in zhelper section
// Folder path: database/seeders
// Example: (that file is real)
// (Folder path)/Seeder.php
class Seeder
{
public function __construct()
{
$this->user = new User;
}
public function seed()
{
$this->user->insert([
'username' => 'admin',
'password' => Crypter::encode('admin'),
'email' => '[email protected]',
'api_token' => Str::rand(60)
]);
}
}
// Like that. If you wanna use that system, your table's store engine is must InnoDB.
$this->user = new User;
$this->user->beginTransaction();
$this->user->insert([
'username' => 'admin',
'password' => .....,
.......
]);
$api = ...... #(output: status = 0)
if($api->status) {
$this->user->commit();
echo "Successfully done.";
}else {
$this->user->rollback();
echo "Process fail, rollbacked.";
} Date::setLocale('Europe/Istanbul');
Date::locale(); // return Europe/Istanbul
Date::format(time()|date(), 'd.m.Y H:i');
Date::now(); // d.m.Y H:i
Date::timestamp(); // current TIMESTAMP // Config
// edit: config/mail.php
// if you wanna mail send you must be true sending parameter
// Usage
Mail::to('[email protected]')->send([
'subject' => 'test',
'message' => 'test mesaj', // you can also use view('view_name', ['hash' => Str::rand()]) method and set veriables;
'altbody' => 'Alt body',
'attachements' => [
'uploads/1.png',
'uploads/2.png'
]
]);
// Or Usage
Mail::to(...)->send([...]); class ... {
public function __construct() {
echo "Hi, this is __construct.";
$this->user = new User;
}
public function index() {
$hi = 'hey';
return View::view('home.index', compact('hi');
}
public function show($id) {
return View::view('home.user', ['user' => $this->user->first()]);
//
return view('home.user', ['user' => $this->user->first()]); // also you can use that
}
} ### Currently directions, like blade view engine.
- `@if`, `@elseif` and `@else`
- `@empty` and `@endempty`
- `@isset` and `@endisset`
- `@foreach` and `@endforeach`
- `@forelse`, `@empty` and `@endforelse`
- `@php` and `@endphp`
- `@json`
- `@dump` and `@dd`
- `@include`
- `@extends`, `@yield` and `@section`
# You can add custom direction
View::directive('style', function($href = null) {
if ($href) return '<link rel="stylesheet" type="text/css" href="' . $href . '" />';
return '<style>';
});
View::directive('endstyle', function() {
return '</style>';
});
View::directive('page', function($page) {
return '<?php if (isset($_GET["page"]) && $_GET["page"] === \'' . $page . '\'): ?>';
});
View::directive('endpage', function() {
return '<?php endif; ?>';
});
// Use That
view('home.index', ['hi' => 'hey']);
// OR That
use Core\View;
echo View::view('home.index', ['hi' => 'hey']);
// call in view. In home.index:
<div>
List:
{{ view('home.list', $view_parameters) }} // Output: echo $hi; = hey // SAME
{{ View::view('home.list', $view_parameters) }} // Output: echo $hi; = hey // RESULT
</div> // path: App\Providers\ViewProvider.php
class ViewProvider
{
public function __construct()
{
View::bind('test', function () {
$user = new User;
return [
'users' => $user->get()
];
});
}
}
// test view get every time $users parameter. ....
C:\Users\...\Desktop\Project>php zhelper
// Makes Usage:
# Controller // what are u want // if u want get ready resource controller (Optional)
> php zhelper make controller Test\TestController resource
# Model // what are u want
> php zhelper make model Test\Test
# Observer // what are u want
> php zhelper make observer Test\TestObserver
# Middleware // what are u want
> php zhelper make middleware Test\Test
# Database Migration // what are u want
> php zhelper make migration Users
# Database Seeder // what are u want
> php zhelper make seeder UsersSeeder
# Database Migrator:
php zhelper db migrate // output: just add/modify after changes columns.
php zhelper db migrate fresh // output: reset table and write all columns.
# Database Seeder:
php zhelper db seed // output: seed all seeders.
# Database Backup:
# you must set app.config.mysql.mysqldump path.
php zhelper db backup local // output: backup db to /database/backups/mysql/...
# cache delete
php zhelper cache clear sessions|caches|viewsRun project.
....
// Default run host's ip and 1000 port
C:\Users\...\Desktop\Project>php zhelper run (press enter)
// with custom ip and port
C:\Users\...\Desktop\Project>php zhelper run 127.0.0.1 2000 (press enter) ....
C:\Users\...\Desktop\Project>php terminal
// Makes Usage:
# Controller # what are u want // if u want get ready resource controller (Optional)
> php terminal make controller Test/TestController --resource
# Model # what are u want
> php terminal make model Test/Test
# Request for methods. # what are u want
> php terminal make request Users/StoreRequest
# Usage:
function($id, $vars = null, StoreRequest $request) {
$request = $request->validated();
}
# Observer # what are u want
> php terminal make observer Test/TestObserver
# Middleware # what are u want
> php terminal make middleware Test/Test
# Database Migration # what are u want
> php terminal make migration Users
# Database Seeder # what are u want
> php terminal make seeder UsersSeeder
# Database Migrator:
php terminal db migrate // output: just add/modify after changes columns.
php terminal db migrate --fresh // output: reset table and write all columns.
php terminal db migrate --fresh --seed // output: reset table and seed it.
# Database Seeder:
php terminal db seed // output: seed all seeders.
# Database Backup and Restore:
php terminal db backup // output: backup db to /database/backups/{dbname}...
php terminal db restore
# cache delete
php terminal cache clear sessions|caches|views // Usage:
Csrf::csrf(); // Output: ready csrf input
Csrf::get(); // Output: random_csrf_string
Csrf::set(); // Random/Renew set token
Csrf::unset(); // Destroy csrf token
Csrf::remainTimeOut(); // How much seconds left for change csrf token // Usage:
// Dir tree:
tr ->
lang.php // return array
auth.php // return array
en ->
lang.php // return array
auth.php // return array
// if you want change locale
Lang::locale('tr');
// if you wanna get a parameter
Lang::get('lang.test', ['id' => 1, 'test' => 'hey']);
Lang::get('auth.wrong-password');
// How i select default lang? (if not exists in lang list browser language select default)
config ->
app.php ->
lang => 'tr'
// get lang list
print_r(Lang::list()); # Usage:
$encode = Crypter::encode('test'); // result: {test_hashed_code}
$decode = Crypter::decode($encode); // result: test
$encodeArray = Crypter::encodeArray(['test', 'test2']);
$decodeArray = Crypter::decodeArray($encodeArray); Config::get('app'); // return all config
Config::get('app.title'); // return in app config title index's element
Config::set('app', [
'title' => 'test'
]); // update config // Alerts is show just one time, when you refresh your page Alerts is gone.
# Usage:
Alerts::danger('text');
Alerts::success('text');
Alerts::info('text');
Alerts::warning('text');
// if you wanna use like chain
Alerts::danger('text')::success('text')::info('text')::warning('text');
// get alerts
Alerts::get(); // output: Array ([0] => ('success', 'text'), [1] => ('danger', 'text'))
// unset alerts
Alerts::unset(); <!-- shown alerts example bootstrap -->
<?php foreach(Alerts::get() as $alert): ?>
<div class="alert alert-{{ $alert[0] }}">
{{ $alert[0] }}: {{ $alert[1] }}
</div>
<?php endforeach; ?> // In array validate values.
// Current: type, required, max, min, same, email, unique, exists.
// Unique ussage:
# unique:table_name cl=column_name,db=database // cl and db parameters is optional, if you not add cl parameter get request key name, if you not add db parameter get first in array connection.
# exists:table_name cl=column_name,db=database // cl and db parameters is optional, if you not add cl parameter get request key name, if you not add db parameter get first in array connection.
// Unique Example: 'email' => ["unique:users cl=email,db=local"]
// Exists Example: 'email' => ["exists:users cl=email,db=local"]
Validator::validate($_REQUEST, [
'test1' => ['type:string', 'required', 'max:10', 'min:5', 'same:test2'],
'test2' => ['same:test1'],
]); # App\Middlewares\Auth.php
# Validate first and go on.
namespace App\Middlewares;
class Auth
{
public function __construct()
{
if (@$_SESSION['user_id']) return true;
}
public function error()
{
abort(401);
}
}
// Usage:
Middleware::middleware([Auth::class, Guest::class]); # # output: false
Middleware::middleware([Auth::class]); // if you are logged in # output: true
Middleware::middleware([Guest::class]); // if you are not logged in # output: true
Middleware::middleware([Auth::class, Guest::class], function($declined) {
print_r($declined);
}); // if you are logged in # output: Array ('Guest::class')
// if you are not logged in # output: Array ('Auth::class') // Parameters: cache name, what it storage, seconds type timeout
$users = Cache::cache('users', function() {
return (new User)->get();
}, (10 * 60));
print_r($users); # route/api.php
Route::get('/test', function () {
echo "API Page / user_id: " . Auth::id();
});
// example: http://localhost/api/test?user_token=12345678 (user logged in.) // Database connections
# Folder: database/connections.php
# before
$databases = [
'test' => ['mysql:host=localhost;dbname=test;charset=utf8mb4', 'root', '123123'],
];
# add a database
$databases = [
'test' => ['mysql:host=localhost;dbname=test;charset=utf8mb4', 'root', '123123'],
'test_2' => ['mysql:host=localhost;dbname=test_2;charset=utf8mb4', 'root', '123123'],
];
# use options
$databases = [
'test' => ['mysql:host=localhost;dbname=test;charset=utf8mb4', 'root', '123123', 'options' => [
[\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION] // for try catch PDOException
],
'test_2' => ['mysql:host=localhost;dbname=test_2;charset=utf8mb4', 'root', '123123'],
]];
# Folder config/app.php
# DEBUG MODE
// debug mode is come default is true.
'debug' => true|false
// debug mode is for error page to abort
# Folder config/app.php
// Usage Crypter
'key' => 'cryptkey',
'salt' => 'ThisSaltIsSecret',
# if you change that your hash encode's will change, and all hash need be unique for security.
# example
'key' => '82FDFE2976AC2C8B8EBD5A5737118',
'salt' => '4ljd5AyZc9',
# it is so secure. crypter make passwords or etc. // main base path
base_path("optional url add");
// Public path
public_path("optional url add");
// Show host name
host();
// Redirect
redirect("URL");
// Redirect to REFERER
back();
// Show current uri
uri();
// get current request method
method();
// show input method
inputMethod('GET|POST|PATCH|PUT|DELETE');
// Get Client IP
ip();
// Set http response code 200 to 500 and optional message.
abort(200, 'OK');
// get request
request('name');
// Response for Controllers or routes callbacks
Response::json([
'test' => 1
]);
// show csrf input
csrf();
// Call view method easy way, it's same View::view()
view(...., ....., ....);
// shortcut for Lang::get()
_l(...);
// shortcut for Config::get()
config(...);
// File
# Usage:
File::save('/uploads', 'http://images.com/image.jpg'); // uploads/**********.jpg
// For one
File::upload('/uploads', $_FILES['file'], [ // settings is optional
'accept' => ['jpg', 'jpeg', 'png'],
'size' => 300000 # byte
]); // return /uploads/image.ext
// For multip
File::upload('/uploads', $_FILES['files'], [ // settings is optional
'accept' => ['jpg', 'jpeg', 'png'],
'size' => 300000 # byte
]); // return array('/uploads/image.ext', '/uploads/image.ext');
# width, height
File::resizeImage('file_path', 50, 50); ....
// Default run host's ip and 80 port
C:\Users\...\Desktop\Project>php terminal run (press enter)
// with custom ip and port
C:\Users\...\Desktop\Project>php terminal run host=127.0.0.1 port=2000 (press enter) ....
C:\Users\...\Desktop\Project>php terminal ws (press enter)