Search icon CANCEL
Subscription
0
Cart icon
Your Cart (0 item)
Close icon
You have no products in your basket yet
Arrow left icon
Explore Products
Best Sellers
New Releases
Books
Videos
Audiobooks
Learning Hub
Free Learning
Arrow right icon
Magento 2 Developer's Guide
Magento 2 Developer's Guide

Magento 2 Developer's Guide: Harness the power of Magento 2 to extend and customize your online store

eBook
$22.99 $33.99
Paperback
$41.99
Subscription
Free Trial
Renews at $19.99p/m

What do you get with a Packt Subscription?

Free for first 7 days. $19.99 p/m after that. Cancel any time!
Product feature icon Unlimited ad-free access to the largest independent learning library in tech. Access this title and thousands more!
Product feature icon 50+ new titles added per month, including many first-to-market concepts and exclusive early access to books as they are being written.
Product feature icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Product feature icon Thousands of reference materials covering every tech concept you need to stay up to date.
Subscribe now
View plans & pricing
Table of content icon View table of contents Preview book icon Preview Book

Magento 2 Developer's Guide

Chapter 1. Understanding the Platform Architecture

Magento is a powerful, highly scalable, and highly customizable e-commerce platform that can be used to build web shops and, if needed, some non-e-commerce sites. It provides a large number of e-commerce features out of the box.

Features such as product inventory, shopping cart, support for numerous payment and shipment methods, promotion rules, content management, multiple currencies, multiple languages, multiple websites, and so on make it a great choice for merchants. On the other hand, developers enjoy the full set of merchant-relevant features plus all the things related to actual development. This chapter will touch upon the topic of robust Web API support, extensible administration interface, modules, theming, embedded testing frameworks, and much more.

In this chapter, a high-level overview of Magento is provided in the following sections:

  • The technology stack
  • The architectural layers
  • The top-level filesystem structure
  • The module filesystem structure

The technology stack

Magento's highly modular structure is a result of several open source technologies embedded into a stack. These open source technologies are composed of the following components:

  • PHP: PHP is a server-side scripting language. This book assumes that you have advanced knowledge of the object-oriented aspects of PHP, which is often referred to as PHP OOP.
  • Coding standards: Magento puts a lot of emphasis on coding standards. These include PSR-0 (the autoloading standard), PSR-1 (the basic coding standards), PSR-2 (the coding style guide), PSR-3, and PSR-4.
  • Composer: Composer is a dependency management package for PHP. It is used to pull in all the vendor library requirements.
  • HTML: HTML5 is supported out of the box.
  • CSS: Magento supports CSS3 via its in-built LESS CSS preprocessor.
  • jQuery: jQuery is a mature cross-platform JavaScript library that was designed to simplify the DOM manipulation. It is one of the most popular JavaScript frameworks today.
  • RequireJS: RequireJS is a JavaScript file and module loader. Using a modular script loader such as RequireJS helps improve the speed and quality of code.
  • Third-party libraries: Magento comes packed with lot of third-party libraries, with the most notable ones being Zend Framework and Symfony. It is worth noting that Zend Framework comes in two different major versions, namely version 1.x and version 2.x. Magento uses both of these versions internally.
  • Apache or Nginx: Both Apache and Nginx are HTTP servers. Each has its distinct advantages and disadvantages. It would be unfair to say one is better than another, as their performance widely depends on the entire system's setup and usage. Magento works with Apache 2.2 and 2.4 and Nginx 1.7.
  • MySQL: MySQL is a mature and widely used relational database management system (RDBMS) that uses structured query language (SQL). There are both free community versions and commercial versions of MySQL. Magento requires at least the of MySQL Community Edition version 5.6.
  • MTF: Magento Testing Framework (MTF) delivers an automated testing suite. It covers various types of tests, such as performance, functional, and unit testing. The entire MTF is available on GitHub, which can be viewed by visiting https://github.com/magento/mtf as an isolated project.

Different pieces of technology can be glued into various architectures. There are different ways to look at the Magento architecture—from the perspective of a module developer, system integrator, or a merchant, or from some other angle.

The architectural layers

From top to bottom, Magento can be divided into four architectural layers, namely presentation, service, domain, and persistence.

The presentation layer is the one that we directly interact with through the browser. It contains layouts, blocks, templates, and even controllers, which process commands to and from the user interface. Client-side technologies such as jQuery, RequireJS, CSS, and LESS are also a part of this layer. Usually, three types of users interact with this layer, namely web users, system administrators, and those making the Web API calls. Since the Web API calls can be made via HTTP in a manner that is the same as how a user uses a browser, there's a thin line between the two. While web users and Web API calls consume the presentation layer as it is, the system administrators have the power to change it. This change manifests in the form of setting the active theme and changing the content of the CMS (short for content management system) pages, blocks, and the products themselves.

When the components of a presentation layer are being interacted with, they usually make calls to the underlying service layer.

The service layer is the bridge between the presentation and domain layer. It contains the service contracts, which define the implementation behavior. A service contract is basically a fancy name for a PHP interface. This layer is where we can find the REST/SOAP APIs. Most user interaction on the storefront is routed through the service layer. Similarly, the external applications that make the REST/SOAP API calls also interact with this layer.

When the components of a service layer are being interacted with, they usually make calls to the underlying domain layer.

The domain layer is really the business logic of Magento. This layer is all about generic data objects and models that compose the business logic. The domain layer models themselves do not contribute to data persistence, but they do contain a reference to a resource model that is used to retrieve and persist the data to a MySQL database. A domain layer code from one module can interact with a domain module code from another module via the use of event observers, plugins, and the di.xml definitions. We will look into the details of these later on in other chapters. Given the power of plugins and di.xml, its important to note that this interaction is best established using service contracts (the PHP interface).

When the components of the domain layer are being interacted with, they usually make calls to the underlying persistence layer.

The persistence layer is where the data gets persisted. This layer is in charge of all the CRUD (short for create, read, update, and delete) requests. Magento uses an active record pattern strategy for the persistence layer. The model object contains a resource model that maps an object to one or more database rows. Here, it is important to differentiate the cases of simple resource model and the Entity-Attribute-Value (EAV) resource models. A simple resource model maps to a single table, while the EAV resource models have their attributes spread out over a number of MySQL tables. As an example, the Customer and Catalog resource models use EAV resource models, while the newsletter's Subscriber resource model uses a simple resource model.

The top-level filesystem structure

The following list depicts the root Magento filesystem structure:

  • .htaccess
  • .htaccess.sample
  • .php_cs
  • .travis.yml
  • CHANGELOG.md
  • CONTRIBUTING.md
  • CONTRIBUTOR_LICENSE_AGREEMENT.html
  • COPYING.txt
  • Gruntfile.js
  • LICENSE.txt
  • LICENSE_AFL.txt
  • app
  • bin
  • composer.json
  • composer.lock
  • dev
  • index.php
  • lib
  • nginx.conf.sample
  • package.json
  • php.ini.sample
  • phpserver
  • pub
  • setup
  • update
  • var
  • vendor

The app/etc/di.xml file is one of the most important files that we might often look into during development. It contains various class mappings or preferences for individual interfaces.

The var/magento/language-* directories is where the registered languages reside. Though each module can declare its own translations under app/code/{VendorName}/{ModuleName}/i18n/, Magento will eventually fall back to its own individual module named i18n in case translations are not found in the custom module or within the theme directory.

The bin directory is where we can find the magento file. The magento file is a script that is intended to be run from a console. Once triggered via the php bin/magento command, it runs an instance of the Magento\Framework\Console\Cli application, presenting us with quite a number of console options. We can use the magento script to enable/disable cache, enable/disable modules, run an indexer, and do many other things.

The dev directory is where we can find the Magento test scripts. We will have a look at more of those in later chapters.

The lib directory comprises two major subdirectories, namely the server-side PHP library code and fonts found under lib/internal and the client-side JavaScript libraries found in lib/web.

The pub directory is where the publicly exposed files are located. This is the directory that we should set as root when setting up Apache or Nginx. The pub/index.php file is what gets triggered when the storefront is opened in a browser.

The var directory is where the dynamically generated group type of files such as cache, log, and a few others get created in. We should be able to delete the content of this folder at any time and have Magento automatically recreate it.

The vendor directory is where most of the code is located. This is where we can find various third-party vendor code, Magento modules, themes, and language packs. Looking further into the vendor directory, you will see the following structure:

  • .htaccess
  • autoload.php
  • bin
  • braintree
  • composer
  • doctrine
  • fabpot
  • justinrainbow
  • league
  • lusitanian
  • magento
  • monolog
  • oyejorge
  • pdepend
  • pelago
  • phpmd
  • phpseclib
  • phpunit
  • psr
  • sebastian
  • seld
  • sjparkinson
  • squizlabs
  • symfony
  • tedivm
  • tubalmartin
  • zendframework

Within the vendor directory, we can find code from various vendors, such as phpunit, phpseclib, monolog, symfony, and so on. Magento itself can be found here. The Magento code is located under vendor/magento directory, listed (partially) as follows:

  • composer
  • framework
  • language-en_us
  • magento-composer-installer
  • magento2-base
  • module-authorization
  • module-backend
  • module-catalog
  • module-customer
  • module-theme
  • module-translation
  • module-ui
  • module-url-rewrite
  • module-user
  • module-version
  • module-webapi
  • module-widget
  • theme-adminhtml-backend
  • theme-frontend-blank
  • theme-frontend-luma

You will see that the further structuring of directories follows a certain naming schema, whereas the theme-* directory stores themes, the module-* directory stores modules, and the language-* directory stores registered languages.

The module filesystem structure

Magento identifies itself as a highly modular platform. What this means is that there is literally a directory location where modules are placed. Let's take a peak at the individual module structure now. The following structure belongs to one of the simpler core Magento modules—the Contact module that can be found in vendor/magento/module-contact:

  • Block
  • composer.json
  • Controller
  • etc
    • acl.xml
    • adminhtml
      • system.xml
    • config.xml
    • email_templates.xml
    • frontend
      • di.xml
      • page_types.xml
      • routes.xml
    • module.xml
  • Helper
  • i18n
  • LICENSE_AFL.txt
  • LICENSE.txt
  • Model
  • README.md
  • registration.php
  • Test
    • Unit
      • Block
      • Controller
      • Helper
      • Model
  • view
    • adminhtml
    • frontend
      • layout
      • contact_index_index.xml
      • default.xml
    • templates
      • form.phtml

Even though the preceding structure is for one of the simpler modules, you can see that it is still quite extensive.

The Block directory is where the view-related block PHP classes are located.

The Controller directory is where the controller-related PHP classes are stored. This is the code that responds to the storefront POST and GET HTTP actions.

The etc directory is where the module configuration files are present. Here, we can see files such as module.xml, di.xml, acl.xml, system.xml, config.xml, email_templates.xml, page_types.xml, routes.xml, and so on. The module.xml file is an actual module declaration file. We will look into the contents of some of these files in the later chapters.

The Helper directory is where various helper classes are located. These classes are usually used to abstract various store configuration values into the getter methods.

The i18n directory is where the module translation package CSV files are stored.

The Module directory is where the entities, resource entities, collections, and various other business classes can be found.

The Test directory stores the module unit tests.

The view directory contains all the module administrator and storefront template files (.phtml and .html) and static files (.js and .css).

Finally, the registration.php is a module registration file.

Summary

In this chapter, we took a quick look at the technology stack used in Magento. We discussed how Magento, being an open source product, takes extensive use of other open source projects and libraries such as MySQL, Apache, Nginx, Zend Framework, Symfony, jQuery, and so on. We then learned how these libraries are arranged into directories. Finally, we explored one of the existing core modules and briefly took a look at an example of a module's structure.

In the next chapter, we are going to tackle the environment setup so that we can get Magento installed and ready for development.

Left arrow icon Right arrow icon

Key benefits

  • Set up, configure, and power up your Magento environment from development to production
  • Master the use of Web API to communicate with the Magento system and create custom services
  • Create custom modules from scratch to extend the core functionality of the Magento system

Description

Magento is one of the most exciting, flexible, and customizable e-commerce systems. It offers you an extensive suite of powerful tools for creating and managing an online store. After years of development, Magento 2 introduces itself with a strong emphasis on modularity, Web API's, automated testing and overall new technology stack platform.The long-awaited Magento 2 release introduces a whole new e-commerce platform to develop online stores. The all new Magento 2 architecture, Web APIs, and a host of other features are equally challenging to master as much as they are exciting to use. Tshis book will ease the learning curve by offering step-by-step guidance on how to extend the core functionality of your Magento 2 store. This book is your one-stop guide to build and customize a quality e-commerce website from the latest version of one of the largest, fastest growing, and most popular e-commerce platforms—Magento 2. We start off with an introduction to the fundamental concepts of Magento to give you a foundation to work from. We then move on to configure the development and basic production environment for Magento. After this, you’ll get to grips with the major concepts and conventions that are new to the Magento 2 platform. We then delve deeper to get to the core of automated deployments, persisting data, writing data fixture scripts and applying various backend and frontend modifications. As we near the end of the book, you will learn to make API calls and write automated tests. Finally, you will be guided through building a full-blown helpdesk module from scratch. By the end of this book, you will have learned a wide range of techniques to extend and customize your Magento 2 store to fit the requirements of your business.

Who is this book for?

This book is intended primarily for intermediate to professional-level PHP developers who are interested in Magento development. For backend developers, several topics are covered that will enable you to modify and extend your Magento 2 store. Frontend developers will also find some coverage on how to customize the look of the site in the frontend.

What you will learn

  • Set up the development and production environment of Magento 2
  • Understand the new major concepts and conventions used in Magento 2
  • Build a miniature yet fully-functional module from scratch to manage your e-commerce platform efficiently
  • Write models and collections to manage and search your entity data
  • Dive into backend development such as creating events, observers, cron jobs, logging, profiling, and messaging features
  • Get to the core of frontend development such as blocks, templates, layouts, and the themes of Magento 2
  • Use token, session, and Oauth token-based authentication via various flavors of API calls, as well as creating your own APIs
  • Get to grips with testing Magento modules and custom themes, which forms an integral part of development

Product Details

Country selected
Publication date, Length, Edition, Language, ISBN-13
Publication date : Dec 24, 2015
Length: 412 pages
Edition : 1st
Language : English
ISBN-13 : 9781785886584
Vendor :
Magento
Languages :
Concepts :
Tools :

What do you get with a Packt Subscription?

Free for first 7 days. $19.99 p/m after that. Cancel any time!
Product feature icon Unlimited ad-free access to the largest independent learning library in tech. Access this title and thousands more!
Product feature icon 50+ new titles added per month, including many first-to-market concepts and exclusive early access to books as they are being written.
Product feature icon Innovative learning tools, including AI book assistants, code context explainers, and text-to-speech.
Product feature icon Thousands of reference materials covering every tech concept you need to stay up to date.
Subscribe now
View plans & pricing

Product Details

Publication date : Dec 24, 2015
Length: 412 pages
Edition : 1st
Language : English
ISBN-13 : 9781785886584
Vendor :
Magento
Languages :
Concepts :
Tools :

Packt Subscriptions

See our plans and pricing
Modal Close icon
$19.99 billed monthly
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Simple pricing, no contract
$199.99 billed annually
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just $5 each
Feature tick icon Exclusive print discounts
$279.99 billed in 18 months
Feature tick icon Unlimited access to Packt's library of 7,000+ practical books and videos
Feature tick icon Constantly refreshed with 50+ new titles a month
Feature tick icon Exclusive Early access to books as they're written
Feature tick icon Solve problems while you work with advanced search and reference features
Feature tick icon Offline reading on the mobile app
Feature tick icon Choose a DRM-free eBook or Video every month to keep
Feature tick icon PLUS own as many other DRM-free eBooks or Videos as you like for just $5 each
Feature tick icon Exclusive print discounts

Frequently bought together


Stars icon
Total $ 145.97
Magento 2 Cookbook
$48.99
Magento 2 Development Cookbook
$54.99
Magento 2 Developer's Guide
$41.99
Total $ 145.97 Stars icon
Banner background image

Table of Contents

13 Chapters
1. Understanding the Platform Architecture Chevron down icon Chevron up icon
2. Managing the Environment Chevron down icon Chevron up icon
3. Programming Concepts and Conventions Chevron down icon Chevron up icon
4. Models and Collections Chevron down icon Chevron up icon
5. Using the Dependency Injection Chevron down icon Chevron up icon
6. Plugins Chevron down icon Chevron up icon
7. Backend Development Chevron down icon Chevron up icon
8. Frontend Development Chevron down icon Chevron up icon
9. The Web API Chevron down icon Chevron up icon
10. The Major Functional Areas Chevron down icon Chevron up icon
11. Testing Chevron down icon Chevron up icon
12. Building a Module from Scratch Chevron down icon Chevron up icon
Index Chevron down icon Chevron up icon

Customer reviews

Top Reviews
Rating distribution
Full star icon Full star icon Full star icon Half star icon Empty star icon 3.9
(10 Ratings)
5 star 50%
4 star 10%
3 star 20%
2 star 20%
1 star 0%
Filter icon Filter
Top Reviews

Filter reviews by




Daniel Kratohvil Feb 17, 2016
Full star icon Full star icon Full star icon Full star icon Full star icon 5
This is a complete and easy to follow introduction to all the basics of Magento 2. I have really enjoyed reading the book and doing the example module, which is nicely explained and gives you enough insight to tackle any complex requirement. One month before this book was available, I paid $280 for the "Fundamentals of Magento 2 Development" online course offered by Magento, and I wish I would have waited a little longer for this book, since it’s more than enough to grasp the basics, cost much less and doesn’t have errors in the example code like the Magento’s video-tutorial has. I definitely recommend this book to any developer with some previous experience in Magento 1.
Amazon Verified review Amazon
tanghia Feb 03, 2017
Full star icon Full star icon Full star icon Full star icon Full star icon 5
The best book for Magento 2.
Amazon Verified review Amazon
Amazon Customer Dec 30, 2015
Full star icon Full star icon Full star icon Full star icon Full star icon 5
For anyone who is interested in eCommerce, Magento development, or web development in general, you will want to read this book, which covers in depth, the long awaited and highly anticipated Magento 2 platform. I was fortunate enough to have been the technical reviewer for this book and I must say even I'm impressed by the attention to detail and thoroughness of the topics covered. The author Branko Ajzele is as top notch as it gets in the world of eCommerce and the Magento sphere. Branko lays it all out from setting up your local development environments, to unit-testing, to advanced module/extension development. All readers— from frontend to backend developers, from noobs to senior developers & engineers, and even people who are new to the Magento platform will benefit from reading this book in more ways than you can imagine. It will take your skill set to the next level and also put you ahead of the game with other developers.
Amazon Verified review Amazon
Cameron Tudball Feb 07, 2016
Full star icon Full star icon Full star icon Full star icon Full star icon 5
Magento 2 Developer's Guide is exactly what the title indicates: an excellent guide through the logic, file structures and setup of Magento 2 that is firmly aimed at PHP developers. If you are looking for a starting point to understand how Magneto 2 works, and how you can configure and extend Magento to meet your site requirements, then this book is where you should start.None of the topics are covered in depth, which allows this book to provide a firm overview of Magento and yet gives you enough detail that you feel confident exploring topics on your own. The chapter on themes, for example, does not provide you with a step-by-step guide on how to make complex frontends (indeed, such a topic would be its own book). Instead it shows you exactly how themes are structured, which for an experienced developer allows you to understand the overall structure. For me, this was far more useful than a step-by-step tutorial.This is not a guide on how to setup and manage Magento as an eCommerce platform. If you're looking for an introduction to using Magento, then this book is not for you. However if you're fluent in PHP and have a requirement to learn the Magento 2 platform, then this book is exactly what you're looking for.
Amazon Verified review Amazon
Anuwat Soita Oct 16, 2019
Full star icon Full star icon Full star icon Full star icon Full star icon 5
Smart authors. Great Books.
Amazon Verified review Amazon
Get free access to Packt library with over 7500+ books and video courses for 7 days!
Start Free Trial

FAQs

What is included in a Packt subscription? Chevron down icon Chevron up icon

A subscription provides you with full access to view all Packt and licnesed content online, this includes exclusive access to Early Access titles. Depending on the tier chosen you can also earn credits and discounts to use for owning content

How can I cancel my subscription? Chevron down icon Chevron up icon

To cancel your subscription with us simply go to the account page - found in the top right of the page or at https://subscription.packtpub.com/my-account/subscription - From here you will see the ‘cancel subscription’ button in the grey box with your subscription information in.

What are credits? Chevron down icon Chevron up icon

Credits can be earned from reading 40 section of any title within the payment cycle - a month starting from the day of subscription payment. You also earn a Credit every month if you subscribe to our annual or 18 month plans. Credits can be used to buy books DRM free, the same way that you would pay for a book. Your credits can be found in the subscription homepage - subscription.packtpub.com - clicking on ‘the my’ library dropdown and selecting ‘credits’.

What happens if an Early Access Course is cancelled? Chevron down icon Chevron up icon

Projects are rarely cancelled, but sometimes it's unavoidable. If an Early Access course is cancelled or excessively delayed, you can exchange your purchase for another course. For further details, please contact us here.

Where can I send feedback about an Early Access title? Chevron down icon Chevron up icon

If you have any feedback about the product you're reading, or Early Access in general, then please fill out a contact form here and we'll make sure the feedback gets to the right team. 

Can I download the code files for Early Access titles? Chevron down icon Chevron up icon

We try to ensure that all books in Early Access have code available to use, download, and fork on GitHub. This helps us be more agile in the development of the book, and helps keep the often changing code base of new versions and new technologies as up to date as possible. Unfortunately, however, there will be rare cases when it is not possible for us to have downloadable code samples available until publication.

When we publish the book, the code files will also be available to download from the Packt website.

How accurate is the publication date? Chevron down icon Chevron up icon

The publication date is as accurate as we can be at any point in the project. Unfortunately, delays can happen. Often those delays are out of our control, such as changes to the technology code base or delays in the tech release. We do our best to give you an accurate estimate of the publication date at any given time, and as more chapters are delivered, the more accurate the delivery date will become.

How will I know when new chapters are ready? Chevron down icon Chevron up icon

We'll let you know every time there has been an update to a course that you've bought in Early Access. You'll get an email to let you know there has been a new chapter, or a change to a previous chapter. The new chapters are automatically added to your account, so you can also check back there any time you're ready and download or read them online.

I am a Packt subscriber, do I get Early Access? Chevron down icon Chevron up icon

Yes, all Early Access content is fully available through your subscription. You will need to have a paid for or active trial subscription in order to access all titles.

How is Early Access delivered? Chevron down icon Chevron up icon

Early Access is currently only available as a PDF or through our online reader. As we make changes or add new chapters, the files in your Packt account will be updated so you can download them again or view them online immediately.

How do I buy Early Access content? Chevron down icon Chevron up icon

Early Access is a way of us getting our content to you quicker, but the method of buying the Early Access course is still the same. Just find the course you want to buy, go through the check-out steps, and you’ll get a confirmation email from us with information and a link to the relevant Early Access courses.

What is Early Access? Chevron down icon Chevron up icon

Keeping up to date with the latest technology is difficult; new versions, new frameworks, new techniques. This feature gives you a head-start to our content, as it's being created. With Early Access you'll receive each chapter as it's written, and get regular updates throughout the product's development, as well as the final course as soon as it's ready.We created Early Access as a means of giving you the information you need, as soon as it's available. As we go through the process of developing a course, 99% of it can be ready but we can't publish until that last 1% falls in to place. Early Access helps to unlock the potential of our content early, to help you start your learning when you need it most. You not only get access to every chapter as it's delivered, edited, and updated, but you'll also get the finalized, DRM-free product to download in any format you want when it's published. As a member of Packt, you'll also be eligible for our exclusive offers, including a free course every day, and discounts on new and popular titles.