The document outlines various approaches to managing Magento projects, including the use of Composer for dependency management and module installation. It discusses requirements for modular design, sharing, and version control while highlighting the benefits of using tools like modman and community-driven initiatives such as the Magento Composer Installer. Additionally, it touches upon package management, installation strategies, and mentions practical patterns for developers working with Magento modules.

1. Wiring Magento Projects
Magento Fireside Chat
Google+ Hangout - March 20, 2014

2. Intro – Fabrizio Branca (@fbrnc)
Composer – Fabrizio Branca (@fbrnc)
Magento Composer Installer – Bastian Ike (@b_ike)
Lightweight approach – Fabrizio Branca (@fbrnc)
Experimental approach – Daniel Fahlke (@flyingmana)
Different approach – Rolando Granadino (@beeplogic)
Ben’s approach – Ben Marks (@benmarks)
? – You!
Q&A
Agenda

3. the problem
Intro

4. htdocs
<Name>
<theme>
layout
template
code
design
etc
locale
<area>
core
community
local
<area>
<language>
modules
<package>
<Namespace>
<package>
*.xml
*.csv
<theme>
app
skin
lib
Module2
default
layout
template
code
design
etc
locale
frontend
local
frontend
de_DE
modules
base
My
base
My_Module2.xml
My_Module2.csv
default
app
skin
etc, Block, …
js, css, img, …
my_module2
my_module2
Magento My_Module
My_Module2
Module
default
layout
template
code
design
etc
locale
frontend
local
frontend
de_DE
modules
base
My
base
My_Module.xml
My_Module.csv
default
app
skin
etc, Block, …
js, css, img, …
my_module
my_module

5. htdocs
Module
default
layout
template
code
design
etc
locale
local
frontend
de_DE
modules
My
base
*.xml
app
My_Module2.xml
My_Module2.csv
my_module2
My_Module.xml
My_Module.csv
etc, Block, …
my_module
Module2
etc, Block, …
my_module2
my_module

6. Magento 2

8. pub
Module
code
My
app
Magento
My_Module
My_Module2
view
Controller
etc
i18n
Block
…
Module2
view
Controller
etc
i18n
Block
…
Magento 2

9. the requirements
Intro

10. • Reuse modules
• Share modules
• Easy and clean uninstall without leftovers
• Non-destructive (no deletion of files)
• Clean Magento vanilla code
• Work collaboratively on projects
• Restrict access to modules for team members
• Independent versioning scheme of modules
• Independent version control origin
the requirements

11. a solution
Intro

12. modman
by @colinmollenhour

13. htdocs
code
core
community
local
app
app/code/…/My/Module
.modman
My_Module
app/design/…
skin/frontend/…
app/etc/modules/My_Module.xml
modman
app/code/…/My/Module
My_Module2
app/design/…
skin/frontend/…
app/etc/modules/My_Module.xml
modman
<theme>
layout
template
design
etc
locale
<area>
<language>
modules
<package>
*.xml
modman

14. “wiring”
Intro
modman “connects” existing modules to the Magento core,
but how do we manage them?

15. htdocs
code
core
community
local
app
app/code/…/My/Module
.modman
My_Module
app/design/…
skin/frontend/…
app/etc/modules/My_Module.xml
modman
app/code/…/My/Module
My_Module2
app/design/…
skin/frontend/…
app/etc/modules/My_Module.xml
modman
<theme>
layout
template
design
etc
locale
<area>
<language>
modules
<package>
*.xml
Components
tools
n98-magerun.phar
phpunit.phar
modman
EnvSettingsTool
composer.phar
htdocs
.modman
Configuration
Installer
(Metadata, Doc,…)
My_Module
My_Module2
app,…
and usually there’s
even more stuff…
These should come
from different origins

16. svn:externals
Git submodules
Phing/Ant
Custom scripts
Composer
Components
Options
works fine, but needs
some getting used to it

17. Composer
Intro
in a nutshell…

18. Composer“Composer is a tool for dependency management in PHP. It allows you to declare
the dependent libraries your project needs and it will install them in your project
for you.”
phar file
json configuration
supports Git, SVN, tar,…
and mix’n’match
package
management
Dependency management
(including fine-grained
control over specific versions,…)
Autoloader

19. theHackathon installer approach
Approach

20. Magento Composer
Installer

21. Overview
• Aims to provide an easy way to install Magento
modules via composer (instead of e.g. modman)
• Community driven, initial started by the Magento
Hackathon
• Main component: magento-hackathon/magento-
composer-installer

22. Components
• Magento Composer installer
• Package repository
• Compatible with package.xml, modman and
manual file mapping paths
• Possible to bootstrap the Magento core, but not
recommended

23. Using Magento+Composer
{
"minimum-stability": "dev",
"require": {
"fbrnc/aoe_templatehints": "*"
},
"repositories": [
{
"type": "composer",
"url": "http://packages.firegento.com"
}
],
"extra": {
"magento-root-dir": "htdocs/",
"auto-append-gitignore": true
}
}

24. Using Magento+Composer
{
"minimum-stability": "dev",
"require": {
"fbrnc/aoe_templatehints": "*"
},
"repositories": [
{
"type": "composer",
"url": "http://packages.firegento.com"
}
],
"extra": {
"magento-root-dir": "htdocs/",
"auto-append-gitignore": true
}
}
Include dev-versions,
not just final releases

25. Using Magento+Composer
{
"minimum-stability": "dev",
"require": {
"fbrnc/aoe_templatehints": "*"
},
"repositories": [
{
"type": "composer",
"url": "http://packages.firegento.com"
}
],
"extra": {
"magento-root-dir": "htdocs/",
"auto-append-gitignore": true
}
}
List of required packages
with the required version
* = newest version
!
!
See composer manual for
version syntax

26. Using Magento+Composer
{
"minimum-stability": "dev",
"require": {
"fbrnc/aoe_templatehints": "*"
},
"repositories": [
{
"type": "composer",
"url": "http://packages.firegento.com"
}
],
"extra": {
"magento-root-dir": "htdocs/",
"auto-append-gitignore": true
}
}
Include the Firegento
Package Repository

27. Using Magento+Composer
{
"minimum-stability": "dev",
"require": {
"fbrnc/aoe_templatehints": "*"
},
"repositories": [
{
"type": "composer",
"url": "http://packages.firegento.com"
}
],
"extra": {
"magento-root-dir": "htdocs/",
"auto-append-gitignore": true
}
}
Installation-specific
configuration

28. extra
• magento-root-dir: Where your Magento installation lives
• magento-deploystrategy:
• symlink: symlink into Magento
• link: hardlink into Magento
• copy: copy the files instead of linking
• none: no automatic deployment, if you want to use e.g. modman
• auto-append-gitignore: add deployed files to .gitignore in the Magento folder
• modman-root-dir: Use e.g. .modman/ instead of vendor/

29. composer install

30. Publishing packages
• Add a composer.json to your extension
• Publish your extension on github
• Add it to packages.firegento.com

31. composer.json
{
"name": "fbrnc/Aoe_TemplateHints",
"license": "OSL-3.0",
"type": "magento-module",
"description": "Advanced Template Hints for Magento",
"homepage": "http://www.fabrizio-branca.de/magento-advanced-template-
hints-20.html",
"require": {
"magento-hackathon/magento-composer-installer": "*"
},
"authors":[
{
"name":"Fabrizio Branca",
"email":"mail@{firstname}-{lastname}.de"
}
]
}

32. composer.json
{
"name": "fbrnc/Aoe_TemplateHints",
"license": "OSL-3.0",
"type": "magento-module",
"description": "Advanced Template Hints for Magento",
"homepage": "http://www.fabrizio-branca.de/magento-advanced-template-
hints-20.html",
"require": {
"magento-hackathon/magento-composer-installer": "*"
},
"authors":[
{
"name":"Fabrizio Branca",
"email":"mail@{firstname}-{lastname}.de"
}
]
}
Metadata:
Author, Website, etc

33. composer.json
{
"name": "fbrnc/Aoe_TemplateHints",
"license": "OSL-3.0",
"type": "magento-module",
"description": "Advanced Template Hints for Magento",
"homepage": "http://www.fabrizio-branca.de/magento-advanced-template-
hints-20.html",
"require": {
"magento-hackathon/magento-composer-installer": "*"
},
"authors":[
{
"name":"Fabrizio Branca",
"email":"mail@{firstname}-{lastname}.de"
}
]
}
type: magento-module
!
This line activates the
magento-composer-installer
during composer install

34. composer.json
{
"name": "fbrnc/Aoe_TemplateHints",
"license": "OSL-3.0",
"type": "magento-module",
"description": "Advanced Template Hints for Magento",
"homepage": "http://www.fabrizio-branca.de/magento-advanced-template-
hints-20.html",
"require": {
"magento-hackathon/magento-composer-installer": "*"
},
"authors":[
{
"name":"Fabrizio Branca",
"email":"mail@{firstname}-{lastname}.de"
}
]
}
Requirements

35. composer.json
{
"name": "fbrnc/Aoe_TemplateHints",
"license": "OSL-3.0",
"type": "magento-module",
"description": "Advanced Template Hints for Magento",
"homepage": "http://www.fabrizio-branca.de/magento-advanced-template-
hints-20.html",
"require": {
"magento-hackathon/magento-composer-installer": "*"
},
"authors":[
{
"name":"Fabrizio Branca",
"email":"mail@{firstname}-{lastname}.de"
}
]
}
Involved Authors

36. Package Repository
{ "type": "vcs", "url": "git://github.com/colinmollenhour/
Cm_Cache_Backend_Mongo.git" },
{ "type": "vcs", "url": "git://github.com/colinmollenhour/
Cm_Cache_Backend_Redis.git" },
{ "type": "vcs", "url": "git://github.com/colinmollenhour/Cm_RedisSession.git" },
{ "type": "vcs", "url": "git://github.com/colinmollenhour/Cm_Diehard.git" },
{ "type": "vcs", "url": "git://github.com/fbrnc/Aoe_Scheduler.git" },
{ "type": "vcs", "url": "git://github.com/fbrnc/Aoe_Profiler.git" },
{ "type": "vcs", "url": "git://github.com/fbrnc/Aoe_TemplateHints.git" },
{ "type": "vcs", "url": "git://github.com/fbrnc/Aoe_ReuseImages.git" },
{ "type": "vcs", "url": "git://github.com/fbrnc/Aoe_ManageStores.git" },
Add your Repository
to satis.json and open
a pull request
https://github.com/magento-hackathon/composer-repository/

37. Package.xml? modman?
JSON-mapping
• package.xml: Used by Magento Connect
• modman: Used by modman, imho best solution.
No support for shell scripts!
• json-mapping:
"map": [
["themes/default/skin", "public/skin/frontend/foo/default"],
["themes/default/design", "public/app/design/frontend/foo/default"],
["modules/My_Module/My_Module.xml", "public/app/etc/modules/My_Module.xml"],
["modules/My_Module/code", "public/app/code/local/My/Module"],
["modules/My_Module/frontend/layout/mymodule.xml", "public/app/design/frontend/base/default/
layout/mymodule.xml"]
]

38. That's it :)

39. Links
• https://getcomposer.org/
• https://github.com/magento-hackathon/magento-
composer-installer/
• https://github.com/magento-hackathon/composer-
repository/
• http://packages.firegento.com/
• http://magebase.com/magento-tutorials/composer-
with-magento/

40. Fabrizio’s lightweightapproach
Approach
@fbrnc

41. Keeping it Simple!

42. AOEpeople/composer-installers
"replace": { "magento-hackathon/magento-composer-installer":"*" }
“inspired” by
composer/installers
“magento-module” “magento-source”
handles package types

43. <?php
namespace AoepeopleComposerInstallers;
class MagentoInstaller extends BaseInstaller
{
protected $locations = array(
'module' => '.modman/{$name}/',
'source' => 'htdocs/'
);
}
AOEpeople/composer-installers

44. • Fully compatible with magento-hackathon/magento-composer-installer
• Adds support for type “magento-source”
• Only puts packages into place
• Native modman script is used to deploy modules
• Wrapped in a simple installer script
AOEpeople/composer-installers

45. {
{
"minimum-stability":"dev",
"require":{
"aoepeople/composer-installers": "*",
"fbrnc/aoe_scheduler": "*",
"fbrnc/aoe_cachecleaner": "*",
"aoemedia/magento_enterprise": "1.13.1.0",
"aoemedia/envsettingstool": "*"
},
"config": {
"bin-dir": "bin"
}
}
AOEpeople/composer-installers
replaces
Hackathon
Installer
some
modules
Vanilla
Magento
Source
Tools,…

46. htdocs
code
core
community
local
app
app/code/…/My/Module
.modman
My_Module
app/design/…
skin/frontend/…
app/etc/modules/My_Module.xml
modman
app/code/…/My/Module
My_Module2
app/design/…
skin/frontend/…
app/etc/modules/My_Module.xml
modman
<theme>
layout
template
design
etc
locale
<area>
<language>
modules
<package>
*.xml
Components

47. Build
Workflow
Unit Tests,…
• git clone
• Add some metadata (build
number, master system,
package type)
• (Run Composer)
• (Run modman)
• Packaging
• Tagging

48. Deployment & Installation
Workflow
Update local
copy of the
“systemstorage”
Move files to
new release
folder
Download build
package from
Jenkins
Extract build
package
Run installer
Create symlinks
to var/ and
media/
Is
master
?
Import
systemstorage
(db and media/)
Run Composer Run modman
Apply settings Fix permissions
Update
symlinks
Delete old
releases
install.sh
deploy.sh

49. Directory layoutvar
var
<projectName>
releases
<environmentName>
shared
www
media
build_117
build_118
build_119
.modman
htdocs
Configuration
tools
install.sh
app,…
var
media
previous
latest
current
next
My_Module
My_Module2
Webroot:
/var/www/<projectName>/<environmentName>/current/htdocs

50. Daniel’s experimental approach
Approach
@Flyingmana

51. http://flyingmana.name/slides/magento-wizards_fugue-introduction.html

52. Rolando’s different approach
Approach
@beeplogic

53. http://slid.es/beeplogic/magesync

54. Ben’s approach
Approach
@benmarks

55. Thank you!
Any questions?

56. http://www.youtube.com/watch?v=bscXyCy4fHc
Watch the recording!