Skip to content

Commit

Permalink
New draft of introduction to PHP Developer's Guide. You know you can'…
Browse files Browse the repository at this point in the history
…t wait to read it. For perspective on the new introduction please see the updated outline on the Magento wiki
  • Loading branch information
tdobbs committed Jun 26, 2015
1 parent 873ba27 commit 9a76ba5
Show file tree
Hide file tree
Showing 7 changed files with 92 additions and 5 deletions.
2 changes: 1 addition & 1 deletion Gemfile
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
gem 'github-pages'
source 'https://rubygems.org'
source 'https://rubygems.org'
2 changes: 2 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -130,3 +130,5 @@ PLATFORMS

DEPENDENCIES
github-pages


6 changes: 3 additions & 3 deletions guides/v1.0/extension-dev-guide/Contribute_edg.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
layout: default
group: extension-dev-guide
subgroup: A_Introduction
group: Contributor Guide
subgroup:
title: Contribute to Magento DevDocs!
menu_title: Contribute to Magento DevDocs!
menu_order: 1
menu_order: 100

---

Expand Down
14 changes: 14 additions & 0 deletions guides/v1.0/extension-dev-guide/build_a_simple_module.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
layout: default
group:
subgroup:
title: PHP Developer Guide Build A Simple Module
menu_title: Build a Module
menu_order: 1
github_link: extension-dev-guide/build_a_simple_module.md

---



build_a_simple_module
59 changes: 59 additions & 0 deletions guides/v1.0/extension-dev-guide/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
layout: default
group:
subgroup:
title: PHP Developer Guide Introduction
menu_title: Introduction
menu_order: 1
github_link: extension-dev-guide/introduction.md

---


##Introduction

This guide is for developers that need to modify or customize an existing Magento module, or are building a new module from scratch either for custom extension of Magento functionality. This guide is also for those who want to create an extension for Magento Connect, although it does not cover the publishing process.


##Magento is made up of components:

* Modules
* Libraries
* Themes
* Language packages


A Magento **module** is a discrete chunk of code that accomplishes a particular business function or handles a Magento feature. They are typically a collection .php and .xml files, and the bulk of your work in modules will be in these files. Modules are interactive with each other. A module also contains the user interface required for a user’s interaction with the module. Themes can be applied to the module to change its appearance. So when you are building a module, you may also touch themes and language packs.

A **package** is a module that is wrapped up in a distributable form. Usually you will use Composer to do this. This can be released on

An **extension** is a module that is packaged for sale on Connect.


<div class="bs-callout bs-callout-info" id="info">
<p>You must follow a PSR compliant structure when building a module.</p>
</div>


##Magento module example

At the very minimum, a Magento module could simply be an XML file:

<?xml version="1.0"?>
<!--
/**
* @copyright Copyright (c) 2015 X.commerce, Inc. (http://www.magentocommerce.com)
*/
-->
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../../../lib/internal/Magento/Framework/Module/etc/module.xsd">
<module name="Magento_SampleMinimal" setup_version="2.0.0">
</module>
</config>


##What's Next?

Get your feet wet quickly and build <a href="{{ site.gdeurl }}extension-dev-guide/build_a_simple_module.html">a simple Magento module</a>.

Or jump right away into your eyeballs and use <a href="{{ site.gdeurl }}extension-dev-guide/worksheet.html">a worksheet</a> that steps you through a complete best practice method to build, test, and package a Magento module.

12 changes: 12 additions & 0 deletions guides/v1.0/extension-dev-guide/worksheet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: default
group:
subgroup:
title: PHP Developer Guide Module Worksheet
menu_title: Module Worksheet
menu_order: 1
github_link: extension-dev-guide/build_a_simple_module.md

---

#Module Worksheet
2 changes: 1 addition & 1 deletion guides/v1.0/template.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
layout: default
group: extension-dev-guide
group:
subgroup: A_Introduction
title: template (generic)
menu_title: template (generic)
Expand Down

0 comments on commit 9a76ba5

Please sign in to comment.