App for J2store
In the following guide, we are going to cover the following topics related to plugin development:
Introduction App Structure Naming Conventions The Manifest Creating app class App Model Class App controller
Introduction
Developing a app for J2Store is very simple process if you are good in PHP and the Joomla MVC structure.
J2Store comes with a app library and wrappers that makes creating a app for J2Store.
App Structure
There is a folder structure and a few naming conventions, that should be followed during the development of a app for J2Store.
A typical app should look like this:
1
├── app_example/
2
│ ├── app_example.php
3
│ ├── app_example.xml
4
│ ├── languages/
5
│ │ ├── en-GB.plg_j2store_app_example.ini
6
│ ├── app_example/
7
│ │ ├── tmpl/
8
│ │ │ ├── form.php
9
│ │ │ ├── default.php
10
│ │ ├── controller.php
11
│ │ ├── models/
12
│ │ │ ├── appexample.php
Copied!
Naming Conventions
The name of the app folder should start with the prefix “app”. Otherwise, J2Store will not recognise your app. So our example app is named as:appexample
Make sure that the name of the file and folder is in lower case and there are no spaces or any other characters in the name.
Manifest
An example manifest should look like this:
1
<?xml version="1.0" encoding="utf-8"?>
2
<extension version="3.0" type="plugin" group="j2store" method="upgrade">
3
<name>Example</name>
4
<version>1.0</version>
5
<creationDate>July 2015</creationDate>
6
<author>J2Store</author>
7
<authorEmail>[email protected]</authorEmail>
8
<authorUrl>http://www.j2store.org</authorUrl>
9
<copyright>2015 Weblogicx India</copyright>
10
<license>GNU General Public License v2</license>
11
<description>PLG_J2STORE_APP_DONATION_DESC</description>
12
<files>
13
<filename plugin="app_example">app_example.php</filename>
14
<folder>app_example</folder>
15
<folder>languages</folder>
16
<filename>index.html</filename>
17
</files>
18
<languages>
19
<language tag="en-GB">languages/en-GB.plg_j2store_app_example.ini</language>
20
</languages>
21
<config>
22
<fields name="params">
23
<fieldset name="basic" label="J2STORE_BASIC_SETTINGS"
24
addfieldpath="/administrator/components/com_j2store/models/fields">
25
26
</fieldset>
27
</fields>
28
</config>
29
</extension>
Copied!
Creating app class
Make sure the name of the class suffix is same as your app file’s name. And it should extend the J2StoreAppPlugin class.
1
defined('_JEXEC') or die('Restricted access');
2
require_once(JPATH_ADMINISTRATOR.'/components/com_j2store/library/plugins/app.php');
3
class plgJ2StoreApp_Example extends J2StoreAppPlugin
4
{
5
/**
6
* @var $_element string Should always correspond with the plugin's filename,
7
* forcing it to be unique
8
*/
9
var $_element = 'app_example';```
10
11
This file should have following two methods:
12
13
**onJ2StoreGetAppView** - This method is used to check if it is a app_example or not.
14
15
viewList - A controller for this plugin.
16
```$html = $this->_getLayout('default', $vars);```
17
18
The above line will call the template layout for the app_example from /app_example/app_example/tmpl/default.php
19
20
**App Model Class**
21
22
App's model should have file named with appexample.php and it should be like below
Copied!
defined(’JEXEC’) or die(‘Restricted access’); requireonce (JPATHADMINISTRATOR . ‘/components/comj2store/library/appmodel.php’); class J2StoreModelAppExample extends J2StoreAppModel {
1
public $_element = 'app_example';
Copied!
}
1
**App controller**
2
3
Controller.php file should be located in /app_donation/app_donation/controller.php and you must include the J2Store's library appcontroller and it should be written like below
Copied!
defined(’JEXEC’) or die(‘Restricted access’); requireonce(JPATHADMINISTRATOR.’/components/comj2store/library/appcontroller.php’);
class J2StoreControllerAppexample extends J2StoreAppController{
1
var $_element = 'app_example';
Copied!
}
Last modified 1yr ago