{"id":2188,"date":"2017-04-01T07:11:02","date_gmt":"2017-04-01T07:11:02","guid":{"rendered":"http:\/\/myprojects.advchaweb.com\/?p=2188"},"modified":"2019-07-22T04:14:50","modified_gmt":"2019-07-22T04:14:50","slug":"magento-2-module-development","status":"publish","type":"post","link":"https:\/\/myprojects.advchaweb.com\/index.php\/2017\/04\/01\/magento-2-module-development\/","title":{"rendered":"Magento 2 Module Development"},"content":{"rendered":"

Ref: https:\/\/www.mageplaza.com\/magento-2-module-development\/<\/a><\/p>\n

The module is a directory that contains blocks, controllers, models, helper<\/span>, etc – that are related to a specific business feature. In Magento 2, modules will be live in app\/code<\/span> directory of a Magento installation, with this format: app\/code\/<Vendor>\/<ModuleName><\/span>. I use Magento 2.1.5 CE. Here is the installation steps<\/a>.<\/p>\n

Create Hello World module for Magento 2<\/span><\/p>\n

Step 1: Create a directory for the module like above format.<\/span>
\nHere I use Advcha<\/span> as a Vendor name and HelloWorld<\/span> as a ModuleName.
\nSo create a directory: app\/code\/Advcha\/HelloWorld<\/span>.<\/p>\n

Step 2: Declare module by using configuration file module.xml<\/span>
\nCreate a new file module.xml<\/span> in app\/code\/Advcha\/HelloWorld\/etc\/<\/span> directory. Here is the full path: app\/code\/Advcha\/HelloWorld\/etc\/module.xml<\/span>
\nHere is the file content:<\/p>\n

<?xml version=\"1.0\"?>\r\n<config xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"urn:magento:framework:Module\/etc\/module.xsd\">\r\n    <module name=\"Advcha_HelloWorld\" setup_version=\"1.0.0\" \/>\r\n<\/config><\/pre>\n
Here I register a module with name Advcha_HelloWorld<\/span> and the version is 1.0.0<\/span>.<\/p>\n
Step 3: Register module by registration.php<\/span>
\nMagento 2 module must be registered in the Magento system through the magento ComponentRegistrar<\/span> class. This file will be placed in module root directory. Create a new file registration.php<\/span> (beware the file name case-sensitive, it must be registration.php NOT Registration.php) in app\/code\/Advcha\/HelloWorld\/<\/span> directory. Here is the full path: app\/code\/Advcha\/HelloWorld\/registration.php<\/span>
\nHere is the file content:<\/p>\n
<?php\r\n\\Magento\\Framework\\Component\\ComponentRegistrar::register(\r\n    \\Magento\\Framework\\Component\\ComponentRegistrar::MODULE,\r\n    'Advcha_HelloWorld',\r\n    __DIR__\r\n);\r\n<\/pre>\n
Step 4: Enable the module<\/span>
\nBefore enable the module, we must check to make sure Magento has recognize our module or not by enter the following at the command line: php bin\/magento module:status<\/span><\/p>\n
www-data@teddy-K43SJ:\/home\/teddy\/Documents\/works\/magentoce215$ php bin\/magento module:status\r\n...\r\nList of disabled modules:\r\nAdvcha_HelloWorld<\/pre>\n
Run this command php bin\/magento module:enable Advcha_HelloWorld<\/span> to enable it:<\/p>\n
www-data@teddy-K43SJ:\/home\/teddy\/Documents\/works\/magentoce215$ php bin\/magento module:enable Advcha_HelloWorld\r\nThe following modules have been enabled:\r\n- Advcha_HelloWorld\r\n\r\nTo make sure that the enabled modules are properly registered, run 'setup:upgrade'.\r\nCache cleared successfully.\r\nGenerated classes cleared successfully. Please run the 'setup:di:compile' command to generate classes.\r\nInfo: Some modules might require static view files to be cleared. To do this, run 'module:enable' with the --clear-static-content option to clear them.<\/pre>\n
Magento require to check and upgrade module database. We need to run this command php bin\/magento setup:upgrade<\/span>.<\/p>\n
www-data@teddy-K43SJ:\/home\/teddy\/Documents\/works\/magentoce215$ php bin\/magento setup:upgrade\r\nCache cleared successfully\r\n...\r\nUpdating modules:\r\nSchema creation\/updates:\r\nModule 'Advcha_HelloWorld':\r\n...\r\nSchema post-updates:\r\nModule 'Advcha_HelloWorld':\r\n...\r\nData install\/update:\r\nModule 'Advcha_HelloWorld':\r\n...\r\nData post-updates:\r\nModule 'Advcha_HelloWorld':\r\n...\r\nPlease re-run Magento compile command<\/pre>\n
Now you can check under Stores -> Configuration -> Advanced -> Advanced that the module is present.\"\"<\/a>Step 5: Create a Routers for the module.<\/span>
\nA request URL has the following format:<\/p>\n
http:\/\/magentoce215.dev\/<router_id>\/<controller_name>\/<action_name><\/pre>\n
NOTE: Here I replaced <router_name><\/span> to <router_id> <\/span>after I read this article Magento 2: Advanced Routing<\/a>.
\n“The id identifies the route node uniquely in the Magento system, and the frontName defines the first segment of your URL.”<\/span>
\nAt first I thought it was <router_name> before I found the article. But I confused because this tutorial is working even if I didn’t change the id from ‘advcha’ to ‘helloworld.??? So the url would be http:\/\/magentoce215.dev\/helloworld\/*
\nIn this module, we need to create a route for frontend area. So we need to add this file: app\/code\/Advcha\/HelloWorld\/etc\/frontend\/routes.xml<\/span>.
\nHere is the content:<\/p>\n
<?xml version=\"1.0\"?>\r\n<config xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"urn:magento:framework:App\/etc\/routes.xsd\">\r\n    <router id=\"standard\">\r\n        <route id=\"advcha\" frontName=\"helloworld\">\r\n            <module name=\"Advcha_HelloWorld\" \/>\r\n        <\/route>\r\n    <\/router>\r\n<\/config><\/pre>\n
After define the route, the URL path to our module will be: http:\/\/magentoce215.dev\/helloworld\/*
\nSo our <router_name><\/span> is helloworld ???
\n<\/span><\/p>\n
Step 6: Create controller and action.<\/span>
\nwe will create controller and action to display ‘Hello World’. Our <controller_name><\/span> would be index<\/span> and <action_name><\/span> would be display<\/span>. We need to create a new php file: app\/code\/Advcha\/HelloWorld\/Controller\/Index\/Display.php<\/span>
\nHere is the file content:<\/p>\n
<?php\r\nnamespace Advcha\\HelloWorld\\Controller\\Index;\r\n\r\nclass Display extends \\Magento\\Framework\\App\\Action\\Action\r\n{\r\n    public function __construct(\\Magento\\Framework\\App\\Action\\Context $context){\r\n        return parent::__construct($context);\r\n    }\r\n    \r\n    public function execute(){\r\n        echo 'Hello World!';\r\n        exit;\r\n    }\r\n}<\/pre>\n
Now we can open the url to show ‘Hello World!’ from our module: http:\/\/magentoce215.dev\/helloworld\/index\/display
\nNote: If there is no change, please flush the cache with this command: php bin\/magento cache:flush<\/span>.<\/p>\n
Step 7: Add to github.<\/span>
\nIt’s a good way to store also our code in github. Here is how to\u00a0 do it:
\nExit from ‘www-data’ user then Go into \/app\/code\/Advcha\/HelloWorld\/ directory:<\/p>\n
www-data@teddy-K43SJ:\/home\/teddy\/Documents\/works\/magentoce215\/app\/code\/Advcha\/HelloWorld\/$ exit\r\nexit\r\nteddy@teddy-K43SJ:~\/Documents\/works\/magentoce215$ cd app\/code\/Advcha\/HelloWorld\/<\/pre>\n
Initialize with git init<\/span>:<\/p>\n
teddy@teddy-K43SJ:~\/Documents\/works\/magentoce215\/app\/code\/Advcha\/HelloWorld$ git init\r\nInitialized empty Git repository in \/home\/teddy\/Documents\/works\/magentoce215\/app\/code\/Advcha\/HelloWorld\/.git\/<\/pre>\n
Go into your github account and create a new repository. I created a new repo ‘magento2-sample-module’ (https:\/\/github.com\/advcha\/magento2-sample-module). Then use git remote add origin https:\/\/github.com\/advcha\/magento2-sample-module.git<\/span> and git push -u origin master<\/span> to update the remote reposity.<\/p>\n
teddy@teddy-K43SJ:~\/Documents\/works\/magentoce215\/app\/code\/Advcha\/HelloWorld$ git remote add origin https:\/\/github.com\/advcha\/magento2-sample-module.git\r\nteddy@teddy-K43SJ:~\/Documents\/works\/magentoce215\/app\/code\/Advcha\/HelloWorld$ git push -u origin master\r\nUsername for 'https:\/\/github.com': advcha\r\nPassword for 'https:\/\/advcha@github.com': \r\nCounting objects: 10, done.\r\nDelta compression using up to 4 threads.\r\nCompressing objects: 100% (7\/7), done.\r\nWriting objects: 100% (10\/10), 1.08 KiB | 0 bytes\/s, done.\r\nTotal 10 (delta 1), reused 0 (delta 0)\r\nremote: Resolving deltas: 100% (1\/1), done.\r\nTo https:\/\/github.com\/advcha\/magento2-sample-module.git\r\n * [new branch]      master -> master\r\nBranch master set up to track remote branch master from origin.<\/pre>\n
Then we can use git add command to prepare our files or use git GUI to make it easier. I use gitcola. First, stage the files, then commit and push. Done!<\/p>\n
Create Controllers in Magento 2<\/span>
\nref: https:\/\/www.mageplaza.com\/magento-2-module-development\/how-to-create-controllers-magento-2.html<\/a>
\nIn Magento 2 Controller has one or more files in Controller folder of module, it includes actions of class which contain execute()<\/span> method. There are 2 different controllers, they are frontend<\/span> controller and backend<\/span> controller. They are generally similar of workflow, but admin controller is a little different. There is a checking permission method in admin controller.
\nHere for the first step, we follow the same step as above like create routes.xml<\/span> in \/app\/Advcha\/HelloWorld\/etc\/frontend\/ <\/span>directory. But we change the id to ‘helloworld’.<\/p>\n
<?xml version=\"1.0\"?>\r\n<config xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"urn:magento:framework:App\/etc\/routes.xsd\">\r\n    <router id=\"standard\">\r\n        <route id=\"helloworld\" frontName=\"helloworld\">\r\n            <module name=\"Advcha_HelloWorld\" \/>\r\n        <\/route>\r\n    <\/router>\r\n<\/config><\/pre>\n
Then create controller file Index.php<\/span> in \/app\/Advcha\/HelloWorld\/Controller\/Index\/<\/span> directory.<\/p>\n
<?php \r\nnamespace Advcha\\HelloWorld\\Controller\\Index;\r\n\r\nclass Index extends \\Magento\\Framework\\App\\Action\\Action\r\n{\r\n    protected $resultPageFactory;\r\n    \r\n    \/**\r\n        * Constructor\r\n        * \r\n        * @param \\Magento\\Framework\\App\\Action\\Context  $context\r\n        * @param \\Magento\\Framework\\View\\Result\\PageFactory $resultPageFactory\r\n        *\/\r\n    public function __construct(\r\n        \\Magento\\Framework\\App\\Action\\Context $context,\r\n        \\Magento\\Framework\\View\\Result\\PageFactory $resultPageFactory) \r\n    {\r\n        $this->resultPageFactory = $resultPageFactory;\r\n        parent::__construct($context);\r\n    }\r\n\r\n    \/**\r\n        * Execute view action\r\n        * \r\n        * @return \\Magento\\Framework\\Controller\\ResultInterface\r\n        *\/\r\n    public function execute() {\r\n        \/\/echo 'Hello Advcha!';\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0 \/\/exit;\r\n        return $this->resultPageFactory->create();\r\n    }\r\n\r\n}<\/pre>\n
All controller must extend from \\Magento\\Framework\\App\\Action\\Action<\/span> class which has dispatched method which will call execute<\/span> method in action class. In this execute()<\/span> method, we will write all of our controller logic and will return response for the request.
\nThen create layout file helloworld_index_index.xml<\/span> in \/app\/Advcha\/HelloWorld\/view\/frontend\/layout\/<\/span> directory. the layout filename has a pattern <router_name>_<controller_name>_<action_name>.xml<\/span>. Therefore <router_name><\/span> is helloworld<\/span>, <controller_name><\/span> is index<\/span> and <action_name><\/span> is index<\/span> (the classname). The Frontend<\/span> layout<\/span> always<\/span> in \/view\/frontend\/layout\/<\/span> directory.<\/p>\n
<?xml version=\"1.0\" ?>\r\n<page layout=\"1column\" xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"urn:magento:framework:View\/Layout\/etc\/page_configuration.xsd\">\r\n    <body>\r\n        <referenceContainer name=\"content\">\r\n            <block class=\"Advcha\\HelloWorld\\Block\\Index\\Index\" name=\"index.index\" template=\"Advcha_HelloWorld::index\/index.phtml\"\/>\r\n        <\/referenceContainer>\r\n    <\/body>\r\n<\/page><\/pre>\n
For the block<\/span> “Advcha\\HelloWorld\\Block\\Index\\Index<\/span>“, create a new file Index.php<\/span>. The full path is in \/app\/code\/Advcha\/HelloWorld\/Block\/Index\/Index.php<\/span>.<\/p>\n
<?php\r\nnamespace Advcha\\HelloWorld\\Block\\Index;\r\n\r\nclass Index extends \\Magento\\Framework\\View\\Element\\Template{\r\n    public function _prepareLayout() {\r\n        return parent::_prepareLayout();\r\n    }\r\n}<\/pre>\n
For the template<\/span> is “Advcha_HelloWorld::index\/index.phtml<\/span>“. The full path is in \/app\/code\/Advcha\/HelloWorld\/view\/frontend\/templates\/index\/index.phtml<\/span>. The Frontend<\/span> template<\/span> always<\/span> in \/view\/frontend\/templates\/<\/span> directory. Create a new file index.phtml<\/span> and here is the content:<\/p>\n
<h1>Welcome Advcha.<\/h1><\/pre>\n
Okay. It’s time to test but first flush magento cache with command: php bin\/magento cache:flush<\/span>. Then open this url: http:\/\/magentoce215.dev\/helloworld\/index\/index. IT SHOULD SHOW Welcome Advcha.<\/span>
\nIF IT SHOW EMPTY PAGE, Please flush the magento cache or check again the id in routes.xml or make sure the ‘block’ is exist or modify ‘layout=”empty”‘ in helloworld_index_index.xml (ref:\u00a0http:\/\/magento.stackexchange.com\/questions\/84370\/magento-2-sample-module-displays-blank-page<\/a>).
\nWe can also inspect the elements with Magento DevTools<\/a>.\"\"<\/a>CRUD<\/span>
\nref: https:\/\/www.mageplaza.com\/magento-2-module-development\/how-to-create-crud-model-magento-2.html<\/a>
\nHere I want to create a new table ‘advcha_post<\/span>‘ with these following columns:
\npost_id<\/span> – the post unique identifier
\ntitle<\/span> – the title of the post
\ncontent<\/span> – the content of the post
\ncreation_time<\/span> – the date created
\nTo create a magento model, first setup a script<\/span> in InstallSchema.php<\/span> to create the table. Here is the full path: app\/code\/Advcha\/HelloWorld\/Setup\/InstallSchema.php<\/span>. Here is the file content:
\nNOTE: I updated the content from the github link: https:\/\/github.com\/mageplaza\/magento-2-sample-module\/blob\/master\/Setup\/InstallSchema.php<\/a><\/p>\n
<?php\r\nnamespace Advcha\\HelloWorld\\Setup;\r\n\r\nuse \\Magento\\Framework\\Setup\\SchemaSetupInterface;\r\nuse \\Magento\\Framework\\Setup\\ModuleContextInterface;\r\nuse \\Magento\\Framework\\DB\\Ddl\\Table;\r\nuse \\Magento\\Framework\\DB\\Adapter\\AdapterInterface;\r\n\r\nclass InstallSchema implements \\Magento\\Framework\\Setup\\InstallSchemaInterface{\r\n    \/**\r\n        * install tables\r\n        *\r\n        * @param \\Magento\\Framework\\Setup\\SchemaSetupInterface $setup\r\n        * @param \\Magento\\Framework\\Setup\\ModuleContextInterface $context\r\n        * @return void\r\n        * @SuppressWarnings(PHPMD.ExcessiveMethodLength)\r\n        *\/\r\n    public function install(SchemaSetupInterface $setup, ModuleContextInterface $context)\r\n    {\r\n        $installer = $setup;\r\n        $installer->startSetup();\r\n        if (!$installer->tableExists('advcha_helloworld_post')) {\r\n            $table = $installer->getConnection()->newTable(\r\n                $installer->getTable('advcha_helloworld_post')\r\n            )\r\n            ->addColumn(\r\n                'post_id',\r\n                Table::TYPE_INTEGER,\r\n                null,\r\n                [\r\n                    'identity' => true,\r\n                    'nullable' => false,\r\n                    'primary'  => true,\r\n                    'unsigned' => true,\r\n                ],\r\n                'Post ID'\r\n            )\r\n            ->addColumn(\r\n                'name',\r\n                Table::TYPE_TEXT,\r\n                255,\r\n                ['nullable => false'],\r\n                'Post Name'\r\n            )\r\n            ->addColumn(\r\n                'url_key',\r\n                Table::TYPE_TEXT,\r\n                255,\r\n                [],\r\n                'Post URL Key'\r\n            )\r\n            ->addColumn(\r\n                'post_content',\r\n                Table::TYPE_TEXT,\r\n                '64k',\r\n                [],\r\n                'Post Post Content'\r\n            )\r\n            ->addColumn(\r\n                'tags',\r\n                Table::TYPE_TEXT,\r\n                255,\r\n                [],\r\n                'Post Tags'\r\n            )\r\n            ->addColumn(\r\n                'status',\r\n                Table::TYPE_INTEGER,\r\n                1,\r\n                [],\r\n                'Post Status'\r\n            )\r\n            ->addColumn(\r\n                'featured_image',\r\n                Table::TYPE_TEXT,\r\n                255,\r\n                [],\r\n                'Post Featured Image'\r\n            )\r\n            ->addColumn(\r\n                'sample_country_selection',\r\n                Table::TYPE_TEXT,\r\n                3,\r\n                [],\r\n                'Post Sample Country Selection'\r\n            )\r\n            ->addColumn(\r\n                'sample_upload_file',\r\n                Table::TYPE_TEXT,\r\n                255,\r\n                [],\r\n                'Post Sample File'\r\n            )\r\n            ->addColumn(\r\n                'sample_multiselect',\r\n                Table::TYPE_TEXT,\r\n                '64k',\r\n                [],\r\n                'Post Sample Multiselect'\r\n            )\r\n            ->addColumn(\r\n                'created_at',\r\n                Table::TYPE_TIMESTAMP,\r\n                null,\r\n                [],\r\n                'Post Created At'\r\n            )\r\n            ->addColumn(\r\n                'updated_at',\r\n                Table::TYPE_TIMESTAMP,\r\n                null,\r\n                [],\r\n                'Post Updated At'\r\n            )\r\n            ->setComment('Post Table');\r\n            $installer->getConnection()->createTable($table);\r\n\r\n            $installer->getConnection()->addIndex(\r\n                $installer->getTable('advcha_helloworld_post'),\r\n                $setup->getIdxName(\r\n                    $installer->getTable('advcha_helloworld_post'),\r\n                    ['name','url_key','post_content','tags','featured_image','sample_upload_file'],\r\n                    AdapterInterface::INDEX_TYPE_FULLTEXT\r\n                ),\r\n                ['name','url_key','post_content','tags','featured_image','sample_upload_file'],\r\n                AdapterInterface::INDEX_TYPE_FULLTEXT\r\n            );\r\n        }\r\n        $installer->endSetup();\r\n    }\r\n}<\/pre>\n
Then run php bin\/magento setup:upgrade<\/span>
\nThis should create a new table ‘advcha_helloworld_post<\/span>‘ in your magento database. If it didn’t create it, please check ‘setup_module<\/span>‘ table, then find ‘Advcha_HelloWorld’ record and remove it. Then run again php bin\/magento setup:upgrade<\/span>.
\nIf you find this error<\/p>\n
[Zend_Db_Exception]                                                          \r\n  There is no field \"sample_upload_file\" that you are trying to create an index on \"advcha_helloworld_post\"<\/pre>\n
This mean you haven’t define ‘sample_upload_file’ field in InstallSchema.php file above. Please look again the above file carefully or see the file from the github: https:\/\/github.com\/mageplaza\/magento-2-sample-module\/blob\/master\/Setup\/InstallSchema.php<\/a>.
\nCreate Model<\/span>
\nFirst create an interface in PostInterface.php<\/span> file in app\/code\/Advcha\/HelloWorld\/Model\/Api\/Data\/<\/span> directory.<\/p>\n
<?php\r\n\r\nnamespace Advcha\\HelloWorld\\Model\\Api\\Data;\r\n\r\ninterface PostInterface {\r\n    public function getId();\r\n    public function setId();\r\n    \r\n    public function getName();\r\n    public function setName();\r\n    \r\n    public function getPostContent();\r\n    public function setPostContent();\r\n}<\/pre>\n
This interface has defined the set and get method to table data which we would use when interacting with the model. This interface plays an important role when it comes time to exporting CRUD models to Magento service contracts based API.
\nNow create a model Post<\/span> in app\/code\/Advcha\/HelloWorld\/Model\/Post.php<\/span>.<\/p>\n
<?php\r\nnamespace Advcha\\HelloWorld\\Model;\r\n\r\nuse Magento\\Framework\\Model\\AbstractModel;\r\nuse Magento\\Framework\\DataObject\\IdentityInterface;\r\nuse Advcha\\HelloWorld\\Model\\Api\\Data\\PostInterface;\r\n\r\nclass Post extends AbstractModel implements IdentityInterface,PostInterface {\r\n    const CACHE_TAG = 'advcha_helloworld_post';\r\n\r\n    protected $_cacheTag = 'advcha_helloworld_post';\r\n\r\n    protected $_eventPrefix = 'advcha_helloworld_post';\r\n    \r\n    protected function __construct() {\r\n        $this->_init('Advcha\\HelloWorld\\Model\\ResourceModel\\Post');\r\n    }\r\n\r\n    public function getIdentities(){\r\n        return [self::CACHE_TAG . '_' . $this->getId()];\r\n    }\r\n    \r\n    public function getDefaultValues(){\r\n        $values = [];\r\n        \r\n        return $values;\r\n    }\r\n}<\/pre>\n
$_eventPrefix<\/span> – a prefix for events to be triggered
\n$_eventObject<\/span> – a object name when access in event
\n$_cacheTag<\/span> – a unique identifier for use within caching
\nCreate a Resource Model<\/span>
\nthe model file contain overall database logic, it do not execute sql queries. The resource model will do that. Now we will create the Resource Model for this table: Advcha\\HelloWorld\\Model\\ResourceModel\\Post.php<\/span>.<\/p>\n
<?php\r\nnamespace Advcha\\HelloWorld\\Model\\ResourceModel;\r\n\r\nuse Magento\\Framework\\Model\\ResourceModel\\Db\\AbstractDb;\r\nuse Magento\\Framework\\Stdlib\\DateTime\\DateTime;\r\nuse Magento\\Framework\\Model\\ResourceModel\\Db\\Context;\r\nuse Magento\\Framework\\Model\\AbstractModel;\r\n\r\nclass Post extends AbstractDb {\r\n    \/**\r\n        * Date model\r\n        * \r\n        * @var \\Magento\\Framework\\Stdlib\\DateTime\\DateTime\r\n        *\/\r\n    protected $_date;\r\n\r\n    \/**\r\n        * constructor\r\n        * \r\n        * @param \\Magento\\Framework\\Stdlib\\DateTime\\DateTime $date\r\n        * @param \\Magento\\Framework\\Model\\ResourceModel\\Db\\Context $context\r\n        *\/\r\n    protected function __construct(DateTime $date, Context $context) {\r\n        $this->_date = $date;\r\n        parent::__construct($context);\r\n    }\r\n    \/**\r\n        * Initialize resource model\r\n        *\r\n        * @return void\r\n        *\/\r\n    public function _construct(){\r\n        $this->_init('advcha_helloworld_post', 'post_id');\r\n    }\r\n    \/**\r\n        * Retrieves Post Name from DB by passed id.\r\n        *\r\n        * @param string $id\r\n        * @return string|bool\r\n        *\/\r\n    public function getPostNameById($id){\r\n        $adapter = $this->getConnection();\r\n        $select = $adapter->select()\r\n                ->from($this->getMainTable(), 'name')\r\n                ->where('post_id = :post_id');\r\n        $binds = ['post_id' => (int)$id];\r\n        return $adapter->fetchOne($select, $binds);\r\n    }\r\n    \/**\r\n        * before save callback\r\n        *\r\n        * @param \\Magento\\Framework\\Model\\AbstractModel|\\Mageplaza\\HelloWorld\\Model\\Post $object\r\n        * @return $this\r\n        *\/\r\n    protected function _beforeSave(AbstractModel $object) {\r\n        $object->setUpdateAt($this->_date->date());\r\n        if($object->isObjectNew()){\r\n            $object->setCreatedAt($this->_date->date());\r\n        }\r\n        return parent::_beforeSave($object);\r\n    }\r\n}<\/pre>\n
Resource Model Collection – Get Model Collection<\/span>
\nThe collection model is considered a resource model which allow us to filter and fetch a collection table data. The collection model will be placed in: Advcha\\HelloWorld\\Model\\ResourceModel\\Post\\Collection.php<\/span>.<\/p>\n
<?php\r\nnamespace Advcha\\HelloWorld\\Model\\ResourceModel\\Post;\r\n\r\nuse Magento\\Framework\\Model\\ResourceModel\\Db\\Collection\\AbstractCollection;\r\n\r\nclass Collection extends AbstractCollection\r\n{\r\n    protected $_idFieldName = 'post_id';\r\n    protected $_eventPrefix = 'advcha_helloworld_post_collection';\r\n    protected $_eventObject = 'post_collection';\r\n\r\n    \/**\r\n     * Define resource model\r\n     *\r\n     * @return void\r\n     *\/\r\n    protected function _construct()\r\n    {\r\n        $this->_init('Advcha\\HelloWorld\\Model\\Post', 'Advcha\\HelloWorld\\Model\\ResourceModel\\Post');\r\n    }\r\n\r\n    \/**\r\n     * Get SQL for get record count.\r\n     * Extra GROUP BY strip added.\r\n     *\r\n     * @return \\Magento\\Framework\\DB\\Select\r\n     *\/\r\n    public function getSelectCountSql()\r\n    {\r\n        $countSelect = parent::getSelectCountSql();\r\n        $countSelect->reset(\\Zend_Db_Select::GROUP);\r\n        return $countSelect;\r\n    }\r\n    \/**\r\n     * @param string $valueField\r\n     * @param string $labelField\r\n     * @param array $additional\r\n     * @return array\r\n     *\/\r\n    protected function _toOptionArray($valueField = 'post_id', $labelField = 'name', $additional = [])\r\n    {\r\n        return parent::_toOptionArray($valueField, $labelField, $additional);\r\n    }\r\n}<\/pre>\n
Factory Object and create Block Post<\/span>
\nCreate a Post block: Advcha\\HelloWorld\\Block\\Post.php<\/span>.<\/p>\n
<?php\r\nnamespace Advcha\\HelloWorld\\Block;\r\n\r\nuse Magento\\Framework\\View\\Element\\Template;\r\nuse Magento\\Framework\\View\\Element\\Template\\Context;\r\nuse Advcha\\HelloWorld\\Model\\PostFactory;\r\n\r\nclass Post extends Template\r\n{\r\n    protected $_postFactory;\r\n    public function _construct(Context $context, PostFactory $postFactory){\r\n        $this->_postFactory = $postFactory;\r\n        parent::_construct($context);\r\n    }\r\n\r\n    public function _prepareLayout()\r\n    {\r\n        $post = $this->_postFactory->create();\r\n        $collection = $post->getCollection();\r\n        foreach($collection as $item){\r\n                var_dump($item->getData());\r\n        }\r\n        exit;\r\n    }\r\n}<\/pre>\n
Then how to run this CRUD?<\/p>\n
Create View: Block, Layouts, Templates<\/span>
\nref: https:\/\/www.mageplaza.com\/magento-2-module-development\/view-block-layout-template-magento-2.html<\/a>
\nHere we want to create a module to show\/display a text on the magento frontend.
\nA View will be use to output representation of the page. In Magento 2, View is built by three path: block, layout and template<\/span>.
\nCall view in controller<\/span>
\nIn the previous Hello World Module topic, we have build a simple module and show the Hello World message on the screen directly by controller. Now we will edit it to call view to render page. File: app\/code\/Advcha\/HelloWorld\/Controller\/Index\/Display.php<\/span>.<\/p>\n
<?php\r\nnamespace Advcha\\HelloWorld\\Controller\\Index;\r\n\r\nuse Magento\\Framework\\App\\Action\\Action;\r\nuse Magento\\Framework\\App\\Action\\Context;\r\nuse Magento\\Framework\\View\\Result\\PageFactory;\r\n\r\nclass Display extends Action\r\n{\r\n    protected $_pageFactory;\r\n    public function __construct(Context $context, PageFactory $pageFactory){\r\n        $this->_pageFactory = $pageFactory;\r\n        return parent::__construct($context);\r\n    }\r\n    \r\n    public function execute(){\r\n        \/\/echo 'Hello World!';\r\n        \/\/exit;\r\n        return $this->_pageFactory->create();\r\n    }\r\n}<\/pre>\n
Create layout file .xml<\/span>
\nThe Layout is the major path of view layer in Magento 2 module. The layout file is a XML file which will define the page structure and will be locate in {module_root}\/view\/{area}\/layout\/<\/span> directory. The Area path can be frontend<\/span> or adminhtml<\/span> which define where the layout will be applied.
\nThere is a special layout file name default.xml<\/span> which will be applied for all the page in it\u2019s area. Otherwise, the layout file will have name as format: {router_id}_{controller_name}_{action_name}.xml<\/span>. We can find the frontend {router_id} is helloworld<\/span> in app\/code\/Advcha\/HelloWorld\/etc\/frontend\/routes.xml<\/span>. The\u00a0{controller_name}<\/span> is index<\/span> and {action_name}<\/span> is display (from Display.php where Action exist: Magento\\Framework\\App\\Action\\Action)<\/span>. We will create a layout handle file for this module: File: app\/code\/Advcha\/HelloWorld\/view\/frontend\/layout\/helloworld_index_display.xml<\/span>.<\/p>\n
<?xml version=\"1.0\"?>\r\n<page xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\" layout=\"1column\" xsi:noNamespaceSchemaLocation=\"urn:magento:framework:View\/Layout\/etc\/page_configuration.xsd\">\r\n    <referenceContainer name=\"content\">\r\n        <block class=\"Advcha\\HelloWorld\\Block\\Display\" name=\"helloworld_display\" template=\"Advcha_HelloWorld::sayhello.phtml\" \/>\r\n    <\/referenceContainer>\r\n<\/page><\/pre>\n
Block class: Advcha\\HelloWorld\\Block\\Display<\/span>, Template file: Advcha_HelloWorld::sayhello.phtml<\/span>.
\nCreate block<\/span>
\nThe Block file should contain all the view logic required, it should not contain any kind of html or css. Block file are supposed to have all application view logic. Create a file: app\/code\/Advcha\/HelloWorld\/Block\/Display.php<\/span>.<\/p>\n
<?php\r\nnamespace Advcha\\HelloWorld\\Block;\r\n\r\nuse Magento\\Framework\\View\\Element\\Template;\r\nuse Magento\\Framework\\View\\Element\\Template\\Context;\r\n\r\nclass Display extends Template {\r\n    public function __construct(Context $context) {\r\n        parent::__construct($context);\r\n    }\r\n    \r\n    public function sayHello(){\r\n        return __('Hello World, Advcha!');\r\n    }\r\n}<\/pre>\n
Every block in Magento 2 must extend from Magento\\Framework\\View\\Element\\Template<\/span>. In this block we will define a method sayHello()<\/span> to show the word \u201cHello World, Advcha!\u201d. We will use it in template file.
\nCreate template file<\/span>
\nCreate a template file call sayhello.phtml<\/span>: app\/code\/Advcha\/HelloWorld\/view\/frontend\/templates\/sayhello.phtml<\/span>.<\/p>\n
<?php\r\necho $block->sayHello();<\/pre>\n
In the layout file, we define the template by Advcha_HelloWorld::sayhello.phtml<\/span>. It mean that Magento will find the file name sayhello.phtml<\/span> in templates folder of module Advcha_HelloWorld<\/span>. The template folder of the module is app\/code\/{vendor_name}\/{module_name}\/view\/frontend\/templates\/<\/span>.
\nIn the template file, we can use the variable $block<\/span> for the block object. As you see, we call the method sayHello()<\/span> in Block. It\u2019s done, please access to this page again (http:\/\/magentoce215.dev\/helloworld\/index\/display<\/a>) and see the result.\"\"If you find an error like this (put “ini_set(‘display_errors’, ‘1’);<\/span>” in root index.php and \/pub\/index.php):<\/p>\n
Fatal error: Uncaught TypeError: Argument 2 passed to Advcha\\HelloWorld\\Controller\\Index\\Display::__construct() must be an instance of Magento\\Framework\\View\\Result\\PageFactory, none given, called in \/home\/teddy\/Documents\/works\/magentoce215\/var\/generation\/Advcha\/HelloWorld\/Controller\/Index\/Display\/Interceptor.php on line 14 and defined in \/home\/teddy\/Documents\/works\/magentoce215\/app\/code\/Advcha\/HelloWorld\/Controller\/Index\/Display.php on line 1<\/pre>\n
Then run this command:\u00a0php bin\/magento setup:upgrade<\/span> then refresh your browser.<\/p>\n
The Backend – system.xml Configuration<\/span>
\nref: https:\/\/www.mageplaza.com\/magento-2-module-development\/create-system-xml-configuration-magento-2.html<\/a>
\nCreate System.xml<\/span>
\nIn the admin page, the magento 2 system configuration page is divided logically in few parts: Tabs, Sections, Groups, Fields<\/span>. \"\"<\/a>So let\u2019s start to create a simple configuration for the simple Module Hello World<\/span>. The system.xml<\/span> is located in etc\/adminhtml<\/span> directory of the module, we will create it a new Tab<\/span> for our vendor \u201cAdvcha<\/span>\u201d, a new Section<\/span> for our module Hello World<\/span>, a Group<\/span> to contain some simple fields<\/span>: enable module and text. File: app\/code\/Advcha\/HelloWorld\/etc\/adminhtml\/system.xml<\/span>.<\/p>\n
<?xml version=\"1.0\"?>\r\n<config xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"urn:magento:module:Magento_Config:etc\/system_file.xsd\">\r\n    <system>\r\n        <tab id=\"advcha\" translate=\"label\" sortOrder=\"10\">\r\n            <label>Advcha<\/label>\r\n        <\/tab>\r\n        <section id=\"helloworld\" translate=\"label\" sortOrder=\"130\" showInDefault=\"1\" showInWebsite=\"1\" showInStore=\"1\">\r\n            <class>separator-top<\/class>\r\n            <label>Hello World<\/label>\r\n            <tab>advcha<\/tab>\r\n            <resource>Advcha_HelloWorld::hello_configuration<\/resource>\r\n            <group id=\"general\" translate=\"label\" type=\"text\" sortOrder=\"10\" showInDefault=\"1\" showInWebsite=\"0\" showInStore=\"0\">\r\n                <label>General Configuration<\/label>\r\n                <field id=\"enable\" translate=\"label\" type=\"select\" sortOrder=\"1\" showInDefault=\"1\" showInWebsite=\"0\" showInStore=\"0\">\r\n                    <label>Module Enable<\/label>\r\n                    <source_model>Magento\\Config\\Model\\Config\\Source\\Yesno<\/source_model>\r\n                <\/field>\r\n                <field id=\"display_text\" translate=\"label\" type=\"text\" sortOrder=\"1\" showInDefault=\"1\" showInWebsite=\"0\" showInStore=\"0\">\r\n                    <label>Display Text<\/label>\r\n                    <comment>This text will display on the frontend.<\/comment>\r\n                <\/field>\r\n            <\/group>\r\n        <\/section>\r\n    <\/system>\r\n<\/config><\/pre>\n
Set default value<\/span>
\nEach field in system.xml<\/span> after create will not have any value. When you call them, you will receive \u2018null\u2019 result. So for the module, we will need to set the default value for the field and you will call the value without go to config, set value and save it. This default value will be saved in config.xml<\/span> which is located in etc folder. Let\u2019s create it for this simple configuration: File: app\/code\/Advcha\/HelloWorld\/etc\/config.xml<\/span>.<\/p>\n
<?xml version=\"1.0\"?>\r\n<config xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"urn:magento:module:Magento_Store:etc\/config.xsd\">\r\n    <default>\r\n        <helloworld>\r\n            <general>\r\n                <enable>1<\/enable>\r\n                <display_text>Hello World, Advcha!<\/display_text>\r\n            <\/general>\r\n        <\/helloworld>\r\n    <\/default>\r\n<\/config><\/pre>\n
You can put the path to the field in the <default><\/span> element to set value default for it. The format is:<\/p>\n
<default>\r\n    <section_id>\r\n        <group_id>\r\n            <field_id>{value}<\/field_id>\r\n        <\/group_id>\r\n    <\/section_id>\r\n<\/default_id><\/pre>\n
\"\"<\/a>We need to flush the cache and see the result above.
\nGet value from configuration<\/span>
\nFirst all of let\u2019s save value and flush cache, then you can get saved value from database. In the system.xml<\/span>, we have added 2 fields: enable<\/span> and display_text<\/span>. So the path should be: helloworld\/general\/enable<\/span> and helloworld\/general\/display_text<\/span>. We can call them through simple calling or use helper (recommended). Also please read for more samples:\u00a0 http:\/\/magento.stackexchange.com\/questions\/87789\/magento2-how-to-get-data-from-system-configuration<\/a>
\nSimple calling<\/span>:<\/p>\n
$this->scopeConfig->getValue('helloworld\/general\/enable', \\Magento\\Store\\Model\\ScopeInterface::SCOPE_STORE);\r\n$this->scopeConfig->getValue('helloworld\/general\/display_text', \\Magento\\Store\\Model\\ScopeInterface::SCOPE_STORE);<\/pre>\n
Create a helper file (standard)<\/span>
\nCreate file: Advcha\/HelloWorld\/Helper\/Data.php<\/span>.<\/p>\n
<?php\r\n\r\nnamespace Advcha\\HelloWorld\\Helper;\r\n\r\nuse Magento\\Framework\\App\\Helper\\AbstractHelper;\r\nuse Magento\\Store\\Model\\StoreManagerInterface;\r\nuse Magento\\Framework\\ObjectManagerInterface;\r\nuse Magento\\Framework\\App\\Helper\\Context;\r\nuse Magento\\Store\\Model\\ScopeInterface;\r\n\r\nclass Data extends AbstractHelper\r\n{\r\n    protected $storeManager;\r\n    protected $objectManager;\r\n\r\n    const XML_PATH_HELLOWORLD = 'helloworld\/';\r\n\r\n    public function __construct(Context $context,\r\n        ObjectManagerInterface $objectManager,\r\n        StoreManagerInterface $storeManager\r\n    ) {\r\n        $this->objectManager = $objectManager;\r\n        $this->storeManager  = $storeManager;\r\n        parent::__construct($context);\r\n    }\r\n\r\n    public function getConfigValue($field, $storeId = null)\r\n    {\r\n        return $this->scopeConfig->getValue(\r\n            $field, ScopeInterface::SCOPE_STORE, $storeId\r\n        );\r\n    }\r\n\r\n    public function getGeneralConfig($code, $storeId = null)\r\n    {\r\n        return $this->getConfigValue(self::XML_PATH_HELLOWORLD . $code, $storeId);\r\n    }\r\n}<\/pre>\n
Now we can get those value and call the helper from .phtml file like this:<\/p>\n
$helper = $this->objectManager->create('Advcha\\HelloWorld\\Helper\\Data');\r\necho $helper->getGeneralConfig('enable');\r\necho $helper->getGeneralConfig('display_text');<\/pre>\n
 <\/p>\n","protected":false},"excerpt":{"rendered":"
Ref: https:\/\/www.mageplaza.com\/magento-2-module-development\/ The module is a directory that contains blocks, controllers, models, helper, etc – that are related to a specific business feature. In Magento 2, modules will be live in app\/code directory of a Magento installation, with this format: app\/code\/<Vendor>\/<ModuleName>. I use Magento 2.1.5 CE. Here is the installation steps. Create Hello World module … Continue reading “Magento 2 Module Development”<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[71,98,13],"tags":[],"class_list":["post-2188","post","type-post","status-publish","format-standard","hentry","category-magento","category-magento-tutorial","category-tutorial"],"_links":{"self":[{"href":"https:\/\/myprojects.advchaweb.com\/index.php\/wp-json\/wp\/v2\/posts\/2188","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/myprojects.advchaweb.com\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/myprojects.advchaweb.com\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/myprojects.advchaweb.com\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/myprojects.advchaweb.com\/index.php\/wp-json\/wp\/v2\/comments?post=2188"}],"version-history":[{"count":25,"href":"https:\/\/myprojects.advchaweb.com\/index.php\/wp-json\/wp\/v2\/posts\/2188\/revisions"}],"predecessor-version":[{"id":4368,"href":"https:\/\/myprojects.advchaweb.com\/index.php\/wp-json\/wp\/v2\/posts\/2188\/revisions\/4368"}],"wp:attachment":[{"href":"https:\/\/myprojects.advchaweb.com\/index.php\/wp-json\/wp\/v2\/media?parent=2188"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/myprojects.advchaweb.com\/index.php\/wp-json\/wp\/v2\/categories?post=2188"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/myprojects.advchaweb.com\/index.php\/wp-json\/wp\/v2\/tags?post=2188"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}