anax/proxy

Anax Proxy module, for static access to di service container.

Installs: 278

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

Language:Makefile

v1.0.2 2018-11-20 16:43 UTC

This package is auto-updated.

Last update: 2020-11-21 12:17:47 UTC


README

Latest Stable Version Join the chat at https://gitter.im/canax/proxy

Build Status CircleCI

Build Status Scrutinizer Code Quality Code Coverage

Maintainability Codacy Badge

Anax proxy is a module for static proxy to access framework resources, services, that are available in $di service container.

The basic idea is to allow static access like this Session::start(). You can see it as a wrapper above the ordinary way using $di->get("session")->start(). It is syntactic sugar.

You can compare it to the implementation of Laravel Facade.

Table of content

You can also read this documentation online.

Install

You can install the module from anax/proxy on Packagist using composer.

composer require anax/proxy

Development

To work as a developer you clone the repo and install the local environment through make. Then you can run the unit tests.

make install
make test

Init the proxy factory

You start by initiating the proxy factory in the frontcontroller index.php.

use Anax\Proxy\ProxyDIFactory;

// Add all framework services to $di
$di = new Anax\DI\DIFactoryConfig();
$di->loadServices(ANAX_INSTALL_PATH . "/config/di");

// Add anax/proxy access to $id, if available
ProxyDIFactory::init($di);

Or like this to take into account if the module is installed or not.

// Add anax/proxy access to $id, if available
if (class_exists("\Anax\Proxy\ProxyDIFactory")) {
    \Anax\Proxy\ProxyDIFactory::init($di);
}

The service container $di is injected and an autoloader is created to catch and dynamic create classes for the proxy class to map the service in $di.

Use services through the proxy

You start by defining the proxy service class through its service name, like this.

use \Anax\Proxy\DI\Db;

You can then use it through static access Db::connect() which behind the scenes translates to $di->get("db")->connect().

This is how it can be used with a route.

use \Anax\Proxy\DI\Db;
use \Anax\Proxy\DI\Router;
use \Anax\Proxy\DI\View;
use \Anax\Proxy\DI\Page;

/**
 * Show all movies.
 */
Router::get("movie", function () {
    $data = [
        "title"  => "Movie database | oophp",
    ];

    Db::connect();

    $sql = "SELECT * FROM movie;";
    $res = Db::executeFetchAll($sql);

    $data["res"] = $res;

    View::add("movie/index", $data);
    Page::render($data);
});

Here is the same route implemented, with $app style programming and dependency to the (globaly) scoped variable $app which is a front for $di.

/**
 * Show all movies.
 */
$app->router->get("movie", function () use ($app) {
    $data = [
        "title"  => "Movie database | oophp",
    ];

    $app->db->connect();

    $sql = "SELECT * FROM movie;";
    $res = $app->db->executeFetchAll($sql);

    $data["res"] = $res;

    $app->view->add("movie/index", $data);
    $app->page->render($data);
});

Above example uses $app which itself does a $di->get("service") behind the scene.

So, it is a matter of syntactic sugar, a layer of user friendliness you might approve of, or not.

Related design patterns

Laravel have an implementation as Laravel Facade. This might indicate they relate to the design pattern Facade design pattern.

People have argued that the implementation is more of the design pattern Proxy design pattern.

People have also argued that it is an implementation of the design pattern Singleton design pattern.

Dependency

Using psr11 through psr/container.

License

This software carries a MIT license. See LICENSE.txt for details.

 .  
..:  Copyright (c) 2018 Mikael Roos, mos@dbwebb.se