Fundamentals of Extending Magento 2 - php[world] 2015

Fundamentals of Extending Magento 2
Presented by: David Alger

Fundamentals of Extending Magento 2 @blackbooker / #phpworld
My Experience
Magento developer since early 2009
Magento 1 & 2 contributor
GitHub Community Moderator
Director of Technology at Classy Llama
2

@blackbooker / #phpworldFundamentals of Extending Magento 2
Platform Architecture
Some highlights
3

Technology Stack
PHP 5.6.x or 5.5.x*
PSR-0 through PSR-4
HTML5 & CSS3 w/LESS
JQuery w/RequireJS
3PLs ZF1, ZF2 and Symfony
Apache 2.2, 2.4 / Nginx 1.8
MySQL 5.6
Composer meta-packages
*There are known issues with 5.5.10–5.5.16 and 5.6.0
Optional components:
• Varnish as a cache layer
• Redis for sessions or page caching
• Solr (search engine)
4

Backwards Compatibility
SemVer 2.0 policy for PHP code
Version numbers in MAJOR.MINOR.PATCH format
• MAJOR indicates incompatible API changes
• MINOR where added functionality is backward-compatible
• PATCH for backward-compatible bug ﬁxes
Guaranteed BC for code with @api annotations
@deprecated annotations with ~1yr later removal
5

Strongly Layered
Presentation layer to provide view components
Service layer deﬁned interfaces for integrating with logic
Domain layer to provide core business logic and base functionality
Persistence layer using an active record pattern to store data
6

Magento Components
Modules support major functionality and behavior
Themes implement the interface users interact with
Language packs to support i18n
Vendor libraries such as ZF1, ZF1 & Symfony
7

Breaking it Down
MagentoFramework
• provides common libraries such as FS, Events, OM, etc
• core application behavior such as routing
• does not "know" about anything outside of itself
VendorLibrary similar to framework, don't re-invent
Modules,Themes & Language Packs
• areas you as a developer will be working with
• may fall into either of 2 categories: required or optional
8

Digging In
Devil in the details
9

Dependency Injection
Implements the constructor injection pattern
Dependencies may be provided automatically
Some injected dependencies must be set in XML
This completely replaces the "Mage" god class in 1.x
Class dependencies can be replaced via module conﬁg
10

Injecting an Interface
class Norf
{
protected $bar;
public function __construct(BarInterface $bar) {
$this->bar = $bar;
parent::__construct();
}
}
11

Preferred Implementation
<?xml version="1.0"?>
<config xmlns:xsi="..." xsi:noNamespaceSchemaLocation="...">
<preference for="BarInterface" type="Bar" />
</config
12
etc/di.xml

DI Proxies
<type name="FooBarModelBaz" shared="false">
<arguments>
<argument name="norf" xsi:type="object">FooBarModelNorf</argument>
</arguments>
</type>
13

Plugins
Plugins work using technique called interception
They are implemented in context of a module
You write your plugins; interceptor code is generated
Can wrap around, be called before/after class methods
14
http://devdocs.magento.com/guides/v2.0/extension-dev-guide/plugins.html

Declaring the Plugin
<config xmlns:xsi="..." xsi:noNamespaceSchemaLocation="...">
<type name="FooBarModelNorf">
<plugin name="Foo_Bar::Qux" type="FooBarPluginQux"/>
</type>
</config>
15
etc/di.xml

Intercepting Before
class Qux
{
public function beforeSetBaz(Norf $subject, $baz)
{
// modify baz
return [$baz];
}
}
16
Plugin/Qux.php

Intercepting After
class Qux
{
public function afterGetBaz(Norf $subject, $result)
{
// modify result
return $result;
}
}
17
Plugin/Qux.php

Wrapping Around
class Qux
{
public function aroundBaztastic(Norf $subject, Closure $proceed)
{
// do something before
$result = $proceed();
if ($result) {
// do something really cool
}
return $result;
}
}
18
Plugin/Qux.php

Where can you Plugin?
Anywhere except for…
• ﬁnal methods / classes
• non-public methods
• class methods
• __construct
19
http://devdocs.magento.com/guides/v2.0/extension-dev-guide/plugins.html

Code Generation
Auto-generates code to create non-existent classes
This is based on convention such as *Factory classes
You can still see and debug the code in var/generation
In development mode these are created in autoloader
Production mode expects pre-compilation via CLI tool
20

Factory Pattern
Single purpose objects used to create object instances
Isolate the object manager from business logic
Instead of injecting ObjectManager, use a *Factory
Uniform pattern interface since they are generated
21

BaseFactory
class BaseFactory
{
protected $objectManager;
public function __construct(ObjectManager $objectManager)
{
$this->objectManager = $objectManager;
}
public function create($sourceData = null)
{
return $this->objectManager->create('Base', ['sourceData' => $sourceData]);
}
}
22

Using a Factory
class Norf
{
protected $barFactory;
public function __construct(BarFactory $barFactory) {
$this->barFactory = $barFactory;
parent::__construct();
}
/** returns Bar object instantiated by object manager */
public function createBar() {
return $this->barFactory->create();
}
}
23

Component Management
All components installed via composer
Register component so Magento knows it's there
Composer auto-loader used to load registration.php
Any app/code/*/*/registration.php loaded in bootstrap
24

Component Registration
use MagentoFrameworkComponentComponentRegistrar;
ComponentRegistrar::register(ComponentRegistrar::MODULE, 'Foo_Bar', __DIR__);
25
registration.php

Autoload Conﬁguration
{
"name": "foo/bar-component",
"autoload": {
"psr-4": { "FooBarComponent": "" },
"files": [ "registration.php" ]
}
}
26
composer.json

Component registration
for everything!
27

Installing Magento 2
Starting your ﬁrst project
28

Which install method?
Getting the source
• Complete tarball
• Composer meta-packages
• GitHub clone
App installation
• Command line `bin/magento` tool
• GUI wizard
29
http://devdocs.magento.com/guides/v2.0/install-gde/continue.html

Installing from GitHub
Used to contribute back to core via PRs
Sample data may still be installed, but messier
30

$ mkdir -p /server/sites/m2.dev
$ cd /server/sites/m2.dev
$ git clone /server/.shared/m2.repo ./ && git checkout 2.0.0
$ composer install --no-interaction --prefer-dist
$ mysql -e 'create database m2_dev'
$ bin/magento setup:install --base-url=http://m2.dev --backend-frontname=backend
--admin-user=admin --admin-firstname=Admin --admin-lastname=Admin
--admin-email=user@example.com --admin-password=A123456
--db-host=dev-db --db-user=root --db-name=m2_dev
$ mkdir -p /server/sites/m2.dev/var/.m2-data && pushd /server/sites/m2.dev/var/.m2-data
$ git clone -q /server/.shared/m2-data.repo ./ && git checkout 2.0.0 && popd
$ php -f /server/sites/m2.dev/var/.m2-data/dev/tools/build-sample-data.php --
--ce-source=/server/sites/m2.dev
$ bin/magento setup:upgrade
$ bin/magento cache:flush
31
bit.ly/1NFrVep

Installing via Composer
Use of meta-packages provide you more control
Clear separation between custom / vendor code
Sample data is a snap to install
Best method to use for site builds and other projects
32

Installing via Composer
$ cd /sites
$ composer create-project --repository-url=https://repo.magento.com/
magento/project-community-edition m2.demo
$ cd m2.demo
$ chmod +x bin/magento
$ bin/magento sampledata:deploy
$ composer update # this line here because bugs... fix on it's way
$ mysql -e 'create database m2_demo'
$ bin/magento setup:install --base-url=http://m2.demo --backend-frontname=backend
--admin-user=admin --admin-firstname=Admin --admin-lastname=Admin
--admin-email=user@example.com --admin-password=A123456
--db-host=dev-db --db-user=root --db-name=m2_demo
33
bit.ly/1H8P249

Installing for Shared Hosting
Tarballs for "easy" install method on shared hosting
Essentially same code produced via composer install
Can be readily used where CLI access is not to be had
After install can be maintained with composer
34

GUI Wizard vs CLI Install
is your choice
35

Makings of a Module
Starting with a skeleton
37

Module Organization
38

Skeleton
app/code/Alger
└── Skeleton
├── composer.json
├── etc
│ └── module.xml
└── registration.php
39
https://github.com/davidalger/phpworld-talk2 — initial commit

registration.php
use MagentoFrameworkComponentComponentRegistrar;
ComponentRegistrar::register(ComponentRegistrar::MODULE, 'Alger_Skeleton', __DIR__);
40
https://github.com/davidalger/phpworld-talk2

module.xml
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
<module name="Alger_Skeleton" setup_version="1.0.0" />
</config>
41

composer.json
{
"name": "alger/module-skeleton",
"type": "magento2-module",
"require": {
"magento/framework": "*"
},
"autoload": {
"files": [ "registration.php" ],
"psr-4": {
"AlgerSkeleton": ""
}
}
}
42

$ composer config repositories.alger/phpworld-talk2
vcs git@github.com:davidalger/phpworld-talk2.git
$ composer require alger/module-skeleton:dev-master
$ bin/magento setup:upgrade -q && bin/magento cache:flush -q
$ git clone git@github.com:davidalger/phpworld-talk2.git
app/code/Alger/Skeleton
$ bin/magento module:enable Alger_Skeleton
$ bin/magento setup:upgrade -q && bin/magento cache:flush -q
43
bit.ly/1MWbb1E
OR

Example Block
namespace AlgerSkeletonBlock;
use AlgerSkeletonHelperBar;
use MagentoFrameworkViewElementTemplate;
use MagentoFrameworkViewElementTemplateContext;
class Norf extends Template {
protected $bar;
public function __construct(Bar $bar, Context $context, array $data = []) {
$this->bar = $bar;
parent::__construct($context, $data);
}
public function getDrinksCallout() {
return 'Helper your self to an ' . implode(' or a ', $this->bar->getDrinks()) . '!';
}
}
44
Block/Norf.php

Using the Block
<page xmlns:xsi="..." xsi:noNamespaceSchemaLocation="...">
<body>
<referenceContainer name="page.top">
<block class="AlgerSkeletonBlockNorf"
template="Alger_Skeleton::banner.phtml"/>
</referenceContainer>
</body>
</page>
45

Unit Testing
namespace AlgerSkeletonTestUnit;
use MagentoFrameworkTestFrameworkUnitHelperObjectManager;
class HelperTest extends PHPUnit_Framework_TestCase {
protected $object;
protected function setUp() {
$this->object = (new ObjectManager($this))->getObject('AlgerSkeletonHelperBar');
}
/** @dataProvider pourDrinkDataProvider */
public function testPourDrink($brew, $expectedResult) {
$this->assertSame($expectedResult, $this->object->pourDrink($brew));
}
public function pourDrinkDataProvider() {
return [['Sam', 'Adams'], ['Blue', 'Moon']];
}
}
46

Running our Test
$ cd dev/tests/unit
$ phpunit ../../../app/code/Alger/Skeleton/
PHPUnit 4.8.5 by Sebastian Bergmann and contributors.
..
Time: 235 ms, Memory: 15.00Mb
OK (2 tests, 2 assertions)
47

Our Result
48

The CLI Tool
bin/magento
49

Running from Anywhere
#!/usr/bin/env bash
dir="$(pwd)"
while [[ "$dir" != "/" ]]; do
if [[ -x "$dir/bin/magento" ]]; then
"$dir/bin/magento" "$@"
exit $?
fi
dir="$(dirname "$dir")"
done
>&2 echo "Error: Failed to locate bin/magento (you probably are not inside a magento site root)"
50
bit.ly/215EOYR — /usr/local/bin/magento

Common Commands
bin/magento setup:install
bin/magento setup:upgrade
bin/magento module:enable
bin/magento module:disable
bin/magento cache:clean [type]
bin/magento cache:ﬂush
bin/magento dev:urn-catalog:generate .idea/misc.xml
bin/magento admin:user:create
51

Var Directories
var/page_cache
var/cache
var/composer_home
var/generation
var/di
var/view_preprocessed
cached pages
cached objects
setup wizard artifacts
generated classes
compiled DI conﬁg
compiled view components
52
http://devdocs.magento.com/guides/v2.0/howdoi/php/php_clear-dirs.html

If all else fails…
rm -rf var/{cache,page_cache,generation,di,view_preprocessed}/*
53

Keep in Touch!
54
@blackbooker
https://github.com/davidalger
http://davidalger.com
https://joind.in/14791
Developer Hub
Documentation
Community GitHub
Magento U
Vagrant Stack
http://magento.com/developers/magento2
http://devdocs.magento.com
http://github.com/magento/magento2
http://magento.com/training/catalog/magento-2
https://github.com/davidalger/devenv

Fundamentals of Extending Magento 2 - php[world] 2015

Fundamentals of Extending Magento 2 - php[world] 2015

More Related Content

What's hot (20)

Similar to Fundamentals of Extending Magento 2 - php[world] 2015 (20)

Recently uploaded (20)

Fundamentals of Extending Magento 2 - php[world] 2015