Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nans/magestudy
Magento 2 extension samples
https://github.com/nans/magestudy
cron-tasks crud example grid magento-2 magento2 magento2-extension magento2-module phpunit samples
Last synced: 2 months ago
JSON representation
Magento 2 extension samples
- Host: GitHub
- URL: https://github.com/nans/magestudy
- Owner: nans
- License: mit
- Created: 2017-06-27T12:19:52.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-05-09T21:38:15.000Z (over 3 years ago)
- Last Synced: 2024-10-14T06:02:14.281Z (2 months ago)
- Topics: cron-tasks, crud, example, grid, magento-2, magento2, magento2-extension, magento2-module, phpunit, samples
- Language: PHP
- Homepage:
- Size: 455 KB
- Stars: 69
- Watchers: 6
- Forks: 40
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Magestudy - Magento 2 Example extensions
Tested on version 2.3.5
Branch for [Magento 2.1 - 2.3](https://github.com/nans/Magestudy/tree/2.1-2.3)
Master branch for Magento 2.3
## Installation Instruction
* Copy the content of the repo to the Magento 2: app/code/Magestudy
* Run command: php bin/magento setup:upgrade
* Run Command: php bin/magento cache:flush
(On installing on Magento 2.2 need to uncomment rows at Magestudy\ProductExtensionAttribute\Setup\InstallData.php)
## SimpleCrud
Shows how create simple CRUD: grid and form (ui component) without deprecated methods
## ConfigExample
Shows how create and update Configuration in Magento 2 (programmatically)
Admin panel: Menu - Stores - Settings - Configuration - Magestudy example
## ConsoleCommand
Shows how create console command in Magento 2
Command 1: magestudy:first_test_command
Command 2: magestudy:fullname FirstName LastName
## Controller
Shows how create controller in Magento 2
Links:
yourDomain/index.php/controller/hello
yourDomain/index.php/controller/hello/world
yourDomain/index.php/controller/test
yourDomain/index.php/controller/test/check
## CronExample
Shows how to create Cron tasks and Cron groups in Magento 2
Result in /var/log/.debug.log: "Cron task was started at ..."
Answer on question: How are scheduled jobs configured?
## Event
Shows how use events in Magento 2
[Documentation](https://devdocs.magento.com/guides/v2.3/extension-dev-guide/events-and-observers.html)
Links:
yourDomain/index.php/event/example/index
yourDomain/index.php/event/example/second
## LogRepository
Shows how use repository pattern in Magento 2
## Menu
Shows how create menu in Magento 2 admin panel
Admin panel: Menu - MAIN LABEL
## Page
Shows how create simple page (frontend) in Magento 2
Link: http:://YOUR_SITE.domain/index.php/page/test/
## Rest
Shows how create REST API in Magento 2
Links for test in \Magestudy\Rest\Model\Shop.php
## UnitTestExample
Shows how create Unit test in Magento 2
In \dev\tests\unit\phpunit.xml (remove .dist if file name is phpunit.xml.dist)
Add line: ../../../app/code/Magestudy/UnitTestExample/Test/Unit
To block: testsuite
Run command in console:
* Go to magento directory (like: cd /home/admin/web/mage23.local/public_html/dev/tests/unit)
* Run command: php ../../../vendor/phpunit/phpunit/phpunit
## Customjs
Shows how use RequireJS and Knockout.js (bindings) in Magento 2
Result in console: yourDomain/index.php/customjs/test
Frontend: yourDomain/index.php/customjs/test/simple
## Crud
Admin panel: Menu - CRUD
Frontend, url: yourDomain/index.php/crud
#### Shows how create CRUD in Magento 2:
- Validation;
- Image loading;
- Table relations;
- UI Component;
- Event;
- Custom form validation;
- Highlight rows in grid;
- Create DB schema;
- Admin menu;
- Repository pattern.
**Note, this module contains a lot of unnecessary abstractions for Adminhtml controllers.
SimpleCrud extension has simple and clean controllers.**
## PluginExample
#### Commands for test:
magestudy:get_product
magestudy:save_product
magestudy:set_product_price
magestudy:set_product_title
magestudy:set_product_image
###Cases:
Login as customer adds next message: "This text added before customer authenticate."
Create new customer: "This text added after customer create account."
## CustomerAttribute - Customer
Shows how add new customer (custom) attribute to grid and create/edit form.
## AddCustomerAddressField
Answer on question: How do you add another field to the customer address entity using a setup script?
## SystemCustomField
Shows how add custom fields in Stores->Settings->Configuration
Backend: Stores -> Settings -> Configuration -> Magestudy example -> Field with custom model
## CustomerAccountTab
Shows how add new tab (page, menu item) in customer account (frontend).
Answer on question: Describe how to customize the “My Account” section. How do you add a menu item?
## CustomerEditButton
Shows how add new button in customer edit page (admin panel).
## CustomerEditTab
Shows how add new tab\page\menu item in customer edit section (admin panel).
## PaymentMethod
Shows how create new payment method in Magento 2.
## ShippingMethod
Shows how create simple shipping method in Magento 2.
## HideCustomerMenuItem
Shows how hide/remove menu items in (frontend) customer account page in Magento 2 (programmatically)
## ProductEditButton
Shows how add button to product create/edit page in Magento 2
## LoggerExample
Shows how create custom logger and write data to new file in Magento 2
Sample of injection and using here: Magestudy\LoggerExample\Helper\Data
## SearchCriteria
Shows how to configure and create a SearchCriteria instance using the builder for repositories
Sample here: Magestudy\SearchCriteria\Controller\Hello\Index.php
Frontend url: .../index.php/SearchCriteria/hello/index
## ExtensionAttributes
Shows how to use Extension Attributes
Frontend url: .../index.php/ExtensionAttribute/hello/index
## ProductExtensionAttribute
Shows how to use Extension Attributes for products
Added sales information to product object (before test need to create order for selected product)
Frontend url: .../index.php/ProductExtensionAttribute/hello/index
Sample here: Magestudy\ProductExtensionAttribute\Controller\Hello\Index.php
## Widget
Shows how create simple widget
* Go to CONTENT -> Widgets -> Add Widget
* Select "Magestudy Sample Widget" as type and choose your theme
* Click on continue and fill all fields (in "Widget Options" set some data to label and limit)
* Go to CONTENT -> Pages -> Home Page: add widget to page
* Go to main page for result
## Mixins
Shows how to use mixins in Magento 2:
* Add new method
* Override method
Frontend url: .../index.php/mixin/index
## CustomizeOrderHistoryPage
Answer on question: How do you customize the order history page?
## Router
An implementation of RouterInterface to create a custom router.
Frontend url: .../index.php/sample
## Declarative Schema
Migrate install/upgrade scripts to declarative schema
Develop data patches
## Recently Viewed Widget field
Added new field to recently viewed widget
## Add new params to window.checkout and window.checkoutConfig
Add new params to use in JS files
## Additional fields in the "Shipping and Tracking Information" section - AdditionalTrackingFields
Added new fields (Reference and Contents) to the tracking form.
## Add a new role to the product image - ProductImageRole
Add new product image role programmatically
License
----
MIT