Magento Live Australia 2016: Request Flow

Magento 2 Architect
Eugene Tulika

Entry Point
Everything starts here

Entry Point
• Index.php or pub/index.php – web application
• Static.php – retrieve dynamically generated static files
• Get.php – retrieve media from database
• Cron.php – run commands by Cron
• bin/magento – command line tool

Entry Point
require __DIR__ . '/app/bootstrap.php';
$bootstrap = MagentoFrameworkAppBootstrap::create(BP, $_SERVER);
$app = $bootstrap->createApplication(MagentoFrameworkAppHttp::class);
$bootstrap->run($app);
/index.php

Bootstrap::createApplication
public function createApplication($type, $arguments = [])
{
$this->initObjectManager();
$application = $this->objectManager->create($type, $arguments);
// … type check
return $application;
}
/lib/internal/Magento/Framework/App/Bootstrap.php

Bootstrap::initObjectManager
• We hate init* methods. M1 was full of them
• Loads initial configuration (config.php, env.php, di.xml)
• Loads etc/di.xml files from all modules (global configuration)
• Last point where we have valid init* methods

ApplicationHttp
public function launch()
{
$frontName = $this->_request->getFrontName();
$areaCode = $this->areaList->getCodeByFrontName($frontName);
$this->state->setAreaCode($areaCode);
$this->objectManager->configure($this->_configLoader->load($areaCode));
$frontController = $this->objectManager->get(FrontControllerInterface::class);
$result = $frontController->dispatch($this->_request);
$result->renderResult($this->_response);
return $this->_response;
}
/lib/internal/Magento/Framework/App/Http.php

Application Areas
• Configuration scopes
• etc/<areaCode>/* in module folder
• Loaded on top of global configuration
• Admin, Frontend, Webapi_Rest, Webapi_Soap, Cron

Middleware
Going down the rabbit hole of the onion rings

Middleware
function (request) : response
• Function applied to request in order to generate response
• PSR-7

Middleware
Dispatch
Authentication
CSRF Checks
Page Cache
HTTP Request
HTTP Response

Middleware
• Add your plugin on front controller if you want some logic executed
on all controllers
• Keep POST & GET in mind

Front Controller
public function dispatch(RequestInterface $request){
// …
foreach ($this->routerList as $router) {
$actionInstance = $router->match($request);
if ($actionInstance) {
$result = $actionInstance->execute();
break;
}
}
// …
return $result;
}
/lib/internal/Magento/Framework/App/FrontController.php

Routing
• Every area has own set of routers
• Important routers: standard for frontend & admin for admin
• Both configured in /etc/<areaCode>/routes.xml
• Cover 95% of cases (?)

Routing
<config>
<router id="standard">
<route id=”blog" frontName=”blog">
<module name=”My_Blog" />
</route>
</router>
</config>
/My/Module/etc/frontend/routes.xml

Action Controllers
• Path handlers
• Single method execute
• By convention located in Controller folder of a module
• Different rules for GET and POST
• Request object should not be passed further. Extract arguments and
pass them separately.

Action Controllers
class View extends MagentoFrameworkAppActionAction
{
// constructor and properties
public function execute()
{
// do something
$result = $this->resultFactory->create(ResultFactory::TYPE_REDIRECT);
$result->setPath('*/*/*');
// or
$result = $this->resultFactory->create(ResultFactory::TYPE_PAGE);
return $result;
}
}
My/Module/Controller/Blog/Post/View.php

POST Action Controllers
• Do not render pages. Layout is forbidden
• Only place for application workflow management (redirect,
messages, session)
• All business logic should be delegated to Service Contracts
• Request object should not be passed further. Extract arguments and
pass them separately.

POST Action Controller
class Save extends MagentoFrameworkAppActionAction
{
{
$post = $this->postFactory->create();
$post->setTitle($this->request->getParam('title'));
$post->setText($this->request->getParam('text'));
$post = $this->postRepository->save($post);
$result->setPath(’blogs/post/view’, [’post_id' => $post->getId()]);
}
}
My/Module/Controller/Blog/Post/Save.php

Service Contracts
• Represent public API of a module
• Covered by Backwards Compatibility Policy
• Located Api folder of a module and marked with @api
• Expose procedural API (Service Interfaces) that communicate with
Data Transfer Objects (Data Interfaces)

Service Contracts
My/Module/Api/PostRepository.php
class PostRepository implements MyModuleApiPostRepositoryInterface
{
// ..
public function save(PostInterface $post)
{
$this->postResourceModel->save($post);
return $post;
}
}

Persistence
• Use Resource Models to Load/Save/Delete data
• Use Collections to load lists of data
• load, save, and delete on model are deprecated

POST Action Controller
class Save extends MagentoFrameworkAppActionAction
{
{
$post = $this->postFactory->create();
$post->setTitle($this->request->getParam('title'));
$post->setText($this->request->getParam('text'));
$post = $this->postRepository->save($post);
$result->setPath(’blogs/post/view’, [’post_id' => $post->getId()]);
return $result;
}
}
My/Module/Controller/Blog/Post/Save.php

GET Action Controller
class View extends MagentoFrameworkAppActionAction
{
// constructor and properties
{
$result = $this->resultFactory->create(ResultFactory::TYPE_PAGE);
return $result;
}
}
/app/code/My/Module/Controller/Blog/Post/View.php

GET Action Controllers
• Do not reference blocks directly. They may not exist on the page
• Do not pre-load models and put them to registry. Load what you
need from blocks.
• DO NOTHING in Action Controllers that respond to GET requests
and render pages (only return PageResult)

Layout
/My/Module/view/frontend/layout/blog_post_view.xml
<page>
<body>
<referenceBlock name="container">
<block class="MyModuleBlockBlogPostView”
name=”blog.post.view”
template=”My_Module::blog/post/view.phtml"/>
</referenceBlock>
</body>
</page>

Blocks
/My/Module/view/frontend/templates/blog/post/view.phtml
<?php $post = $block->getBlogPost(); ?>
<article>
<header>
<h1><?php echo $block->escapeHtml($post->getTitle());?></h1>
<span class="date">
<?php echo $block->formatDate($post->getPublicationDate());?>
</span>
<a href="<?php echo $block->getBlogLink($post); ?>" class="blog">
<?php echo $block->escapeHtml(__('To Blog'));?>
</a>
</header>
<?php echo $post->getText(); ?>
</article>

Blocks
namespace MyModuleBlockBlogPost;
class View
{
public function getBlogPost()
{
return $this->postRepository->get($this->request->getParam('post_id'));
}
public function getBlogLink(Post $post)
{
$this->urlBuilder->getUrl('blogs', ['blog_id' => $post->getBlogId()]);
}
}
/My/Module/Block/Blog/Post/View.php

Blocks
• Do not reference other sibling and parent blocks
• Do not perform state-modifications
• Retrieve data from public services
• Do not pass Request object further, extract arguments, and pass
them

Action Results
namespace MagentoFrameworkController;
class ResultFactory
{
const TYPE_JSON = 'json';
const TYPE_RAW = 'raw';
const TYPE_REDIRECT = 'redirect';
const TYPE_FORWARD = 'forward';
const TYPE_LAYOUT = 'layout';
const TYPE_PAGE = 'page';
public function create($type, array $arguments = [])
{
// ...
return $resultInstance;
}
}
/lib/internal/Magento/Framework/Controller/ResultFactory.php

Magento Live Australia 2016: Request Flow

More Related Content

What's hot (20)

Similar to Magento Live Australia 2016: Request Flow (20)

More from Vrann Tulika (7)

Recently uploaded (20)

Magento Live Australia 2016: Request Flow

Editor's Notes