Manipulating Magento - Meet Magento Netherlands 2018

Manipulating Magento - Meet Magento Netherlands 2018

• 1.
  MANIPULATING MAGENTO Make itdo what you want PHP developer at Joke Puts - @jokeputs
• 2.
  Goal Bug free andfuture proof customizations
• 3.
  How Keep the interactionswith the core to a minimum
• 4.
  Topics • Preferences • Plugins •Observers • Cases
• 5.
  PREFERENCE Replacing behavior throughdependency injection
• 6.
  Dependency injection “Dependency injectionis the concept of the external environment injecting dependencies for an object instead of that object manually creating them internally.”
• 7.
  Dependency injection • Constructorinjection • Object manager
• 8.
  MagentoQuoteModelQuoteAddressValidator public function __construct( AddressRepositoryInterface$addressRepository, CustomerRepositoryInterface $customerRepository, Session $customerSession ) { $this->addressRepository = $addressRepository; $this->customerRepository = $customerRepository; $this->customerSession = $customerSession; }
• 9.
  Interfaces • API directory •Service contract • (Relatively) stable across upgrades
• 10.
  MagentoFrameworkObjectManagerObjectManager public function create( $type,array $arguments = [] ) { $type = ltrim($type, ''); return $this->_factory->create( $this->_config->getPreference($type), $arguments ); }
• 11.
  di.xml <preference for="MagentoCustomerApiDataCustomerInterface" type="MagentoCustomerModelDataCustomer" />
• 12.
  module.xml <module name="Namespace_Module" setup_version="1.0.0"> <sequence> <module name="Magento_Customer"/> </sequence> </module>
• 13.
  <module name="PHPro_AModule" setup_version="1.0.0"> <sequence> <module name="Magento_Customer"/> </sequence> </module> <modulename="PHPro_ZModule" setup_version="1.0.0"> <sequence> <module name="Magento_Customer"/> </sequence> </module>
• 14.
  PLUGINS Adding and modifyingbehavior before, after and around
• 15.
  Plugin “A plugin isa class that modifies the behavior of public class functions by running code before, after or around that function call.”
• 16.
  di.xml <type name="MagentoCatalogModelResourceModelCate gory"> <plugin name="category_delete_plugin" type="MagentoCatalogUrlRewriteModelCat egoryPluginCategoryRemove"/> </type>
• 17.
  Before • Runs beforethe method • Modify the arguments of the method • Return null to indicate that the arguments haven’t changed
• 18.
  Before public function beforeSetName( Product$subject, $name ) { // Do something }
• 19.
  After • Runs afterthe method • Modify the output of the method • Should have a return value • Since 2.2: Access to arguments of the method
• 20.
  After public function afterGetName( Product$subject, $result ) { // Do something return $result; }
• 21.
  Around • Runs bothbefore and after the method • Modify the entire method • Modify arguments and output • Receives a callable
• 22.
  Around public function aroundUpdateData( Address$subject, callable $proceed, AddressInterface $address ) { // Do something $result = $proceed($address); // Do something return $result; }
• 23.
  Not calling thecallable ✖Other around plugins (sort order) ✖Other after plugins (sort order) ✖Original method
• 24.
  Call order priororiginal 1. Sort order from low to high 2. Order of the uasort() array 3. Before plugins 4. Around plugins (before calling the callable)
• 25.
  Plugin A withsort order 1: around Call order prior original Plugin A with sort order 1: before Plugin B with sort order 0: around Plugin C with sort order 0: before
• 26.
  Plugin B withsort order 0: around Call order prior original Plugin A with sort order 1: before Plugin A with sort order 1: around Plugin C with sort order 0: before
• 27.
  Plugin A withsort order 1: around Plugin B with sort order 0: around Call order prior original Plugin A with sort order 1: before Plugin C with sort order 0: before
• 28.
  Call order postoriginal 1. Sort order from high to low* 2. Reversed order of the uasort() array 3. Around plugins (after calling the callable) 4. After plugins * Only if an around plugin exists
• 29.
  Plugin A withsort order 1: around Plugin B with sort order 0: around Call order post original Plugin D with sort order 1: after Plugin B with sort order 0: after
• 30.
  Plugin A withsort order 1: around Plugin B with sort order 0: around Call order post original Plugin D with sort order 1: after Plugin B with sort order 0: after
• 31.
  Plugin A withsort order 1: around Plugin B with sort order 0: around Call order post original Plugin D with sort order 1: after Plugin B with sort order 0: after
• 32.
  PHPro/AModule/etc/di.xml à afterplugin <type name="MagentoStoreModelAddressRenderer"> <plugin name="renderer_a" type="PHProAModulePluginRenderer" sortOrder="10"/> </type> PHPro/ZModule/etc/di.xml à after plugin <type name="MagentoStoreModelAddressRenderer"> <plugin name="renderer_z" type="PHProZModulePluginRenderer" sortOrder="20"/> </type>
• 33.
  OBSERVERS Modifying data andrunning new behavior
• 34.
  Observers “Observers are executedwhenever the event they are configured to watch is dispatched by the event manager.”
• 35.
  MagentoCustomerModelSession public function setCustomerAsLoggedIn($customer) { $this->setCustomer($customer); $this->_eventManager->dispatch( 'customer_login', ['customer' =>$customer] );
• 36.
  events.xml <event name="customer_login"> <observer name="wishlist" instance="MagentoWishlistObserver CustomerLogin"/> </event>
• 37.
  MagentoWishlistObserverCustomerLogin class CustomerLogin implements ObserverInterface { publicfunction execute( Observer $observer ) { $this->wishlistData->calculate(); } }
• 38.
  Events • Find eventsin the core • Look at the passed data • $observer->getEvent() ->get{key}()
• 39.
  Model events • {event_prefix}_load_before •{event_prefix}_load_after • {event_prefix}_save_before • {event_prefix}_save_after • {event_prefix}_delete_before • {event_prefix}_delete_after • {event_prefix}_save_commit_after • {event_prefix}_delete_commit_after • {event_prefix}_clear
• 40.
  Model events • ExtendMagentoFrameworkModel AbstractModel • Set $_eventPrefix • Set $_eventObject
• 41.
  Collection events • {event_prefix}_load_before •{event_prefix}_load_after
• 42.
  Collection events • ExtendMagentoFrameworkModel ResourceModelDbCollection AbstractCollection • Set $_eventPrefix • Set $_eventObject
• 43.
  Controller events • controller_action_predispatch_{route_name} •controller_action_predispatch_{full_action_name} • controller_action_postdispatch_{full_action_name} • controller_action_postdispatch_{route_name}
• 44.
  Controller events • Extend MagentoFrameworkAppAction Action
• 45.
  Dispatch order 1. Observersin the global area a. Module sequence order b. Order in events.xml 2. Observers in adminhtml or frontend area a. Module sequence order b. Order in events.xml
• 46.
  PHPro/AModule/etc/adminhtml/events.xml <event name="sales_order_save_after"> <observer name="phpro_a_order_save" instance="PHProAModuleObserverAfterOrderSa ve"/> </event> PHPro/ZModule/etc/events.xml <event name="sales_order_save_after"> <observer name="phpro_z_order_save" instance="PHProZModuleObserverAfterOrderSa ve" /> </event>
• 47.
  RECAP What should Iuse?
• 48.
  Preferences Replace behavior
• 49.
  Preferences • (+) Replaceentire class or interface implementation • (-) Only one preference can be active • (-) Replace entire class to replace one line of code
• 50.
  Plugins Add and modifybehavior
• 51.
  Plugins • (+) Manipulatebehavior before, after and around one method • (+) Access to arguments and output • (+) Multiple plugins for one method • (-) Only public methods
• 52.
  Observers Modify data andstart new behavior
• 53.
  Observers • (+) Multipleobservers for one event can be active • (-) Event has to exist • (-) Only access to the passed data
• 54.
  CASES Enough with thetheory…
• 55.
  Case #1 Modify theJSON response from an external module
• 58.
  Case #2 Call anexternal service when an order reaches the state “complete”
• 62.
  Case #3 Redirect toa store view based on the customer’s location (full page cache)
• 67.
  Case #4 Customers arenot stored in Magento and should be accessed using an external service
• 69.
  Case #5 Change thestore address template in an e-mail template
• 74.
  Questions?