...
Apps Configuration
...
Requires:
...
phpFox 4.5+
...
Code Block |
---|
...
|
...
|
...
...
<?php namespace Apps\PHPfox_Core; use Core\App; use Core\App\Install\Setting; class Install extends App\App { protected function setId() { $this->id = 'PHPfox_Core';//Set ID for your app. This action is required. } protected function setSupportVersion() { $this->start_support_version = '4.4.0';//Start support version $this->end_support_version = '4.5.0';//End support version } protected function setAlias() { |
...
//Set alias for your app } protected function setName() { $this->name = 'phpFox Core';//Set Name for your app, this name will display in manage apps (admincp) } protected function setVersion() { $this->version = '4.0.1';//Set version for your app } protected function setSettings() { //Define settings for your app } protected function setUserGroupSettings() { |
...
//Define user group settings for your app } protected function setComponent() { |
...
//Define component for your app } protected function setComponentBlock() { |
...
//Define component block for your app } protected function setPhrase() { //Add more phrase for your app. However, for mow please define in phrase.json } protected function setOthers() { |
...
//Set other information for your app $this->_publisher = 'phpFox'; //Your company name $this->_publisher_url = 'http://store.phpfox.com/';//Your company website // include your external paths $this->external_paths = [ [ 'path' => 'PF.Base/example_folder' 'removeable => true ], [ 'path' => 'PF.Base/example_file' 'removeable => false ] ]; } } |
These are all information properties you can define for your app:
ID | Define | Type | Note | Version | Required? | |||
---|---|---|---|---|---|---|---|---|
1 | $this->id = "your_app_ id " | String | This is your app ID, it must be the same folder name stored your app. Space is not allowed. This ID can't change. | 2 | $this->alias = "your_app_alias" | 4.5+ | Yes | |
2 | name | String | The name of your app, it will display in manage app in admincp | 4.5+ | Yes | |||
3 | version | String | Version of your app. It has to follow version naming convention. | 4.5+ | Yes | |||
4 | alias | String | This value is used for: admincp url, block name, component name, ajax name,... This value must be lower case and no space. If your app is simple, this value can be empty. | |||||
3 | $this->name = "your app name" | The name of your app, it will display in manage app in admincp | ||||||
4 | $this->version = "your.app.version" | Version of your app. It has to follow version naming convention. | 5 | $this->icon = "your_app_icon" | .5+ | No | ||
5 | icon | String | Define Icon of your app. We support 3 ways to define your app icon: | Image link: Put image link of your icon here. | Font awesome class: Put font awesome class here: it will display icon from font awsome. | Icon image: Don't set or set empty this value, we will get file "icon.png" | 4.5+ | No |
6 | $this->admincpadmincp_route | = "default admincp route"String | Default page of your app in admincp | 4.5+ | No | |||
7 | $this->admincpadmincp_menu | = []String | Your app menu in admincp | 4.5+ | No | |||
8 | $this->admincpadmincp_help | 9 | $this->admincpString | You can help admin by providing your instructions external and add your url here. | 4.5+ | No | ||
9 | admincp_action_menu | |||||||
10 | $this->map | |||||||
11 | $this->map_search | |||||||
12 | $this->menu | String | Action button of your app in admincp (The top right button) | 4.5+ | No | |||
10 | map | String | Support search in feed | 4.5+ | No | |||
11 | map_search | String | Support search in feed | 4.5+ | No | |||
12 | menu | Array | Add a menu for your app on main menu bar | 4.5+ | No | |||
13 | $this->settingssettings | Array | Your app's settings | 4.5+ | No | |||
14 | $this->useruser_group_settings | Array | Your app's | user user groups settings | ||||
15 | $this->notification | |||||||
16 | $this->database | database table for your app | ||||||
17 | $this->component | |||||||
18 | $this->component_block | |||||||
19 | $this->routes | |||||||
20 | $this->start_support_version | Older4.5+ | No | |||||
15 | database | Array | Define database structure for your app | 4.5+ | No | |||
16 | component | Array | App's components | 4.5+ | No | |||
17 | component_block | Array | Default blocks | 4.5+ | No | |||
18 | component_block_remove | Array | Old blocks that you want to remove on upgrade your app | 4.5.2+ | No | |||
19 | start_support_version | String | Oldest phpFox version your app can support | 21 | $this->end4.5+ | No | ||
20 | end_support_version | Latest String | Newest phpFox version your app can support | |||||
22 | $this->phrase | advanced phrases | ||||||
23 | $this->_publisher | 4.5+ | No | |||||
21 | phrase | Array | Advanced phrases | 4.5+ | No | |||
22 | _publisher | String | Your company name | 24 | $this->4.5+ | No | ||
23 | _publisher_url | String | Your company home page | 25 | $this->4.5+ | No | ||
24 | _apps_dir | String | Your app directory name | 4.5+ | No | |||
25 | _admin_cp_menu_ajax | Boolean | Set true: menu in | adincp admincp will load by ajax; false: menu will load by refresh page. Default is true |
Define in bold is required
4.5+ | No | ||||
26 | _writable_dirs | Array | List all directories that your app need writable permission | 4.5.3+ | No |
27 | external_paths | Array | List all your external directories/files that outside your app folder. You also can define which files/directories will be removed when uninstall your app. | 4.5.3+ | No |