Barak Framework

2018-01-03 framework barak framework mvc php Yorumlar

PHP MVC tabanlı Barak Framework 3 yayımlandı.

Barak Framework

PHP MVC Framework Like ROR

Requirements

Packages

Programming Language : Php

Database Access : MySQL

Web Server : Apache, Nginx, ISS

Package Manager : Composer

Configuration

Linux, Apache, MySQL, Php Installation : LAMP

Linux, Nginx, MySQL, Php Installation : LEMP

Web Server Settings : apache2-settings or nginx-settings or iss-settings

Package Mananger Installation : composer-installation

Install

composer create-project barak-framework/barak project_name

Run

cd project_name
php -S localhost:9090

and check homepage : http://localhost:9090 and thats all!

Releases

https://github.com/barak-framework/barak/releases

Guides

Simple Usage

request url : /

config/routes.php

ApplicationRoutes::draw(
  get("/", "home#index")
);

app/controller/HomeController.php

class HomeController extends ApplicationController {

  public function index() {
    $this->message = "Hello World";
  }

}

app/views/home/index.php

```php

Home#Index

; <?= $message; ?> ```

app/views/layouts/home.php

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="tr" lang="tr">
<head>
  <meta http-equiv="content-type" content="text/html; charset=utf-8" />
  <meta http-equiv="X-UA-Compatible" content="IE=edge" />
  <meta name="viewport" content="width=device-width, initial-scale=1" />
  <title></title>
</head>
<body>
  <?= $yield; ?>
</body>
</html>

Router (`config/routes.php`)

İstek yapılacak her URL için config/routes.php dosyası içerisinde izin verilen sınıftır. Eğer ilgili istek URL bulunmuyorsa public/404.html sayfası gösterilir.

Functions

get, post, resource, resources, scope, root

`get`

Simple

config/routes.php

ApplicationRoutes::draw(
  get("/home/index")
);

Dynamical Segment

Dinamik route tanımlamalarında “home#index” gibi hedef belirtilmek zorundadır:

config/routes.php

ApplicationRoutes::draw(
  get("/home/index/:id", "home#index")
);

Dinamik route tanımlamalarında ki “id” gibi parçalara erişim:

app/controllers/HomeController.php

class HomeController extends ApplicationController {

  public function index() {
    echo $this->id;
  }

}

app/views/home/index.php

```php

Home#Index

; <?= “id: $id”; ?> ```

`post`

Simple

config/routes.php

ApplicationRoutes::draw(
  post("/admin/login")
);

app/controllers/AdminController.php

class AdminController extends ApplicationController {

  protected $before_actions = [
  ["require_login", "except" => ["login", "logout"]]
  ];

  public function login() {

    if (isset($_SESSION["admin"]))
      return $this->redirect_to("/admin/index");

    if (isset($_POST["username"]) and isset($_POST["password"])) {

      if ($user = User::unique(["username" => $_POST["username"], "password" => md5($_POST["password"])])) {

        $_SESSION["success"] = "Admin sayfasına hoş geldiniz";
        $_SESSION["full_name"] = "$user->first_name $user->last_name";
        $_SESSION["admininfo"] = $user;
        $_SESSION["admin"] = true;

        return $this->render("/admin/index");

      } else {

        $_SESSION["danger"] = "Oops! İsminiz veya şifreniz hatalı, belki de bunlardan sadece biri hatalıdır?";

      }
    }

    return $this->render(["layout" => "default"]);
  }

  // public function index() {} // OPTIONAL

  public function logout() {
    if (isset($_SESSION["admin"]))
      session_destroy();
    return $this->redirect_to("/admin/login");
  }

  public function require_login() {
    if (!isset($_SESSION["admin"])) {
      $_SESSION["warning"] = "Lütfen hesabınıza giriş yapın!";
      return $this->redirect_to("/admin/login");
    }
  }
}

app/views/admin/index.php

```php

Admin#Index

; <?= $_SESSION[“full_name”]; ?> ```

`resource`

config/routes.php

ApplicationRoutes::draw(
  resource("/users")
);

Aşağıdaki routes kümesini üretir:

ApplicationRoutes::draw(
  get("/users/", "users#index"), // all record
  get("/users/create"),          // new record form
  post("users/save"),            // new record save
  get("/users/show"),            // display record
  get("/users/edit"),            // edit record
  post("/users/update"),         // update record
  post("/users/destroy")         // destroy record
);

`resources`

config/routes.php

ApplicationRoutes::draw(
  resources("/users")
);

Aşağıdaki routes kümesini üretir:

ApplicationRoutes::draw(
  get("/users", "users#index"),         // all record
  get("/users/create"),                 // new record form
  post("/users/save"),                  // new record save
  get("/users/show/:id", "users#show"), // display record
  get("/users/edit/:id", "users#edit"), // edit record
  post("/users/update"),                // update record
  post("/users/destroy")                // destroy record
);

`scope`

Kodları daha derli toplu kullanmak için Route'in Gruplama özelliğidir. Bir PATH altında CONTROLLER ve VIEW dizininin çalışma imkanı sağlar.

controller: app/controllers/PATH/CONTROLLER.php

view : app/views/VIEW/PATH/CONTROLLER/ACTION.php

Simple

config/routes.php

view : app/views/admin/categories/ACTION.php controller : app/controllers/admin/CategoriesController.php

ApplicationRoutes::draw(
 scope("/admin",
    resources("/categories")
 )
);

Aşağıdaki routes kümesini üretir:

ApplicationRoutes::draw(
  get("/admin/categories",          "categories#index", "/admin"),  // all record
  get("/admin/categories/create",   false,              "/admin"),  // new record form
  post("/admin/categories/save",    false,              "/admin"),  // new record save
  get("/admin/categories/show/:id", "categories#show",  "/admin"),  // display record
  get("/admin/categories/edit/:id", "categories#edit",  "/admin"),  // edit record
  post("/admin/categories/update",  false,              "/admin"),  // update record
  post("/admin/categories/destroy", false,              "/admin"),  // destroy record
);

Mix

config/routes.php

ApplicationRoutes::draw(
  get("/admin/login"),
  scope("/admin",
    [
    get("/users", "users#index"),
    get("/users/show/:id")
    ],
    resources("/categories"),
    resource("/products")
  );

);

Aşağıdaki routes kümesini üretir:

ApplicationRoutes::draw(
  get("/admin/login"),

  get("/admin/users",               "users#index",      "/admin"),  // all record
  get("/admin/users/show/:id",      false,              "/admin"),  // display record

  get("/admin/categories",          "categories#index", "/admin"),  // all record
  get("/admin/categories/create",   false,              "/admin"),  // new record form
  post("/admin/categories/save",    false,              "/admin"),  // new record save
  get("/admin/categories/show/:id", "categories#show",  "/admin"),  // display record
  get("/admin/categories/edit/:id", "categories#edit",  "/admin"),  // edit record
  post("/admin/categories/update",  false,              "/admin"),  // update record
  post("/admin/categories/destroy", false,              "/admin"),  // destroy record

  get("/admin/products",           "products#index",    "/admin"),  // all record
  get("/admin/products/create",     false,              "/admin"),  // new record form
  post("/admin/products/save",      false,              "/admin"),  // new record save
  get("/admin/products/show",       false,              "/admin"),  // display record
  get("/admin/products/edit",       false,              "/admin"),  // edit record
  post("/admin/products/update",    false,              "/admin"),  // update record
  post("/admin/products/destroy",   false,              "/admin")   // destroy record
);

`root`

config/routes.php

ApplicationRoutes::draw(
  root("home#index")
);

Aşağıdaki routes kümesini üretir:

ApplicationRoutes::draw(
  get("/", "home#index"),
);

Controllers (`app/controllers/*.php`)

Her config/routes.php içerisinde tanımlanan get işlemi için app/controller/*.php dosyası içerisinde fonksiyon tanımlamak zorunlu değildir, fonksiyon tanımlanırsa ve değişken yükü/yükleri controller içinde $this->KEY şeklinde tanımlanırsa ilgili yönlenen sayfada $KEY şeklinde veriye erişebilir. Her config/routes.php içerisinde tanımlanan post için ilgili app/controller/*.php dosyası içerisinde fonksiyon tanımlamak zorunludur.

Functions

render, redirect_to

Options

helpers, before_actions, after_actions

`render`

options : layout, view, action, template, file, text, partial, locals

class HomeController extends ApplicationController {

  public function index() {
    echo "HomeIndex sayfası öncesi çalışan fonksiyon";

    /////////////////////////////////////////////////////////////////////////////////
    // default render for this functions examples : /home/index
    /////////////////////////////////////////////////////////////////////////////////

    // LAYOUT: home, VIEW: home, ACTION: index, LOCALS: null
    $this->render("/home/index");

    $this->render(["template" => "/home/index"]);
    $this->render(["template" => "/home/index", "locals" => null]);
    $this->render(["template" => "/home/index", "layout" => "home"]);
    $this->render(["template" => "/home/index", "layout" => "home", "locals" => null]);

    $this->render(["view" => "home"]);
    $this->render(["action" => "index"]);
    $this->render(["layout" => "home"]);

    $this->render(["view" => "home", "action" => "index"]);
    $this->render(["view" => "home", "action" => "index", "locals" => null]);
    $this->render(["view" => "home", "action" => "index", "layout" => "home"]);
    $this->render(["view" => "home", "action" => "index", "layout" => "home", "locals" = null]);

    /////////////////////////////////////////////////////////////////////////////////
    // no options
    /////////////////////////////////////////////////////////////////////////////////

    // DEFAULT LAYOUT: home, VIEW: home, ACTION: index, DEFAULT LOCALS: null
    $this->render("/home/index"); // like $this->render(["template" => "/home/index"]);

    // DEFAULT LAYOUT: home, VIEW: home, ACTION: show, DEFAULT LOCALS: null
    $this->render("/home/show");  // like $this->render(["template" => "/home/show"]);

    // DEFAULT LAYOUT: home, VIEW: admin, ACTION: show, DEFAULT LOCALS: null
    $this->render("/admin/show"); // like $this->render(["template" => "/admin/show"]);

    /////////////////////////////////////////////////////////////////////////////////
    // option : layout, view, action, template
    /////////////////////////////////////////////////////////////////////////////////

    // LAYOUT: false, DEFAULT VIEW: home, DEFAULT ACTION: index, DEFAULT LOCALS: null
    $this->render(["layout" => false]);

    // DEFAULT LAYOUT: false, DEFAULT VIEW: home, ACTION: index, DEFAULT LOCALS: null
    $this->render(["action" => "index"]);

    // DEFAULT LAYOUT: false, VIEW: home, DEFAULT ACTION: index, DEFAULT LOCALS: null
    $this->render(["view" => "home"]);

    // DEFAULT LAYOUT: home, VIEW: home, ACTION: index, DEFAULT LOCALS: null
    $this->render(["template" => "/home/index"]);

    // DEFAULT LAYOUT: home, VIEW: admin, ACTION: index, DEFAULT LOCALS: null
    $this->render(["view" => "admin", "action" => "index"]);

    // LAYOUT: admin, VIEW: home, ACTION: show, DEFAULT LOCALS: null
    $this->render(["layout" => "admin", "view" => "home", "action" => "show"]);

    // LAYOUT: admin, VIEW: home, ACTION: index, DEFAULT LOCALS: null
    $this->render(["layout" => "admin", "template" => "home/index"]);

    // LAYOUT: admin, VIEW: home, ACTION: show, DEFAULT LOCALS: null
    $this->render(["layout" => "admin", "template" => "home/show"]);

    /////////////////////////////////////////////////////////////////////////////////
    // option : file ( LAYOUT : pass, VIEW : pass, ACTION : pass )
    /////////////////////////////////////////////////////////////////////////////////
    // include locals and this file
    // example file path = "/app/views/home/users/show.php"

    // DEFAULT LOCALS: null
    $this->render(["file" => "/app/views/home/users/show.php"]);

    // LOCALS: ( $fist_name : "Gökhan", $last_name : "Demir" )
    $this->render(["file" => "/app/views/home/users/show.php", "locals" => ["fist_name" => "Gökhan", "last_name" => "Demir"]);

    /////////////////////////////////////////////////////////////////////////////////
    // option : partial ( LAYOUT : pass, VIEW : pass, ACTION : pass )
    /////////////////////////////////////////////////////////////////////////////////
    // include locals and this file "_show.php" on VIEW path
    // example file : /app/views/home/users/_show.php

    // DEFAULT LOCALS: null
    $this->render(["partial" => "home/users/show"]);

    // LOCALS: ( $fist_name : "Gökhan", $last_name : "Demir" )
    $this->render(["partial" => "home/users/show", "locals" => "locals" => ["fist_name" => "Gökhan", "last_name" => "Demir"]]);

    /////////////////////////////////////////////////////////////////////////////////
    // option : text ( LAYOUT : pass, VIEW : pass, ACTION : pass, LOCALS : pass )
    /////////////////////////////////////////////////////////////////////////////////
    // this option, available in Ajax functions

    $this->render(["text" => "Hello World"]);
  }

}

`redirect_to`

request url [/ or /home] redirect to /home/index

config/routes.php

ApplicationRoutes::draw(
  get("/", "home#home"), // or root("home#home"),
  get("/home", "home#home"),
  get("/home/index")
);

app/controllers/HomeController.php

class HomeController extends ApplicationController {
  public function home() {
    return $this->redirect_to("/home/index");
  }
  public function index() {}
}

app/views/home/index.php

```php

Home#Index


#### `helpers`

Helpers `app/helpers/*Helper.php` şeklinde tanımlanan her controller ya da proje için gerekli görüldüğü yerlerde çağrılması gereken sınıfları projeye dahil eder.

> keys : `$FILE`, `all`

> `$FILE`

İstenilen helper sınıflarını projeye dahil eder.

class HomeController extends ApplicationController {

protected $helpers = [“Password”];

public function index() { echo “random password : ” . PasswordHelper::generate(10); } } ```

all

app/helpers/* altındaki tüm helper sınıflarını projeye dahil eder. #TODO anahtar ismi daha özel olabilir ?

class HomeController extends ApplicationController {

  protected $helpers = ["all"];

  public function index() {
    echo "random string   : " . StringHelper::generate(10);
    echo "random password : " . PasswordHelper::generate(10);
  }
}

`before_actions`

Before Action (protected $before_actions) özelliği, app/controller/*.php dosyası içerisinde her çalışacak get/post fonksiyonları için önceden çalışacak fonksiyonları belirtmeye yarayan özelliktir. Özelliğin etkisini ayarlamak için aşağıdaki 3 şekilde kullanılabilir:

options : except, only

except anahtarı ile nerelerde çalışmayacağını
only anahtarı ile nerelerde çalışacağını
Anahtar yok ise her yerde çalışacağını

class HomeController extends ApplicationController {

  protected $before_actions = [
    ["login", "except" => ["login", "index"]],
    ["notice_clear", "only" => ["index"]],
    ["every_time"]
  ];

  public function index() {
    echo "HomeIndex : Anasayfa (bu işlem için login fonksiyonu çalışmaz, notice_clear ve every_time çalışır)";
  }

  public function login() {
    echo "Home#Login : Her işlem öncesi login oluyoruz. (get/post için /home/login, /home/index hariç)";
  }

  public function notice_clear() {
    echo "Home#NoticeClear : Duyular silindi. (get/post için sadece /home/index'de çalışır)";
  }

  public function every_time() {
    echo "Home#EveryTime : Her zaman get/post öncesi çalışırım.";
  }

`after_actions`

After Action (protected $after_actions) özelliği, app/controller/*.php dosyası içerisinde her çalışacak get/post fonksiyonları için sonradan çalışacak fonksiyonları belirtmeye yarayan özelliktir. Özelliğin etkisini ayarlamak için aşağıdaki 3 şekilde kullanılabilir:

options : except, only

except anahtarı ile nerelerde çalışmayacağını
only anahtarı ile nerelerde çalışacağını
Anahtar yok ise her yerde çalışacağını

config/routes.php

ApplicationRoutes::draw(
  get("/admin/home"),
  get("/admin/login"),
  post("/admin/login")
);

app/controllers/AdminController.php

class AdminController extends ApplicationController {

  protected $before_actions = [
  ["require_login", "except" => ["login", "logout"]]
  ];

  public function login() {

    if (isset($_SESSION["admin"]))
      return $this->redirect_to("/admin/index");

    if (isset($_POST["username"]) and isset($_POST["password"])) {

      if ($user = User::unique(["username" => $_POST["username"], "password" => md5($_POST["password"])])) {

        $_SESSION["success"] = "Admin sayfasına hoş geldiniz";
        $_SESSION["full_name"] = "$user->first_name $user->last_name";
        $_SESSION["admininfo"] = $user;
        $_SESSION["admin"] = true;

        return $this->render("/admin/index");

      } else {

        $_SESSION["danger"] = "Oops! İsminiz veya şifreniz hatalı, belki de bunlardan sadece biri hatalıdır?";

      }
    }

    return $this->render(["layout" => "default"]);
  }

  // public function index() {} // OPTIONAL

  public function logout() {
    if (isset($_SESSION["admin"]))
      session_destroy();
    return $this->redirect_to("/admin/login");
  }

  public function require_login() {
    if (!isset($_SESSION["admin"])) {
      $_SESSION["warning"] = "Lütfen hesabınıza giriş yapın!";
      return $this->redirect_to("/admin/login");
    }
  }
}

app/views/admin/login.php

```html


> `app/views/admin/home.php`

Admin#Home


> `app/views/layouts/admin.php`

<!DOCTYPE html> <?= $yield; ?> ```

Views (`app/views/DIRECTORY/*.php`)

Her get işlemi için config/routes.php de yönlendirilen controller ve action adlarını alarak, app/views/CONTROLLER/ACTION.php html sayfası app/views/layouts/CONTROLLER.php içerisine <?= $yield; ?> değişken kısmına gömülür ve görüntülenir.

app/views/DIRECTORY/*.php

```html

Hello World


> `app/views/layouts/DIRECTORY.php`

<!DOCTYPE html> <?= $yield; ?> ```

Functions

render

`render`

Fonksiyonu Controller'daki gibi tüm özellikleri ile kullanılabilir. Yalnızca *.php dosyalarının içersinde kullanılırken <?php render(); ?> şeklinde kullanılmalıdır. Daha ayrıntılı bilgi için Controller#render

Model (`app/models/TABLE.php`)

Her tablonun bir modeli olmak zorundadır.

app/models/TABLE.php example: app/models/User.php

class User extends ApplicationModel {

  public function full_name() {
    return $this->first_name . " " . $this->last_name;
  }

}

$user = User::find(1);
echo $user->full_name();

Query Kick Function (static)

load

Query Load Functions (public)

select, where, or_where, joins, order, group, limit, offset

Query Fetch Functions (public)

get, get_all, pluck, count, update_all, delete_all, first, last

Query Function Helpers (static) [alias]

all, unique, find, find_all, exists, update, delete

Model Functions

draft, create, save, destroy

CREATE

Functions

draft, create

`draft`

// Ör. 1:

$user = User::draft();
$user->first_name = "Gökhan";
$user->save();
print_r($user); // otomatik id alır

// Ör. 2:

$user = User::draft(["first_name" => "Gökhan"])->save();
print_r($user); // otomatik id alır

`create`

$user = User::create(["first_name" => "Gökhan"]);
print_r($user);

READ

Functions

load, select, where, or_where, order, group, limit, get, get_all, pluck, count, joins, find, find_all, all, first, last

`load`

// Ör. 1:

$user = User::load()->get();
// SELECT * FROM user LIMIT 1

echo $user->first_name;

// Ör. 2:

$users = User::load()->get_all();
// SELECT * FROM user

foreach ($users as $user)
  echo $user->first_name;

`where`

operators: =, !=, >, <, >=, <=

$users = User::load()->where("first_name", "Gökhan")->get_all();
$users = User::load()->where("first_name", "Gökhan", "=")->get_all();
// SELECT * FROM user WHERE first_name = 'Gökhan';

$users = User::load()->where("age", 25, "<>")->get_all();
// SELECT * FROM user WHERE age <> 25;

$users = User::load()->where("age", 25, ">")->get_all();
// SELECT * FROM user WHERE age > 25;

$users = User::load()->where("age", 25, "<")->get_all();
// SELECT * FROM user WHERE age < 25;

$users = User::load()->where("age", 25, ">=")->get_all();
// SELECT * FROM user WHERE age >= 25;

$users = User::load()->where("age", 25, "<=")->get_all();
// SELECT * FROM user WHERE age <= 25;

operators: IS NULL, IS NOT NULL

$users = User::load()->where("email", NULL)->get_all();
$users = User::load()->where("email", "IS NULL")->get_all();
// SELECT * FROM user WHERE email IS NULL;
$users = User::load()->where("email", "IS NOT NULL")->get_all();
// SELECT * FROM user WHERE email IS NOT NULL;

operators: LIKE, NOT LIKE

$users = User::load()->where("email", "%.com.tr", "LIKE")->get_all();
// SELECT * FROM user WHERE email LIKE '%.com.tr';
$users = User::load()->where("email", "%.com.tr", "NOT LIKE")->get_all();
// SELECT * FROM user WHERE email NOT LIKE '%.com.tr';

operators: IN, NOT IN

$users = User::load()->where("id", [1, 2, 3], "IN")->get_all();
// SELECT * FROM user WHERE id IN (1, 2, 3);
$users = User::load()->where("id", [1, 2, 3], "NOT IN")->get_all();
// SELECT * FROM user WHERE id NOT IN (1, 2, 3)

operators: BETWEEN, NOT BETWEEN

$users = User::load()->where("created_at", ["2016-12-01", "2016-13-01"], "BETWEEN")->get_all();
// SELECT * FROM user WHERE created_at BETWEEN "2016-12-01" AND "2016-13-01";
$users = User::load()->where("created_at", ["2016-12-01", "2016-13-01"], "NOT BETWEEN")->get_all();
// SELECT * FROM user WHERE created_at NOT BETWEEN "2016-12-01" AND "2016-13-01";

`or_where`

only logic key: OR

// where($field, $value, $mark, "OR")
$users = User::load()->where("first_name", "Gökhan")->or_where("last_name", "Demir")->get_all();
$users = User::load()->where("first_name", "Gökhan", "=", "AND")->where("last_name", "Demir", "=", "OR")->get_all();
// SELECT * FROM user WHERE first_name = 'Gökhan' OR last_name = 'Demir';

`select`, `where`, `order`, `group`, `limit`, `get`, `get_all`

$users = User::load()
           ->where("first_name", "Gökhan")
           ->select("first_name")
           ->order("id")
           ->limit(10)
           ->get_all();

foreach ($users as $user)
  echo $user->first_name;

`pluck`

// Ör. 1:

$user_ids = User::load()->pluck("id");
print_r($user_ids);
// [1, 2, 3, 4, 66, 677, 678]

// Ör. 2:

$user_firstnames = User::load()->pluck("first_name");
print_r($user_firstnames);
// ["Gökhan", "Göktuğ", "Gökçe", "Gökay", "Atilla", "Altay", "Tarkan", "Başbuğ", "Ülkü"]

`count`

// Ör. 1:

echo User::load()->count();
// 12

// Ör. 2:

echo User::load()->where("first_name", "Gökhan")->count();
// 5

`joins`

// Ör. 1:

// Category ["id", "name"]
// Article ["id", "category_id"]
// Like ["id", "article_id"]
// Comment ["id", "article_id"]
// Tag ["id", "comment_id"]

$categories = Category::load()->joins("article")->get_all();
$categories = Category::load()->joins(["article"])->get_all();
$categories = Category::load()->joins(["article" => "comment"])->get_all();
$categories = Category::load()->joins(["article" => ["comment" => ["tag"]]])->get_all();
$categories = Category::load()->joins(["article" => ["comment" => ["tag"], "like"]])->get_all();
$categories = Category::load()->joins(["article" => ["comment" => ["tag"], "like"], "document"])->get_all();
$categories = Category::load()->joins(["article", "document"])->get_all();

// Ör. 2:

// Department ["id", "name"]
// User ["id", "department_id", "first_name"]
// Address ["id", "user_id", "content"]

$department = Department::load()
                ->joins(["user", "address"])
                ->where("User.id", 1)
                ->select("User.first_name, Department.name, Address.content")
                ->limit(1)
                ->get_all();
print_r($department);

`unique`

$user = User::unique(["username" => "gdemir", "password" => "123456"]);
echo $user->first_name;

`find`

$user = User::find(1);
echo $user->first_name;

`find_all`

$users = User::find_all([1, 2, 3]);
foreach ($users as $user)
  echo $user->first_name;

`all`

$users = User::all();
foreach ($users as $user)
  echo $user->first_name;

`first`

// Ör. 1:

$user = User::first();
echo $user->first_name;

// Ör. 2:

$users = User::first(10);
foreach ($users as $user)
  echo $user->first_name;

`last`

// Ör. 1:

$user = User::last();
  echo $user->first_name;

// Ör. 2:

$users = User::last(10);
foreach ($users as $user)
  echo $user->first_name;

`exists`

echo User::exists(1) ? "kayit var" : "kayit yok";

UPDATE

Functions

save, update

`save`

// Ör. 1:

$user = User::unique(["username" => "gdemir", "password" => "123456"]);
$user = User::find(1);
$user = User::load()->get();
$user = User::first();
$user = User::last();
$user->first_name = "Gökhan";
$user->save()
print_r($user);

// Ör. 2:

$users = User::find_all([1, 2, 3]);
$users = User::load()->get_all();
$users = User::all();
$users = User::load()
           ->where("first_name", "Gökhan")
           ->select("first_name")
           ->order("id")
           ->limit(10)
           ->get_all();
$users = User::first(10);
foreach ($users as $user) {
  $user->first_name = "Göktuğ";
  $user->save();
}

`update`

// Ör. 1:

User::update(1, ["first_name" => "Gökhan", "last_name" => "Demir"]);

// Ör. 2:

$users = User::find_all([1, 2, 3]);
$users = User::load()->get_all();
$users = User::all();
$users = User::load()
           ->where("first_name", "Gökhan")
           ->select("first_name")
           ->order("id")
           ->limit(10)
           ->get_all();
foreach ($users as $user)
  User::update($user->id, ["first_name" => "Göktuğ", "last_name" => "Demir"]);

DELETE

Functions

destroy, delete, delete_all

`destroy`

$user = User::unique(["username" => "gdemir", "password" => "123456"]);
$user = User::find(1);
$user = User::load()->get();
$user = User::first();
$user = User::last();
$user->destroy();

`delete`

User::delete(1);

`delete_all`

User::load()->delete_all();
User::load()->where("first_name", "Gökhan")->delete_all();
User::load()->where("first_name", "Gökhan")->limit(10)->delete_all();
User::load()->limit(10)->delete_all();

DEPENDENCİES

$BELONG_TABLE->OWNER_TABLE

// Department ["id", "name"]
// User ["id", "department_id", "first_name", "last_name"]
// Book ["id", "user_id", "name"]

// Department
// [1, "Bilgisayar Mühendisliği"]
// [2, "Makine Mühendisliği"]

// User
// [1, 1, "Gökhan", "Demir"]
// [2, 1, "Göktuğ", "Demir"]
// [3, 2, "Göksen", "Demir"]

// Book
// [1, 1, "Barak Türkmenlerinin Tarihi"]
// [2, 1, "Oğuz Boyu"]
// [3, 3, "Almila"]

$book = Book::find(1);
// [1, 1, "Barak Türkmenlerinin Tarihi"]

print_r($book->user);
// [1, 1, "Gökhan", "Demir"]

print_r($book->user->department);
// [1, "Bilgisayar Mühendisliği"]

echo "$book->user->department->name $book->user->first_name  $book->name";
// "Bilgisayar Mühendisliği Gökhan Barak Türkmenlerinin Tarihi"

$OWNER_TABLE->all_of_BELONG_TABLE

// User ["id", "department_id", "first_name", "last_name"]
// Book ["id", "user_id", "name"]

// User
// [1, 1, "Gökhan", "Demir"]
// [2, 1, "Göktuğ", "Demir"]
// [3, 2, "Göksen", "Demir"]

// Book
// [1, 1, "Barak Türkmenlerinin Tarihi"]
// [2, 1, "Oğuz Boyu"]
// [3, 2, "Kımız"]
// [4, 3, "Almila"]

$user = User::find(1);
$books = $user->all_of_book;
foreach ($books as $book)
  echo $book->name;

Mailer (`app/mailers/*.php`)

Mailer sınıf olarak PHPMaileri kullanmaktadır ve yapı olarak Controllerin bir benzeri görev yapmaktadır. helper, before_actions, after_actions gibi ayarlamaları kullanabilme imkanı vermektedir. Her hazırlanan Mailer sınıfı içerisindeki fonksiyonda mail fonksyionu ve alıcı tanımlanmak zorundadır. Layout olarak zorunlu olarak app/views/layouts/mailer.php dosyasını kullanmaktadır. View olarak ise istenilen actiona göre app/views/mail/ACTION.php dosyası tanımlanması gerekir, buradaki app/views/mail dizinini kullanmak zorunludur.

Mailer Kick Functions

delivery

Functions

mail

Options

helpers, before_actions, after_actions

`delivery` ($action, [$param1, $param2, …])

parametre olarak kullanılacak Mailer içersindeki method ismi yazılır.
parametre eğer method bir veri alacak şekilde tanımlandıysa bu veriler liste içersinde gönderilir.

app/controllers/HomeController.php

class HomeController extends ApplicationController {
  public function index() {
    PasswordMailer::delivery("reset");
    PasswordMailer::delivery("reset2", ["m930fj039fj039j", "gdemir.me", "mail@gdemir.me", "Gökhan Demir"]);
  }
}

app/mailers/PasswordMailer.php

class PasswordMailer extends ApplicationMailer {

  protected $after_actions = [["info"]];

  public function info() {
    if (isset($this->email) && isset($this->fullname)) {
      $this->mail([
        "to" => [[$this->email => $this->fullname]],
        "subject" => "Güçlü Şifre İçin Öneriler"
      ]);
    }
  }

  public function reset() {
    $this->code = "ab234c2589de345fgAASD6";
    $this->site_url = "gdemir.me";
    $this->mail([
      "to" => [["mail@gdemir.me" => "Gökhan Demir"]],
      "subject" => "[Admin] Please reset your password"
      ]);
  }

  public function reset2($random_code, $site_url, $email, $fullname) {
    $this->code = $random_code;
    $this->site_url = $site_url;
    $this->mail([
      "to" => [[$email => $fullname]],
      "subject" => "[Admin] Please reset your password"
      ]);
  }
}

`mail`

options : to, subject

app/controllers/HomeController.php

class HomeController extends ApplicationController {
  public function index() {
    PasswordMailer::delivery("reset");
    PasswordMailer::delivery("reset2", ["m930fj039fj039j", "gdemir.me"]);
  }
}

app/mailers/UserMailer.php

class UserMailer extends ApplicationMailer {

  protected $after_actions = [["info"]];

  protected $before_actions = [["notice"]];

  public function notice() {
    $this->mail([
      "to" => [["gdemir@bil.omu.edu.tr" => "Gökhan Demir"]],
      "subject" => "1 Kullanıcı Şifre Sıfırlama Talebinde Bulundu"
      ]);
  }

  public function info() {
    if (isset($this->email) && isset($this->fullname)) {
      $this->mail([
        "to" => [[$this->email => $this->fullname]],
        "subject" => "Güçlü Şifre İçin Öneriler"
      ]);
    }
  }

  public function reset() {
    $this->code = "ab234c2589de345fgAASD6";
    $this->site_url = "gdemir.me";
    $this->mail([
      "to" => [["mail@gdemir.me" => "Gökhan Demir"]],
      "subject" => "[Admin] Please reset your password"
      ]);
  }

  public function reset2($random_code, $site_url, $email, $fullname) {
    $this->code = $random_code;
    $this->site_url = $site_url;
    $this->email = $email;
    $this->fullname = $fullname;
    $this->mail([
      "to" => [[$this->email => $this->fullname]],
      "subject" => "[Admin] Please reset your password"
      ]);
  }
}

// default layout TODO change?

app/views/layouts/mailer.php

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="tr" lang="tr">
<head>
  <meta http-equiv="content-type" content="text/html; charset=utf-8" />
  <meta http-equiv="X-UA-Compatible" content="IE=edge" />
  <meta name="viewport" content="width=device-width, initial-scale=1" />
  <title></title>
  <link href="" rel="alternate" title="" type="application/atom+xml" />
  <link rel="shortcut icon" href="/favicon.ico">
  <link rel="stylesheet" href="/app/assets/css/syntax.css" type="text/css" />
  <link href='http://fonts.googleapis.com/css?family=Monda' rel='stylesheet' type='text/css'>

  <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
  <!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
  <!--[if lt IE 9]>
  <script src="/app/assets/js/html5shiv.min.js"></script>
  <script src="/app/assets/js/respond.min.js"></script>
  <![endif]-->

  <script src="http://code.jquery.com/jquery.js"></script>
  <script src="/app/assets/js/bootstrap.min.js"></script>
</head>
<body>
  <div class="container" style="width:365px; min-height:200px; margin-top: 8%;">
    <?= $yield; ?>
  </div>
</body>
</html>

app/views/mail/password/reset.php

Sistem şifrenizi kaybettiğinizi duyduk. Üzgünüm!<br/><br/>
Endişelenme! Parolanızı sıfırlamak için 1 saat içinde aşağıdaki bağlantıyı kullanabilirsiniz:<br/><br/>
<a href='http://$_site_url/admin/password_reset/$code'>http://$_site_url/admin/password_reset/$code</a>

app/views/mail/password/reset2.php

Sistem şifrenizi kaybettiğinizi duyduk. Üzgünüm!<br/><br/>
Endişelenme! Parolanızı sıfırlamak için 1 saat içinde aşağıdaki bağlantıyı kullanabilirsiniz:<br/><br/>
<a href='http://$_site_url/admin/password_reset/$code'>http://$_site_url/admin/password_reset/$code</a>

app/views/mail/password/info.php

<code>UYARI</code>:
<i class="text-info">
  <ul class="col-sm-offset-1">
    <li>Şifreniz en az 8 karakterden oluşmalıdır</li>
    <li>Büyük, küçük harfler ve rakamların her biri en az 1 defa kullanılmalıdır</li>
    <li>"?, @, !, #, %, +, -, *, %" gibi özel karakterler en az 1 defa kullanılmalıdır</li>
  </ul>
</i>

app/views/mail/password/notice.php

```html BILDIRIM:

Web sayfasında 1 kişi şifre değişikliği talebinde bulundu.
Tarih : <?= date(“Y-m-d H:i:s”); ?> ```

Configurations (`config/*`)

config/application.ini (application configuration file)

[application_configuration]
debug           = true
timezone        = Europe/Istanbul
locale          = tr
logsize         = 5242880
cacheexpiration = 604800

config/database.ini (database configuration file)

[database_configuration]
host  = localhost
user  = root
pass  = barak
name  = BARAK

config/mailer.ini (mailer configuration file)

Default SMTP Configuration (Test Edildi)

[mailer_configuration]
port     = 25
address  = mail.gdemir.me
username = mail@gdemir.me
password = 123456

Yandex SMTP Configuration (Test Edildi)

port     = 587
address  = smtp.yandex.com
username = mail@gdemir.me
password = 123456

Gmail SMTP Configuration (Test Edilmedi)

port     = 465
address  = smtp.gmail.com
username = mail@gdemir.me
password = 123456

config/locales/LANGUAGE.php (language configuration file)

Varsayılan dosyası config/locales/tr.php dosyasıdır, yeni bir dil eklenecekse aynı list kullanılıp değer kısımları değiştirilerek kaydedilmelidir. Bu çeviri dosyalarının yönetimi erişimi ve yönetimi için I18n kısmında anlatılmaktadır.

config/locales/tr.php

<?php
return [

"home" => [
  "link" => "Anasayfa",
  "about_us" => "Hakkımızda"
  ]

];
?>

config/locales/en.php

<?php
return [

"home" => [
  "link" => "Homepage",
  "about_us" => "About Us"
  ]

];
?>

Seeds (`db/seeds.php`)

Proje başlamadan önce ilk çalıştırılacak dosyadır.

db/seeds.php (database seeds file)

if (User::load()->count() == 0) {
  User::create(["first_name" => "Gökhan", "last_name" => "Demir", "username" => "gdemir",  "password" => "123456"]);
  User::create(["first_name" => "Gökçe",  "last_name" => "Demir", "username" => "gcdemir", "password" => "123456"]);
  User::create(["first_name" => "Göktuğ", "last_name" => "Demir", "username" => "gtdemir", "password" => "123456"]);
  User::create(["first_name" => "Atilla", "last_name" => "Demir", "username" => "ademir",  "password" => "123456"]);
}

I18n (`config/locales/LOCALE.php`)

Functions

locale, get_locale, translate

`locale`

Çeviri kelimeleri (config/locales/tr.php veya config/locales/en.php gibi dosyalar dizi olarak $SESSION[“i18n”] üzerine yüklenir.) proje başlangıcında config/application.ini dosyası içersinde locale değişkenine ile atanabilir veya projenin herhangi bir aşamasında aşağıdaki gibi atanabilir/değiştirilebilir. Varsayılan olarak config/locales/tr.php dosyası okunur.

ApplicationI18n::locale("tr");

`get_locale`

O an seçili olan dilin hangisi olduğunu anlamak için bu fonksiyon kullanılır.

// Ör. 1:

ApplicationI18n::get_locale();
// tr

// Ör. 2:

ApplicationI18n::get_locale();
// en

`translate`

Çevirisi yapılacak bir kelime dizini o an hangi dil yüklü ise ona göre çeviri yapmak için aşağıdaki gibi kullanılır.

ApplicationI18n::translate("home.about_us");

bu fonksiyonu daha kolay kullanmak için alias olarak tanımlı t fonksiyonu ile erişilebilir.

t("home.about_us");

Debug

Exception, Error, Shutdown(Fatal Error) akışlarını yakalayıp tek sayfada göstermeye yararayan sınıftır. Eğer hataların gösterilmesi istenmiyorsa config/application.ini dosyası içerisinde debug = false denilerek kullanıcı bazlı public/500.html sayfası gösterilir, ancak log kaydı her şekilde de tutulur.

Functions

exception, error, shutdown

`exception`

throw new Exception("OMG!");

veya

ApplicationDebug::exception(new Exception("OMG!"));

tarzındaki fonksiyonlar ile hataları bulunduğu sayfada yakalar ve istisnanın bulunduğu kod satırınının bir kısmını gösterir.

`error`

ApplicationDebug::error(123123, "Undefined variable: a", "/var/www/html/app/controllers/DefaultController.php", 10);

veya

echo $a;

gibi ifadelerle bir tanımlanmayan değişkenin kullanma hatasını adım adım framework'de hangi dosyalardan hangi satıra kadar olduğunun gösterilmesini sağlar.

`shutdown`

ApplicationDebug::shutdown()

veya

ölümcül başka türlü hatalarda (sistemin çalışmadığı durumlarda) sistemin ölümcül hata verdiği kısmı adım adım framework'de hangi dosyalardan hangi satıra kadar olduğunun gösterilmesini sağlar.

Logger (`tmp/log/*`)

Günlük olarak dosyalar açarak verilen mesajları loglamaya yarayan sınıftır. Log dosyaları varsayılan olarak 5242880 byte (5MB) ile sınırlıdır.

Functions

size, info, warning, error, fatal, debug

`size`

Lop dosyasının maximum boyutunun ayarlanması

ApplicationLogger::size(5000);

`info`, `warning`, `error`, `fatal`, `debug`

ApplicationLogger::info("bilmek iyidir");
ApplicationLogger::warning("olabilir?");
ApplicationLogger::error("dikkat et");
ApplicationLogger::fatal("cevap vermiyor");
ApplicationLogger::debug("olaylar olaylar");

// log/2017-06-18.txt
// 2017-06-18 09:45:36 → info : bilmek iyidir
// 2017-06-18 09:45:36 → warning : olabilir?
// 2017-06-18 09:45:36 → error : dikkat et
// 2017-06-18 09:45:36 → fatal : cevap vermiyor
// 2017-06-18 09:45:36 → debug : olaylar olaylar

Cache (`tmp/cache/*`)

Verilen anahtarlara göre request_url + key (istek url ve verilen anahtar)‘e göre md5 ile şifreleyip tmp/cache/* dizini üzerinde yazma, okuma, silme, var olduğunu bakma, tamamen silme gibi işlemleri yapan sınıftır. Veriler varsayılan olarak 604800 milisaniye (10 dakika) süre ile saklanır.

Functions

expiration, write, read, delete, exist, reset

`expiration`

Saklanacak verilerin genel olarak ne kadar süre ile tutulacağının ayarlanması

ApplicationLogger::expiration(604800);

`write`

Saklanacak verilerin request_url + key (istek url ve verilen anahtar)‘e göre md5 ile şifreleyip belleğe yazar. Bu şekilde farklı bir sayfada kaydettiğiniz aynı anahtar isimli veriler, farklı dosyalar olarak kaydedilmektedir.

$users = User::all();
ApplicationCache::write("users", $users);

`read`

Bellekteki veriyi request_url + key mantığı ile okur, eğer dosyanın süresi geçmişse otomatik olarak siler.

$users = ApplicationCache::read("users");

`delete`

request_url + key mantığına göre bulunan ve var olan dosya süresine bakılmaksızın silinir.

ApplicationCache::delete("users");

`exists`

request_url + key mantığına göre var olmasına bakar.

echo (ApplicationCache::exists("users")) ? "bellekte var" : "bellekte yok";

`reset`

tmp/cache/* altındaki tüm saklanan verileri sürelerine bakılmaksızın siler.

ApplicationCache::reset();

Trailer

Sources

https://tr.wikipedia.org/wiki/Barak_T%C3%BCrkmenleri

License

Barak is released under the MIT License.

Aksi belirtilmedikçe Gökhan Demir tarafından tüm içerik hakları saklıdır. Powered by Jekyll, Bootstrap, Awesome, Datatables, Highlightjs, Animatecss

Barak Framework

2018-01-03 framework barak framework mvc php Yorumlar

Barak Framework

Requirements

Install

Run

Releases

Guides

Simple Usage

Home#Index

Router (config/routes.php)

get

Home#Index

post

Admin#Index

resource

resources

scope

root

Controllers (app/controllers/*.php)

render

redirect_to

Home#Index

before_actions

after_actions

Admin#Home

Views (app/views/DIRECTORY/*.php)

Hello World

render

Model (app/models/TABLE.php)

CREATE

draft

create

READ

load

where

or_where

select, where, order, group, limit, get, get_all

pluck

count

joins

unique

find

find_all

all

first

last

exists

UPDATE

save

update

DELETE

destroy

delete

delete_all

DEPENDENCİES

Mailer (app/mailers/*.php)

delivery ($action, [$param1, $param2, …])

mail

Configurations (config/*)

Seeds (db/seeds.php)

I18n (config/locales/LOCALE.php)

locale

get_locale

translate

Debug

exception

error

shutdown

Logger (tmp/log/*)

size

info, warning, error, fatal, debug

Cache (tmp/cache/*)

expiration

write

read

delete

exists

reset

Trailer

Router (`config/routes.php`)

`get`

`post`

`resource`

`resources`

`scope`

`root`

Controllers (`app/controllers/*.php`)

`render`

`redirect_to`

`before_actions`

`after_actions`

Views (`app/views/DIRECTORY/*.php`)

`render`

Model (`app/models/TABLE.php`)

`draft`

`create`

`load`

`where`

`or_where`

`select`, `where`, `order`, `group`, `limit`, `get`, `get_all`

`pluck`

`count`

`joins`

`unique`

`find`

`find_all`

`all`

`first`

`last`

`exists`

`save`

`update`

`destroy`

`delete`

`delete_all`

Mailer (`app/mailers/*.php`)

`delivery` ($action, [$param1, $param2, …])

`mail`

Configurations (`config/*`)

Seeds (`db/seeds.php`)

I18n (`config/locales/LOCALE.php`)

`locale`

`get_locale`

`translate`

`exception`

`error`

`shutdown`

Logger (`tmp/log/*`)

`size`

`info`, `warning`, `error`, `fatal`, `debug`

Cache (`tmp/cache/*`)

`expiration`

`write`

`read`

`delete`

`exists`

`reset`