magento 2 creating a custom module fluid digitalmagento 2 creating a custom module matt edwards...

fluid-digital.com @fluid_digital

Magento Ecommerce Agency

Magento2CreatingACustomModule

MattEdwardsTechnicalDirectorFluidDigital

@fluid_digitalfluid-digital.com

Magento1vsMagento2

ModuleFileStructure


CreatinganewModule

Moduledirectory:app/code/Company/ModuleName


RegisterYourModule

Registeryourmodule:registration.php


StartAddingInRequiredDirectories


Addetc/module.xml

ModuleName:Fluid_BlogVersionNumber:1.0.2


SetupandUpgradeScripts

Setup/InstallSchema.php - initialmodulesetupscriptSetup/UpgradeSchema.php – usedforanymoduleupgrades


CreatingYourPages

URLstructureforM2iscontrolledbythedirectoryname,filenameandthefrontName setinetc/frontend/routes.xml

/blog/index/index(or/blog)/blog/categories/index(or/blog/categories)


Creatingthelayout

Eachpageneeds itsownlayoutXMLfile

ThelayoutXMLfilenamesmatchthepreviouslysetURLstructurebutwithunderscoresusedforseparators

frontName_directoryName_controllerName.xml

blog_index_index.xml - usedforthebloglandingpage• frontName – blog• Directory– Index• FileName – Index.php

blog_article_view.xml – usedforthearticlespecificpage• frontName - blog• Directory– Article• FileName – View.php


LayoutXMLFile


BlockFiles

JustasinMagento1,blockfilescontainfunctions thatareaccessibletotheviewfiles

Theyareusedasaconnectionbetweentheviewandthemodels

HencetheearliertermusedtodescribethedesignpatternMVVM-ModelViewViewModel


ModelsModelsinMagento2areverysimilartoMagento1andprovideyouwithCRUDfunctionalityCreate-read-update-delete

Requiredfilesareasfollows:

Model/ModelName.phpModel/Resource/ModelName.phpModel/Resource/ModelName/Collection


TemplateFiles

Frontend templatefilesliveinview/frontend/templatedirectory

PrettymuchthesameaMagento1


WebFiles(CSS,JS&Images)CSS,JSandimagefilesforamodulearestoredinthedirectory:view/frontend/web/

cssjsimages

LikeMagento1theseareaddedtothepageinthelayoutXMLfileexceptthesyntaxisslightlydifferent


FrontendPreview/blog


Composer

ComposerallowsyoutoeasilymanagepackagesinMagento

InstallMagento2veryeasilywiththefollowingcommand:composercreate-project--repository-url=https://repo.magento.com/magento/project-community-edition.

Allowsindividualmodules tobeeasilyadded, removedorupgrade

UpgradeMagento2versionbysimplyediting therootcomposer.json filethenrunning composerupdate


Howdoescomposertieintoourmodule

Weneed toaddtoourmoduleacomposer.json file

Thisneedstobeaddedtothemodule rootdirectory

Easilyinstallandupdateourmodulecomposer requirefluid/blogcomposerupdate

ConnectstoexternalVCSsuchasgithub

fluid-digital.com @fluid_digital

Magento Ecommerce Agency

Questions?

magento 2 creating a custom module fluid digitalmagento 2 creating a custom module matt edwards...

Documents