https://github.com/hazardland/core.php
A framework which is a module which is the framework which is the module of the framework
https://github.com/hazardland/core.php
framework module mvc php
Last synced: about 1 year ago
JSON representation
A framework which is a module which is the framework which is the module of the framework
- Host: GitHub
- URL: https://github.com/hazardland/core.php
- Owner: hazardland
- Created: 2017-03-07T15:23:14.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-05-28T22:23:45.000Z (almost 9 years ago)
- Last Synced: 2025-01-14T03:43:17.688Z (about 1 year ago)
- Topics: framework, module, mvc, php
- Language: PHP
- Homepage:
- Size: 34.2 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
This is framework module. To see implementation of simple app using this framework please check https://github.com/hazardland/app.php
*For detailed documentation:* https://github.com/hazardland/core.php/wiki
When you live in PHP world while developing various web Apps you are often required to have:
- Seo friendly nice URLs
- With simpliest routing in background
- Defining locales, Always having active locale
- Generating custom urls
- Database handling, connet to server only when connection is required
- Abstract cache
- Dealing with sessions
- Basic setup
## Seo friendly nice URLs
```php
en/about/
fr/about/
en/blog/123-cool-article
en/user/123
//see declaring routes for this links below
```
## With simpliest routing in background
```php
//this is for en/about and fr/about
//App::getLocale() determines current locale in this case 'fr' or 'en'
Route::add('about','MyAboutController@defaultMethod');
//for en/blog/123-cool-article
Route::add('blog/{post_id}-{*}', function($post_id){
echo $post_id;
})->where('post_id',Input::INT);
//for en/user/123
Route::add('user/{id}', 'UserProfile@index');
//Named route:
Route::add('blog/article/{post}',function($post){})->name('article');
//Later you an access this route by name 'article' in Route::url ...
```
Where ```UserProfile@index``` you can imagine as file at ```./app/src/Controller/UserProfile.php```
```php
//file: ./app/src/Controller/UserProfile.php
namespace App\Controller;
class UserProfile
{
public function index ($user_id)
{
View::render('user/profile',['user_id'=>$user_id]);
}
}
```
Or just if you fill lazy you might do not need controller at all just parse view in route declaration:
```php
//We had this
Route::add('user/{id}', 'UserProfile@index');
//We can this instead also:
Route::add('user/{id}', function($user_id)(
View::render('user/profile',['user_id'=>$user_id]);
));
```
## Defining locales, Always having active locale
```php
//every day use
App::getLocale()
if (App::isLocale('en'))
//locale management
App::addLocale('en');
App::addLocale('fr');
App::setLocale('en');;
App::validLocale($locale);
//short version
if (App::locale()=='en')
if (App::locale('en'))
//path
App::getPath(); #get current app route path
```
## Generating custom urls
URLs with *locale* string using ```Route``` class:
```php
//If we have defined locales 'en','fr' and active locale is 'en'
//while calling Route::url():
Route::url('blog/article/17');
//Will return - '/en/blog/article/17'
Route::url('blog/article/17', 'fr');
//Will return - 'fr/blog/article/17'
//If your route is named as 'article'
//Using for example Route::add('blog/article/{post}',function($post){})->name('article')
//Then you can call Route::url passing route input parameters by array
Route::url('article',['post'=>17]);
//Will return - 'en/blog/article/17'
//To add custom locale to URL while using route name:
Route::url('article',['post'=>17],'fr');
//Will return - 'fr/blog/article/17'
//Of course if locale is not defined in APP
Route::url('blog/article/17');
//Will return - '/blog/article/17'
//Note: while passing route pass do not begin string with '/'
```
Genarating URLs using ```App``` class (without locales):
```php
App::url('js/jquery.js');
//Will return - '/js/jquery.js'
//Note: do not start App::url string whit '/'
```
If your App's public dir is located at server address:
```http://myserver.com/my/app/public```
Then calling ```App::url``` and ```Route::url``` will include this path:
```php
App::url('js/jquery.js');
//Will return '/my/app/public/js/jquery.js
Route::url('blog/article/17');
//Will return - /my/app/public/en/blog/article/17
```
Redirecting using ```Route::redirect```:
```php
//Route::redirect() accepts same parameteres as Route::url()
Route::reditect ('article',['post'=>17],'fr'); //Will redirect to '/fr/blog/article/17'
Route::reditect ('blog/article/17','fr'); //Will redirect to '/fr/blog/article/17'
Route::reditect ('blog/article/17'); //Will redirect to '/en/blog/article/17'
Route::redirect(); //Will redirect to '/en'
//If yout App's public is at server's address http://myserver.com/my/app/public
Route::reditect ('blog/article/17');
//Will redirect to http://myserver.com/my/app/public/en/blog/article/17
```
Redirecting using ```App::redirect```:
```php
App::reditect('some/where'); //Will redirect to '/some/where'
App::reditect(); //Will redirect to '/'
//If yout App's public is at server's address http://myserver.com/my/app/public
App::reditect('some/where'); //Will redirect to 'http://myserver.com/my/app/public/some/where'
App::reditect(); //Will redirect to 'http://myserver.com/my/app/public'
```
## Database handling, connet to server only when connection is required
(And also hide connection setup from developers if needed)
```php
//config (u can have many connection definitions)
//this line does not open connection
Database::add (
'mysql:host=127.0.0.1;dbname=test;charset=utf8', //dsn
'root', //user
'', //password
[\PDO::ATTR_ERRMODE=>\PDO::ERRMODE_EXCEPTION, PDO::ATTR_EMULATE_PREPARES=>false], //options
'default' //name
);
//usage
//this line opens connection on first call
Database::get('mySecondConenction')->query("SELECT 1");
Database::setDefault('mySecondConnection');
Database::get()->query("SELECT 1");
```
## Abstract cache
(Some servers have APC some have APCu some of them even different caching engines) all you need is:
```php
//This line goes in config
Cache::init(new \Core\Cache\Driver\APCu());
```
Currently core.php comes with APC and APCu cache drivers.
To make/use custom cache driver just implement \Core\Cache\Driver interface and use it via ```Cache::init()```.
```php
//usage
Cache::set('key','value');
Cache::get('key');
Cache::exists('key');
Cache::remove('key');
Cache::clean();
//Isolating app cache from another apps caches
Cache::setPrefix('myAppCachePrefix');
```
## Dealing with sessions
There are things you need to maintain when opening session, sometimes you need to open session with custom id, sometimes you need to have session name to separate one app session from another app session, for this you can use session class:
### Basic setup
*Defining custom session name.* By default php sessions does not have name. But you can have as much sessions for same domain for same client as you like. Setting session name also defines cookie name in which session id is stored in client's browser (default cookie name is PHPSESSID)
```php
Session::setName("myAppSessionName");
//This will not start new session
//But if session is started will use specified name for session
```
Custom session id. In some custom scenarios you might need to set your session id before session is started in this case you cane:
```php
Session::setId($myCustomSessionId);
```
Opening session. While called ```Session::open()``` will use predefined session name (if any) and will use predefined session id (if any, or will use php's default session id which is provided by cookie).
```php
Session::open();
//You can also call:
Session::open($myCustomSessionId);
```
Basically after starting session you can use ```$_SESSION``` variable. But session class provides some additional comfort:
Separating app's session variables under same session name with custom prefix:
```php
Session::setPrefix('myApp');
```
After this all variables set by ```Session::set('myKey1','myValue')``` will be stored under prefix key like: ```$_SESSION['myApp']['myKey1']``` and other session variable manipulation functions will consider also app's session prefix.
Setting and getting:
```php
Session::set('key','value');
Session::get('key','default'); //if key is not set will return 'default'
Session::all(); //returns all session variables under app's prefix
Session::remove('key');
Session::clean(); //removes all session variables under app's prefix
```
Session variable grouping effect:
```php
Session::set('aaa.key1','value1');
Session::set('aaa.key2','value2');
Session::set('aaa.key3','value3');
Session::set('bbb.key1','value1');
$values = Session::all('aaa.');
//In values we have ['aaa.key1'=>'value1','aaa.key2'=>'value2','aaa.key3'=>'value3']
Session::clean('aaa.'); //Will remove 'aaa.key1','aaa.key2' and 'aaa.key3' from session
//Where 'aaa.' is just a string prefix and could be anything like ending on any symbol.
```
Closing session
```php
Session::close(); //Will close session and session data will be available for next Session::open
```
Destroy session
```php
Session::destroy(); //will close and delete session
```