Controllers



Controllers are the bread and butter of the framework they control when a model is used and equally when to include a view for output. A controller is a class with methods, these methods are the outputted pages when used in conjunction with routes.

A method can be used for telling a view to show a page or outputting a data stream such as XML or a JSON array. Put simply they are the logic behind your application.

Controllers can be placed in subfolders relative to the root of the Controllers folder, each class located in subfolders must have its own namespace, for instance a subfolder called Admin and a class called Users should have a namespace of App\Controllers\Admin

Controllers are created inside the app/Controllers folder. To create a controller, create a new file, the convention is to StudlyCaps without any special characters or spaces. Each word of the filename should start with a capital letter. For instance: AddOns.php.

Controllers will always use a namespace of App\Controllers, if the file is directly located inside the controllers folder. If the file is in another folder that folder name should be part of the name space.

For instance, a controller called Blog located in app/Controllers/Blog would have a namespace of App\Controllers\Blog

Controllers should extends from the base controller located in app/Core/Controller.php the syntax is:

namespace App\Controllers;

use App\Core\Controller;

class Welcome extends Controller
{

}

Also, the view class is needed to include view files, you can either call the namespace then the view:

Create an alias:

use View;

Then to use:

return View::make('path)->shares('title', 'Welcome');

Example


namespace App\Controllers;

use App\Core\Controller;
use View;

class Welcome extends Controller
{
    public function index()
    {
        return View::make('Welcome/Welcome')->shares('title', 'Welcome');
    }
}

Both models and helpers can be used in a constructor and added to a property then becoming available to all methods. The model or helper will need to use its namespace while being called

namespace App\Controllers;

use App\Core\Controller;
use App\Models\Blog as BlogModel;

use View;

class Blog extends Controller
{
    private $blog;

    public function __construct()
    {
        parent::__construct();
        $this->blog = new BlogModel();
    }

    public function blog()
    {
        $posts = $this->blog->getPosts();
        View::make('Blog/Posts')->shares('title', 'Blog')->with('posts', $posts);
    }
}

An alternative way to load a view is to call $this->getView() this acts in the same way as View::make() only without the passed params, the path is worked out internally.

To use getView the view path should follow the controller and method name ie:

class Users extends Controller
{
    public function index()
    {
      return $this->getView()->shares('title', 'The Title');
    }
}

Will match to app/Views/Users/Index.php

Methods

A controller can have many methods, a method can call another method, all standard OOP behaviour is honoured. Data can be passed from a controller to a view by passing an array to the view. The array can be made up from keys. Each key can hold a single value or another array. The array must be passed to the method for it to be used inside the view page or in a template (covered in the templates section)

$content = 'The contact for the page';
$users = array('Dave', 'Kerry', 'John');

return $this->getView()->with('content', $content)->with('users', $users);