piano/mvc

There is no license information available for the latest version (1.6.3.1) of this package.

A very simple MVC support and routing.

Maintainers

Details

github.com/diogocavilha/Piano

Source

Issues

Installs: 219

Dependents: 0

Suggesters: 0

Security: 0

Stars: 6

Watchers: 4

Forks: 2

Open Issues: 0

1.6.3.1 2016-02-14 01:54 UTC

Requires (Dev)

Unknown License 21d95d76215addd17ba5fcef667e059549e42c4f

  • Diogo Alexsander Cavilha <diogocavilha.woop@gmail.com>

This package is auto-updated.

Last update: 2024-03-27 18:19:40 UTC

README

Build Status

Piano MVC

This is not a micro/mini/whatever framework nor claims to be.

It's only a very simple MVC structure.

WARNING: This has been just like a lab. I don't update this project anymore. If you want to use it, the ball is on your court.

Creating the project structure

composer create-project piano/mvc:dev-application myProject

Controller

Redirecting

$this->redirect('/module/controller/action');

Redirecting with variables

$this->redirect(
    '/module/controller/action',
    [
        'firstName' => 'Diogo',
        'lastName' => 'Cavilha',
    ]
);

Getting params by name

$id = $this->getParam('id');

Getting all params

$params = $this->getParams();

Methods from Piano\Mvc\Controller

initialize()

If you need to create a constructor method for your controller, you can do this by creating a method called initialize() instead of __construct(). The __construct() method is already being used by Piano\Mvc\Controller.

Example:

<?php

namespace app\modules\application\controllers;

class IndexController extends Piano\Mvc\Controller
{
    protected function initialize()
    {
        // Do some action before executing any other code of your controller.
    }
}

View

Rendering a view

$this->view->render('view-name');

Rendering a view with variables

$this->view->render('view-name', ['name' => 'Diogo']);

// or

$this->view->addVar('name', 'Diogo');
$this->view->addVar('email', 'email@domain.com');

$this->view->render('view-name');

// or

$this->view->setVars([
    'name' => 'Diogo',
    'email' => 'email@domain.com',
]);

$this->view->render('view-name');

So, in the view code you can access the variable:

<p>The user name is: <?php echo $name ?></p>

Disabling/Enabling the layout

$this->view->disableLayout(); // disabling
$this->view->disableLayout(true); // disabling
$this->view->disableLayout(false); // enabling

Adding a partial

$this->partial('/path/to/file');

Adding a partial with variables

$this->partial('/path/to/file', ['title' => 'Piano MVC rocks!']);

Loading CSS files

You can load CSS files on demand. It means you can define what CSS files are gonna be loaded when some specific view is rendered. Better than that, you can do this for each of your views.

You can use the addCss() method.

$this->view->addCss('/path/to/file1.css');
$this->view->addCss('/path/to/file2.css');
$this->view->addCss('/path/to/file3.css');

$this->view->render('view-name');

// or

$this->view
    ->addCss('/path/to/file1.css')
    ->addCss('/path/to/file2.css')
    ->addCss('/path/to/file3.css')
    ->render('view-name');

Or you may want to use the setCss() method.

$this->view->setCss([
    '/path/to/file1.css',
    '/path/to/file2.css',
    '/path/to/file3.css',
]);

$this->view->render('view-name');

// or

$this->view
    ->setCss([
        '/path/to/file1.css',
        '/path/to/file2.css',
        '/path/to/file3.css',
    ])
    ->render('view-name');

PS: You must call addCss() or setCss() method before calling the render() method. Otherwise it won't work.

Loading javascript files

You can load javascript files on demand. It means you can define what javascript files are gonna be loaded when some specific view is rendered. Better than that, you can do this for each of your views.

You can use the addJs() method.

$this->view->addJs('/path/to/file1.js');
$this->view->addJs('/path/to/file2.js');
$this->view->addJs('/path/to/file3.js');

$this->view->render('view-name');

// or

$this->view
    ->addJs('/path/to/file1.js')
    ->addJs('/path/to/file2.js')
    ->addJs('/path/to/file3.js')
    ->render('view-name');

Or you may want to use the setJs() method.

$this->view->setJs([
    '/path/to/file1.js',
    '/path/to/file2.js',
    '/path/to/file3.js',
]);

$this->view->render('view-name');

// or

$this->view
    ->setJs([
        '/path/to/file1.js',
        '/path/to/file2.js',
        '/path/to/file3.js',
    ])
    ->render('view-name');

PS: You must call addJs() or setJs() method before calling the render() method. Otherwise it won't work.

In order to load these CSS or JS files in your view/layout you can call the loadCss() or loadJs() method.

// Loading the js files
$this->loadJs();

// Loading the css files
$this->loadCss();

href links

<a href="<?php echo $this->url('route_name'); ?>">Text</a>

Form action must be written by using a pre-defined route

<form action="<?php echo $this->url('contact'); ?>" method="post">
    Name: <input type="text" name="name">
    Email: <input type="text" name="email">
    <input type="submit" name="Send">
</form>

Model

The DataAccessAbstract class.

The Piano\Mvc\DataAccessAbstract abstract class provides us a few methods for handling data by accessing the database.

Attributes from Piano\Mvc\DataAccessAbstract

protected $table;

Table name for working.

protected $model;

If not null, it's used for fetching its model. Otherwise, it will use an associative array.

protected $pdo;

A PHP PDO instance.

Methods from Piano\Mvc\DataAccessAbstract

insert(array $data, array $dataBind)

Create a record into database.

Parameters

data

Array data to insert into the database table.

dataBind

The bound values.

Return Values

Returns the last insert id on success or FALSE on failure.

update(array $data, $where, array $dataBind)

Change a database record.

Parameters

data

Array data to insert into the database table.

where

Where clause.

dataBind

The bound values.

Return Values

Returns TRUE on success or FALSE on failure.

delete($where, array $dataBind = array())

Delete a record from database.

Parameters

where

Where clause.

dataBind

The bound values.

Return Values

Returns TRUE on success or FALSE on failure.

getAll([$configData = null, $order = null, $count = null, $offset = null])

Perform a query in order to return all database records.

Parameters

configData

The query configuration.

Example:

$configData = array(
    'fetchClass' => false,
    'columns' => '*',
    'condition' => 'id = :id',
    'values' => array(
        array(':id', 1, PDO::PARAM_INT)
    )
);

order

Like SQL ORDER.

Example:

'id ASC, name ASC'

count

Integer value used to make the query return a specific set of rows.

offset

Integer value used to make the query return a specific set of rows.

PS: When both count and offset are used, the query to be executed has LIMIT offset, count

Return Values

  • When fetchClass parameter is true or omitted, it returns an array of model objects.
  • When fetchClass parameter is false, it returns an associative array.
getFirst($configData = null, $order = null)

Perform a query in order to return all database records.

Parameters

configData

The query configuration.

Example:

$configData = array(
    'fetchClass' => false,
    'columns' => '*',
    'condition' => 'id = :id',
    'values' => array(
        array(':id', 1, PDO::PARAM_INT)
    )
);

order

Like SQL ORDER.

Example:

'id ASC, name ASC'

Return Values

  • When fetchClass parameter is true or omitted, it returns a model object.
  • When fetchClass parameter is false, it returns an associative array.

Examples:

insert()
$pdo = new PDO("mysql:host=host;dbname=db;", 'user', 'pass');

$userDAO = new \app\dataAccess\UserDataAccess($pdo);
$id = $userDAO->insert(
                    array(
                       'name' => ':name',
                       'email' => ':email',
                    ), array(
                       array(':name', 'John Doe', PDO::PARAM_STR),
                       array(':email', 'john@domain.com', PDO::PARAM_STR),
                    )
                );
update()
$pdo = new PDO("mysql:host=host;dbname=db;", 'user', 'pass');

$userDAO = new \app\dataAccess\UserDataAccess($pdo);
$status = $userDAO->update(
                        array(
                            'name' => ':new_name',
                        ),
                        'name = :where_name',
                        array(
                           array(':new_name', 'New Name', PDO::PARAM_STR),
                           array(':where_name', 'Old Name', PDO::PARAM_STR),
                       )
                    );
delete()
$pdo = new PDO("mysql:host=host;dbname=db;", 'user', 'pass');

$userDAO = new \app\dataAccess\UserDataAccess($pdo);
$status = $userDAO->delete(
                        'id = :id',
                        array(
                           array(':id', 2, PDO::PARAM_INT),
                       )
                    );

// or

$userDAO = new \app\dataAccess\UserDataAccess($pdo);
$status = $userDAO->delete('id = 2');
getAll()
$pdo = new PDO("mysql:host=host;dbname=db;", 'user', 'pass');

$userDAO = new \app\dataAccess\UserDataAccess($pdo);
$users = $userDAO->getAll(
                        array(
                           'columns' => '*',
                           'condition' => 'id = :id',
                           'values' => array(
                               array(':id', 1, PDO::PARAM_INT),
                           )
                        ),
                        'id DESC',
                        10, // show 10 records
                        30 // start showing from the 30th record
                    );

// or

$userDAO = new \app\dataAccess\UserDataAccess($pdo);
$users = $userDAO->getAll();
getFirst()
$pdo = new PDO("mysql:host=host;dbname=db;", 'user', 'pass');

$userDAO = new \app\dataAccess\UserDataAccess($pdo);
$user = $userDAO->getFirst(
                        array(
                           'columns' => '*',
                           'condition' => 'id = :id',
                           'values' => array(
                               array(':id', 1, PDO::PARAM_INT)
                           )
                        )
                    );

// or

$userDAO = new \app\dataAccess\UserDataAccess($pdo);
$user = $userDAO->getFirst();

Application

Getting module name

$this->getApplication()->getModuleName();

Getting controller name

$this->getApplication()->getControllerName();

Getting action name

$this->getApplication()->getActionName();

Class Piano\Config\Ini

The Piano\Config\Ini is a ini file parser. You must pass the ini path as an argument to its constructor.

Sample
$config = new Piano\Config\Ini('/path/to/config.ini');
$configIni = $config->get();

// getting a simple value

$configIni = $config->get('name');
// If "name" doesn't exist in config file, it will return an empty array.

// getting a section

$configIni = $config->get('section_name');
// If section_name doesn't exist in config file, it will return an empty array.

Class Piano\Config\Pdo

The Piano\Config\Pdo provide us an easier way to configure a \Pdo connection. You must pass an config array as an argument to its constructor.

Sample
// The config array must be like this.
$config = [
    'dbAdapter' => 'mysql',
    'dbHost'    => 'localhost',
    'dbName'    => '',
    'dbUser'    => '',
    'dbPass'    => '',
];

$pdo = new Piano\Config\Pdo($config);
$pdo = $pdo->get();

Class Piano\Router

The Piano\Router is a route parser. It helps you to define the application's routes.

Sample
$router = new Piano\Router();

You're able to define all routes as an array or by using the Piano\Router object notation.

Defining routes as array.

$routes = [
    'default' => [
        'route' => '/',
        'module' => 'application',
        'controller' => 'index',
        'action' => 'index',
    ],
    'contact' => [
        'route' => '/contact',
        'module' => 'application',
        'controller' => 'index',
        'action' => 'contact',
    ],
    'userEdit' => [
        'route' => '/user/:id',
        'module' => 'application',
        'controller' => 'user',
        'action' => 'edit',
        [
            ':id' => '\d+'
        ]
    ],
];

$router->setRoutes($routes);

Defining routes as object.

$router->addRoute('default', '/', [
    'module' => 'application',
    'controller' => 'index',
    'action' => 'index',
]);

$router->addRoute('contact', '/contact', [
    'module' => 'application',
    'controller' => 'index',
    'action' => 'contact',
]);

$router->addRoute('userEdit', '/user/:id', [
    'module' => 'application',
    'controller' => 'index',
    'action' => 'contact',
    [
        ':id' => '\d+'
    ]
]);

You can also enable/disable SEF. (It's useful to disable it when developing) It can be done by calling the method enableSearchEngineFriendly

$router->enableSearchEngineFriendly(); // Enable
$router->enableSearchEngineFriendly(true); // Enable
$router->enableSearchEngineFriendly(false); // Disable

If you want to get all routes or a particular one, you could do like this:

// It'll return all your routes definitions.
$router->getRoutes();

// It'll return informations from the given route, in this case `myRouteName`
$router->getRoutes('myRouteName');