Template for initializing the PHP MVC Project application using Bootstrap v4.

Author: meet-aleksey

.gitignore

@@ -0,0 +1,3 @@
+/vendor
+/*.lock
+/cache

.htaccess

@@ -0,0 +1,12 @@
+<IfModule mod_rewrite.c>
+  RewriteEngine On
+
+  # redirect /index.php to /
+  RewriteCond %{THE_REQUEST} ^[A-Z]{3,9}\ /.*index\.php
+  RewriteRule ^index.php/?(.*)$ $1 [R=301,L]
+
+  # process all requests through index.php, except for actually existing files
+  RewriteCond %{REQUEST_FILENAME} !-d
+  RewriteCond %{REQUEST_FILENAME} !-f
+  RewriteRule ^(.*)$ index.php/$1?%{QUERY_STRING} [QSA,L]
+</IfModule>

.vscode/launch.json

@@ -0,0 +1,21 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Listen for XDebug",
+            "type": "php",
+            "request": "launch",
+            "port": 9000,
+            "log": true,
+            "cwd": "${workspaceRoot}"
+        },
+        {
+            "name": "Launch currently open script",
+            "type": "php",
+            "request": "launch",
+            "program": "${file}",
+            "cwd": "${fileDirname}",
+            "port": 9000
+        }
+    ]
+}

.vscode/tasks.json

@@ -0,0 +1,12 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "label": "PHP Server",
+            "type": "shell",
+            "command": "php -S localhost:8000"
+        }
+    ]
+}

README.md

@@ -0,0 +1,28 @@
+# Bootstrap 4 Template
+
+Template for initializing the PHP MVC Project application using Bootstrap v4.
+
+The template includes a standard directory structure MVC, contains a samples of controllers and view files, and includes layout Bootstrap based.
+
+Also, the template will include a filter for error handling.
+
+[Demo](http://template-bootstrap4.rf.gd/)
+
+## Installation
+
+```
+git clone https://github.com/php-mvc-project/template-bootstrap4.git my-app
+cd my-app
+composer install
+```
+
+## Requirements
+
+* PHP 7.x
+* Composer
+
+## License
+
+The MIT License (MIT)
+
+Copyright © 2018, [@meet-aleksey](https://github.com/meet-aleksey)

composer.json

@@ -0,0 +1,18 @@
+{
+    "name": "php-mvc-project/template-bootstrap4",
+    "description": "Template for initializing the PHP MVC Project application using Bootstrap v4.",
+    "keywords": ["php mvc project", "templates", "template", "mvc"],
+    "license": "MIT",
+    "type": "project",
+    "authors": [
+        {
+            "name": "Meet Aleksey",
+            "homepage": "https://github.com/meet-aleksey"
+        }
+    ],
+    "require": {
+        "php-mvc-project/php-mvc": "^1.1.1",
+        "components/jquery": "3.3.1",
+        "twbs/bootstrap": "4.1.1"
+    }
+}

content/README.md

@@ -0,0 +1 @@
+Use this folder for static files.

content/images/php-mvc-logo.png

@@ -0,0 +1,7 @@
+header {
+  margin-bottom: 24px;
+}
+
+.set-colon-to-labels label::after {
+  content: ':';
+}

content/styles/app.css

@@ -0,0 +1,77 @@
+<?php
+// this controller shows an example of using models
+
+// make sure you add the Controllers child name to the root namespace of your application
+namespace RootNamespaceOfYourApp\Controllers;
+
+// import the base class of the controller
+use PhpMvc\Controller;
+// import class for model annotation
+use PhpMvc\Model;
+
+// expand your class with the base controller class
+class AccountController extends Controller {
+
+    // create here action methods for the views of this controller
+    // the action methods must have a modifier public
+
+    public function __construct() {
+        // set model type for actions
+        Model::use(array('index', 'login'), 'Login');
+
+        // required fields
+        Model::required('Login', 'username');
+        Model::required('Login', 'password');
+
+        // display name (for <label />) and text
+        Model::display('Login', 'username', 'Username or Email', 'Enter any username.');
+        Model::display('Login', 'password', 'Password', 'Enter 123.');
+
+        // custom validation
+        Model::validation('Login', 'password', function($value, &$errorMessage) {
+            if ($value != '123') {
+                $errorMessage = 'Expected value is 123';
+                return false;
+            }
+            
+            return true;
+        });
+    }
+
+    // default action
+    // url: /account or /account/index
+    public function index() {
+        if (isset($this->getSession()['user'])) {
+            // is user, redirect to home
+            return $this->redirectToAction('index', 'home');
+        }
+
+        return $this->view();
+    }
+
+    // login action, only for POST requests
+    // because the $model is required and object
+    // url: /account/login
+    public function login(\RootNamespaceOfYourApp\Models\Login $model) {
+        if (!$this->getModelState()->isValid()) {
+            // model is not valid, return login form
+            return $this->view('index', $model);
+        }
+
+        // model is valid, create session
+        $session = $this->getSession();
+
+        $session['user'] = $model->username;
+
+        // redirect to home
+        return $this->redirectToAction('index', 'home');
+    }
+
+    // logout action
+    // url: /account/logout
+    public function logout() {
+        $this->getSession()->clear();
+        return $this->redirectToAction('index', 'home');
+    }
+
+}

controllers/AccountController.php

@@ -0,0 +1,48 @@
+<?php
+// make sure you add the Controllers child name to the root namespace of your application
+namespace RootNamespaceOfYourApp\Controllers;
+
+// import the base class of the controller
+use PhpMvc\Controller;
+
+// expand your class with the base controller class
+class HomeController extends Controller {
+
+    // create here action methods for the views of this controller
+    // the action methods must have a modifier public
+
+    public function index() {
+        return $this->view();
+    }
+
+    public function about() {
+        return $this->view();
+    }
+
+    public function contact() {
+        return $this->view();
+    }
+
+    // methods of action can return not only views, but also any other data
+    // use the addresses below to look at the result of the following action:
+    // /home/example/content
+    // /home/example/json
+    // /home/example/file
+    // /home/example/view
+    public function example($id = null) {
+        switch ($id) {
+            case 'content':
+                return $this->content('Text plain');
+
+            case 'json':
+                return $this->json(array('message' => 'This is the JSON data. You can use an array or pass an instance of the object.'));
+
+            case 'file':
+            return $this->file('~/content/images/php-mvc-logo.png');
+
+            default:
+                return $this->view('index');
+        }
+    }
+
+}

controllers/HomeController.php

@@ -0,0 +1,32 @@
+Create a controllers classes in this folder.
+
+Remember that the controller name must end with the **Controller** suffix.
+
+The controllers classes must be part of the `Controllers` namespace of the root namespace of your application.
+
+The controllers classes must be inherited from the `PhpMvc\Controller` class.
+
+For example:
+
+```php
+<?php
+// make sure you add the Controllers child name to the root namespace of your application
+namespace RootNamespaceOfYourApp\Controllers;
+
+// import the base class of the controller
+use PhpMvc\Controller;
+
+// expand your class with the base controller class
+class HomeController extends Controller {
+
+    public function index() {
+        // use the content function to return text content:
+        return $this->content('Hello, world!');
+
+        // create to the ./view/home/index.php
+        // and use view function to return this view:
+        // return $this->view();
+    }
+
+}
+```

controllers/README.md

@@ -0,0 +1,20 @@
+<?php
+namespace RootNamespaceOfYourApp\Filters;
+
+use PhpMvc\ActionFilter;
+use PhpMvc\ViewResult;
+
+class HandleError extends ActionFilter {
+
+    /**
+     * Called when an exception occurs.
+     * 
+     * @param ExceptionContext $exceptionContext The context of action exception.
+     * 
+     * @return void
+     */
+    public function exception($exceptionContext) {
+        $exceptionContext->setResult(new ViewResult('error'));
+    }
+
+}

filters/HandleError.php

@@ -0,0 +1,25 @@
+Create a fliters classes in this folder.
+
+The filters must be part of the `Filters` namespace of the root namespace of your application.
+
+The filters must be inherited from the `PhpMvc\ActionFilter` class.
+
+For example:
+
+```php
+<?php
+// make sure you add the Filters child name to the root namespace of your application
+namespace RootNamespaceOfYourApp\Filters;
+
+// import the base class of the action filter
+use PhpMvc\ActionFilter;
+
+class TestFilter extends ActionFilter {
+
+  // action executed handler
+  public function actionExecuted($actionExecutedContext) {
+    $actionExecutedContext->setResult(new PhpMvc\ContentResult('executed'));
+  }
+
+}
+```