README

What's this repository?

Knob-base: project base to use Knob MVC PHP Framework
This is a PHP MVC Framework to create WordPress templates easier and funnier than ever before.
Author: José María Valera Reales

Knob-base is the kernel from Knob-mvc

This is a Framework based on MVC pattern.
Knob-base should not be focus on any style of the page, but deal with WP and provide models instead.
Inspired by latest frameworks we have nowadays for web development such Symfony or Laravel.
Regarding any question about WP kernel: take a look the official WP documentation: WP Codex and WP Reference.

Creating basic controllers and views

HomeController: Controller for all files from WP:
- author.php ->getAuthor(): render the base/author.mustache template
- archive.php ->getArchive(): render the base/search.mustache template
- category.php ->getCategory(): render the base/search.mustache template
- home.php ->getHome(): render the base/home.mustache template
- search.php ->getSearch(): render the base/search.mustache template
- single.php ->getSingle($type = 'post'): render the base/[post|page].mustache template
- tag.php ->getTag(): render the base/search.mustache template
- 404.php ->get404(): render the base/error_404.mustache template

Calling a controller from a WordPress template page.

Create a template for WordPress, for example single.php which is used when a Post is loaded., _(*1)

use Controllers\HomeController;

$controller = new HomeController();
$controller->getSingle('post');

Models to get all values from your DB

You can find all models as Entities from your DB in 'Knob\Models' (src/models/ directory). For example Post:

// vendor/chemaclass/knob-base/src/models/Post.php
namespace Knob\Models;

class Post extends ModelBase
{
    public static $table = "posts";

    public function getSlug()
    {
        return $this->post_name;
    }

    public function getAuthor()
    {
        return User::find($this->post_author);
    }

    // more sentences...
}

You will be provided with libraries to prepare your Actions and Filters (from WordPress). For example Actions:

// vendor/chemaclass/knob-base/src/libs/Actions.php
namespace Knob\Libs;

class Actions
{
    public static function setup()
    {
        static::adminPrintScripts();
        static::adminPrintStyles();
        static::loginView();
        static::wpBeforeAdminBarRender();
    }

    // rest of the implementation...
}

Also you will be able to create your own widgets as new models. You have the basics in Knob\Widgets (src/widgets/ directory). For example PagesWidget:

// vendor/chemaclass/knob-base/src/widgets/PagesWidget.php
namespace Knob\Widgets;

use Knob\Models\Post;

class PagesWidget extends WidgetBase
{
    public function widget($args, $instance)
    {
        $instance['pages'] = Post::getPages();
        parent::widget($args, $instance);
    }
}

All of these on the best&easy way ever in Knob\libs (src/libs/ directory)

Views based on Mustache templates

All you have to care basically are your templates. That's why we choose Mustache. Is simple, flexible and fun.

Controllers to pull everything together

From Knob\Controllers (src/controllers/ directory)
You will be provided a Knob\Controllers\BaseController to extends your own controllers.

// app/controllers/BaseController.php
namespace Controllers;

use Knob\Controllers\BaseController as KnobBaseController;

class BaseController extends KnobBaseController
{
    // more sentences...
}

Then your HomeController could seems like:

// app/controllers/HomeController.php
namespace Controllers;

use Knob\Controllers\HomeControllerInterface;
use Models\Option;

class HomeController extends BaseController implements HomeControllerInterface {

    /**
     * home.php
     */
    public function getHome()
    {
        $args = [
            'posts' => Post::getAll(Option::get('posts_per_page'))
        ];
        return $this->renderPage('base/home', $args);
    }

    // rest of the implementation...
}