>> YANA 4 PHP Framework >> Docs For Class plugin_config

Class plugin_config

Description

Configration menu

This plugin provides the basic administration menu and interfaces to create custom profile settings.

  • access: public

Located in /plugins/config/plugin_config.php

Plugin
   |
   --plugin_config
Method Summary

Methods

Display "about" screen
boolean about (
array $ARGS
)
List of parameters:
Name Type Description
$ARGS array array of params passed to the function
Description:

parameters taken:

  • string type on of "plugin"|"skin"|"language"
  • string target name of file that contains information

  • access: public
event handler
boolean config_create_profile (
array $ARGS
)
List of parameters:
Name Type Description
$ARGS array array of params passed to the function
Description:
  • access: public
event handler
boolean config_usermode (
array $ARGS
)
List of parameters:
Name Type Description
$ARGS array array of params passed to the function
Description:

this function does not expect any arguments

  • access: public
create a menu to edit default settings of the framework
bool get_config_default (
array $ARGS
)
List of parameters:
Name Type Description
$ARGS array ignored
Description:

this function does not expect any arguments

  • access: public
create a menu to edit profile settings
bool get_config_profile (
array $ARGS
)
List of parameters:
Name Type Description
$ARGS array ignored
Description:

this function does not expect any arguments

Note: if no profile specific settings are available, the framework automatically falls back to its default settings.

  • access: public
create administration panel
bool index (
array $ARGS
)
List of parameters:
Name Type Description
$ARGS array ignored
Description:

this function does not expect any arguments

  • access: public
refresh the plugin cache
bool refresh_pluginlist (
array $ARGS
)
List of parameters:
Name Type Description
$ARGS array ignored
Description:

this function does not expect any arguments

Use this after you installed / uninstalled a plugin to refresh the cache.

  • access: public
Activate / deactivate plugins
bool save_pluginlist (
array $ARGS
)
List of parameters:
Name Type Description
$ARGS array ignored
Description:

This computes the user form data provided by $_POST. Where the provided key is the id of a plugin and the value is wether bool(true) to activate or bool(false) to deactive the plugin.

Note: it does'nt matter here, if a plugin named $key really exists, since the PluginManager-Class does this checking for us.

parameters taken:

  • array plugins new list of active plugins
  • array pluginlist list of all plugins

Expected outcome:

Plugins in $pluginlist not mentioned in $plugins are deactivated and vice versa.

  • access: public
save form data to the frameworks default configuration
bool set_config_default (
array $ARGS
)
List of parameters:
Name Type Description
$ARGS array user form data
Description:

This function may be used by other plugins to provide configuration menus with practically no coding. See manual cookbook for an example.

  • access: public
save form data to the current profile's configuration
bool set_config_profile (
array $ARGS
)
List of parameters:
Name Type Description
$ARGS array user form data
Description:

This function may be used by other plugins to provide configuration menus with practically no coding. See manual cookbook for an example.

  • access: public
inherited from base classes

Inherited From Plugin

Documentation generated on Sun, 11 Mar 2007 15:02:52 +0100 by phpDocumentor 1.3.1

yana author: Thomas MeyerHomepage: www.yanaframework.net