PluginConfig library. More...
Public Member Functions | |
| __construct ($name, &$plugin) | |
| install () | |
| uninstall () | |
| init_config () | |
| add_newItem ($name, $type, $default=null) | |
| initialise () | |
| get () | |
| save () | |
| delete () | |
| reset () | |
| check_data () | |
| get_fromHeader () | |
| get_value ($param='', $default=false) | |
| get_translation ($str, $args=null) | |
| load_fromSession () | |
| save_toSession () | |
| delete_fromSession () | |
Public Attributes | |
| $object_type = 'PluginConfig' | |
| Object type description. More... | |
| $_libName | |
| PluginConfig name. More... | |
| $_libParent | |
| Object parent plugin. More... | |
| $_libItems = array() | |
| Object item list. More... | |
| $_libDesc | |
| Object description. More... | |
| $_libError = '' | |
| Object last error. More... | |
| $name | |
| Object name. More... | |
| $vars = null | |
| Object values. More... | |
Protected Attributes | |
| $_libFolder | |
| Folder where object are stored. More... | |
| $_libFile | |
| Stored file for object. More... | |
Detailed Description
PluginConfig library.
Engine / Object Library
- Version
- 1.0.1
- Date
- Creation: Oct 2017
- Modification: Jan 2023
- Copyright
- 2017 - 2023 CaMykS Team
- Note
- This program is distributed as is - WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. PluginConfig class.
Constructor & Destructor Documentation
◆ __construct()
| PluginConfig::__construct | ( | $name, | |
| & | $plugin | ||
| ) |
Class constructor.
- Parameters
-
string $name Plugin $plugin
Reimplemented in Admin_UserConfig, Admin_SystemUniqueIDManagerConfig, Admin_SystemNotificationsConfig, Admin_SystemLogManagerConfig, Admin_StatisticsSettings, Admin_SiteReportConfig, Admin_SecurityUAFilterConfig, Admin_SecurityToolsConfig, Admin_GooglePoIMapManagerConfig, Admin_GenericMediaLibraryManagerConfig, Admin_GenericGuestBookManagerConfig, Admin_GenericEmailingManagerEmailingConfig, Admin_GenericEmailingManagerContactsImportConfig, Admin_GenericEmailingManagerConfig, Admin_GenericDownloadManagerConfig, Admin_GenericContactFormManagerConfig, Admin_GenericBlogsManagerConfig, Admin_ContentPageConfig, SystemPayPaymentConfig, StripePaymentConfig, SpamCheckerConfig, SocialNetworksSharingPanelConfig, SiteMonitoringToolbarConfig, ScelliusPaymentConfig, ReCaptchaConfig, PayZenPaymentConfig, PayBoxPaymentConfig, MoneticoPaiementConfig, LimonetikPaymentConfig, IPGeolocatorConfig, GoogleAnalyticsConfig, GenericSitemapGeneratorConfig, GenericMediaPopupConfig, CrispChatConfig, CookieAgreementMessageConfig, CodeAuthenticatorConfig, ClicAndPayPaymentConfig, and ModuleConfig.
Member Function Documentation
◆ install()
| PluginConfig::install | ( | ) |
Install object.
- Returns
- boolean
◆ uninstall()
| PluginConfig::uninstall | ( | ) |
Uninstall object.
- Returns
- boolean
◆ init_config()
| PluginConfig::init_config | ( | ) |
◆ add_newItem()
| PluginConfig::add_newItem | ( | $name, | |
| $type, | |||
$default = null |
|||
| ) |
◆ initialise()
| PluginConfig::initialise | ( | ) |
Initialise object with default values.
- Returns
- boolean
◆ get()
| PluginConfig::get | ( | ) |
Load object from file.
- Returns
- boolean
◆ save()
| PluginConfig::save | ( | ) |
Save object to file.
- Returns
- boolean
◆ delete()
| PluginConfig::delete | ( | ) |
Delete object file.
- Returns
- boolean
◆ reset()
| PluginConfig::reset | ( | ) |
Reset object into file.
- Returns
- boolean success
◆ check_data()
| PluginConfig::check_data | ( | ) |
Check object items values.
- Returns
- boolean
Reimplemented in Admin_GenericEmailingManagerEmailingConfig.
◆ get_fromHeader()
| PluginConfig::get_fromHeader | ( | ) |
Load object items values from header.
- Returns
- void
Reimplemented in Admin_SystemNotificationsConfig, Admin_ContentPageConfig, SpamCheckerConfig, and CookieAgreementMessageConfig.
◆ get_value()
| PluginConfig::get_value | ( | $param = '', |
|
$default = false |
|||
| ) |
Return value.
- Parameters
-
string $param mixed $default
- Returns
- mixed
◆ get_translation()
| PluginConfig::get_translation | ( | $str, | |
$args = null |
|||
| ) |
Return locale
- Parameters
-
string $str mixed $args
- Returns
- string
◆ load_fromSession()
| PluginConfig::load_fromSession | ( | ) |
Load object data from session.
- Returns
- void
◆ save_toSession()
| PluginConfig::save_toSession | ( | ) |
Save object data in session.
- Returns
- void
◆ delete_fromSession()
| PluginConfig::delete_fromSession | ( | ) |
Delete object from session.
- Returns
- void
Member Data Documentation
◆ $object_type
| string PluginConfig::$object_type = 'PluginConfig' |
Object type description.
◆ $_libName
| string PluginConfig::$_libName |
PluginConfig name.
◆ $_libParent
| Object PluginConfig::$_libParent |
Object parent plugin.
◆ $_libItems
| array PluginConfig::$_libItems = array() |
Object item list.
◆ $_libDesc
| string PluginConfig::$_libDesc |
Object description.
◆ $_libFolder
|
protected |
Folder where object are stored.
◆ $_libFile
|
protected |
Stored file for object.
◆ $_libError
| string PluginConfig::$_libError = '' |
Object last error.
◆ $name
| string PluginConfig::$name |
Object name.
◆ $vars
| array PluginConfig::$vars = null |
Object values.
The documentation for this class was generated from the following file:
- CaMykS/engine/lib/object/PluginConfig.php.inc
