Getting Started with Zend Framework 2

• Framework Overview
• Benefits of using Framework
• Getting Started
  • Installation (Skeleton App)
  • File/Code Structure
  • Modules
  • Controllers, Views, Routing
  • Database and Models
  • Filters
  • Service Manager
    • Factory based instantiation
  • Session Container
• Dependency Injection

“A Framework is a universal, reusable software platform to develop software applications, products and solutions. In other words, we can say it is some kind of library, a piece of software, which provide web developers with code base and consistent standardized ways of creating web applications”.

1. Code and File Organization
2. Enforcing of Good Coding Standards
3. Utilities and Libraries
4. Less Code & Faster Development
5. Community Support
6. Security

7. Modular, use what you need, ignore what you don’t

8. Strong use of OOP and Design Patterns for Consistency

Tutorial: https://docs.zendframework.com/tutorials/getting-started/overview/

Routing: https://docs.zendframework.com/tutorials/in-depth-guide/understanding-routing/

Input Filters: https://framework.zend.com/manual/2.4/en/modules/zend.input-filter.intro.html

Session Container: https://framework.zend.com/manual/2.4/en/modules/zend.session.container.html

A module is a software component or part of a program that contains one or more routines. One or more independently developed modules make up a program. An enterprise-level software application may contain several different modules, and each module serves unique and separate business operations.

// SAMPLE Module.php file
namespace Album;

use Zend\Mvc\ModuleRouteListener;
use Zend\Mvc\MvcEvent;

class Module
{
    public function onBootstrap(MvcEvent $e)
    {
        $eventManager        = $e->getApplication()->getEventManager();
        $moduleRouteListener = new ModuleRouteListener();
        $moduleRouteListener->attach($eventManager);
    }

    public function getConfig()
    {
        return include __DIR__ . '/../config/module.config.php';
    }

}

namespace Album\Controller;

class AlbumController extends AbstractActionController
{
    public function __construct()
    {
    }
}

<?php

namespace Album\ServiceFactory\Controller;

use Psr\Container\ContainerInterface;

class AlbumControllerFactory
{
    public function __invoke(ContainerInterface $container)
    {
        $container = $container->getServiceLocator(); // remove if zf3
        // $AlbumTable = $container->get(AlbumTable::class); // sample call for getting services from service manager
      
        return new AlbumController();
    }
}

'controllers' => array(
    'factories' => array(
        AlbumController::class => AlbumControllerFactory::class
    )
),

'router' => [
    'routes' => [
        'album' => [
            'type'    => Segment::class,
            'options' => [
                'route' => '/album[/:action[/:id]]',
                'constraints' => [
                    'action' => '[a-zA-Z][a-zA-Z0-9_-]*',
                    'id'     => '[0-9]+',
                ],
                'defaults' => [
                    'controller' => Controller\AlbumController::class,
                    'action'     => 'index',
                ],
            ],
        ],
        'home' => [
            'type' => Literal::class,
            'options' => [
                'route'    => '/',
                'defaults' => [
                    'controller' => IndexController::class,
                    'action'     => 'index',
                ]
            ]
        ]
    ],
],

namespace Album\Model;

class Album
{
    public $id;
    public $artist;
    public $title;

    public function exchangeArray(array $data)
    {
        $this->id     = !empty($data['id']) ? $data['id'] : null;
        $this->artist = !empty($data['artist']) ? $data['artist'] : null;
        $this->title  = !empty($data['title']) ? $data['title'] : null;
    }
}

namespace Album\Model;

use Zend\Db\TableGateway\TableGateway;

class AlbumTable
{
    private $tableGateway;

    public function __construct(TableGateway $tableGateway)
    {
        $this->tableGateway = $tableGateway;
    }
}

namespace Album\ServiceFactory\Model;

use Album\Model\Album;
use Album\Model\AlbumTable;
use Psr\Container\ContainerInterface;
use Zend\Db\ResultSet\ResultSet;
use Zend\Db\TableGateway\TableGateway;

class AlbumTableFactory
{
    public function __invoke(ContainerInterface $container)
    {
        // Creation for table gateway instance
        $dbAdapter = $container->get('test');
        $resultSetPrototype = new ResultSet();
        $resultSetPrototype->setArrayObjectPrototype(new Album());

        // create TableGateway instance
        $tableGateway = new TableGateway(
            'album',
            $dbAdapter,
            null,
            $resultSetPrototype
        );

        // Create AlbumTable instance
        return new AlbumTable($tableGateway);
    }
}

'service_manager' => array(
    'factories' => array(
        AlbumTable::class => AlbumTableFactory::class,
        'Album\Storage\AlbumSessionContainer' => AlbumSessionContainerFactory::class,
    ),
    'invokables' => array(
        AlbumFilter::class => AlbumFilter::class,
    )
),

return array(
    'service_manager' => array(
        'abstract_factories' => array(
            'Zend\Db\Adapter\AdapterAbstractServiceFactory',
        ),
    ),
    'db' => array(
        'adapters' => array(
            'test' => array(
                'driver' => 'Pdo_Mysql',
                'driver_options' => array(
                    PDO::MYSQL_ATTR_INIT_COMMAND => 'SET NAMES \'UTF8\''
                )
            ),
        ),
    ),
);

return array(
    'db' => array(
        'adapters' => array(
            'test' => array(
                'dsn' => 'mysql:dbname=test;host=mysql-57',
                'username' => 'root',
                'password' => 'root'
            ),
        ),
    ),
);

public function selectWithJoin()
{
    $select = $this->tableGateway->getSql()->select();
    $select->columns(array("artist"));
    $select->join(
        array("a" => "artists"),
        "a.artist_id = album.artist_id",  array("*"),"LEFT"
    );
    
    // query to fetch specific column
    $resultSet = $this->tableGateway->selectWith($select)->getDataSource();
    
    // this will return columns that are not specified in the query,
    // but values are null
    $resultSet = $this->tableGateway->selectWith($select);
    
    foreach ($resultSet as $row) {
        \Zend\Debug\Debug::dump($row);
        exit;
    }
    // dump sql query
    /// echo $this->tableGateway->getSql()->getSqlStringForSqlObject($select);

}

namespace Album\Filter;

use Zend\InputFilter\InputFilter;
use Zend\Validator\NotEmpty;

class AlbumFilter extends InputFilter
{
    public function __construct()
    {
        $this->add(array(
            'name'     => 'artist',
            'required' => true,
            'filters'  => array(
                array('name' => 'StripTags'),
                array(
                    'name' => 'StringTrim',
                ),
            ),
            'validators' => array(
                array(
                    'name'    => 'StringLength',
                    'options' => array(
                        'min'     => 1,
                        'max'     => 35,
                        'messages' => array(
                            'stringLengthTooShort' => 'Artist is too short.',
                            'stringLengthTooLong' => 'Artist is too long.'
                        ),
                    ),
                ),
            ),
        ));
}

public function onBootstrap(MvcEvent $e)
{
    .... Some codes here .... 

    /**
     * This method will handle the setting of session sharing configurations
     * and also starting the session manager.
     */

    $sm = $e->getApplication()->getServiceManager();
    $config = $sm->get('Configuration');
    $sessionConfig = new SessionConfig();
    $sessionConfig->setOptions($config['session_config']);
    $sessionManager = new SessionManager($sessionConfig);
    $sessionManager->start();
}

'session_config' => array(
        'remember_me_seconds' => 2419200,
        'use_cookies' => true,
        'cookie_domain' => '.zftraining.com',
//        'php_save_handler' => 'memcache',
//        'save_path' => 'tcp://memcached-session:11211',
    ),

https://www.tutorialspoint.com/design_pattern/factory_pattern.htm

Dependency injection (Di) is a design pattern which purpose is to reduce the coupling between software components.

• Allow to programmatically configure dependencies.
• Use to easily apply Inversion Of Control.
• Creates and stores instances of your objects: an instance manager.