forked from magento/devdocs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
New draft of introduction to PHP Developer's Guide. You know you can'…
…t wait to read it. For perspective on the new introduction please see the updated outline on the Magento wiki
- Loading branch information
Showing
7 changed files
with
92 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -130,3 +130,5 @@ PLATFORMS | |
|
||
DEPENDENCIES | ||
github-pages | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters