Call Provider Get

This executes the get() method of a certain Gadget_Provider and returns the results of the method call. Note that the arguments will be passed to call_user_func_array().

• access: public
• static:
• see: Gadget::provider(), Gadget::callProviderSet(), Gadget_Provider

• string $provider: The provider to instantiate.
• array $args: Argument to pass through to Gadget_Provider::get()

Current User

Retreive an attribute of the current user (defaults to users id). If $get === true the users DataObject will be returned. Returns 0 if the user is anonym.

• access: public
• static:
• see: Gadget_Provider_Currentuser, Gadget::setCurrentUser()

• mixed $get: The name of the attribute or true for the whole user object.

Remove Params from QueryString

This operates directly on $_SERVER['QUERY_STRING'] and removes parameters specified by $params. This is very useful if you ise Apache's mod_rewrite or similar hooks to prettify URLs. It returns the modifed query string.

  // assume that the pretty URI /home/user/mike?a=1&b=3
// will be rewritten to /home.php?user=mike&a=1&b=3
  
  Gadget::delQ(array('user'));
  // now the query string can be appended to

• return: modifed query string
• access: public
• static:
• see: Gadget_Widget::$queryString

• array $params: Array of URL parameters to remove.
• bool $persistent: Whether to write the modified query string back to $_SERVER['QUERY_STRING'].

Get Config

Retreive a configuration setting. In the default setup where Gadget_Provider_Configuration is used, the settings are stored within a plain INI file. Define the GADGET_CONFIG constant to point to your INI configuration file.

• access: public
• static:
• see: Gadget_Provider_Configuration, Gadget::setConf()

• string $conf: Configuration section
• string $part: Configuration directive

Get Preferences

Retreive a preferences item or all preferences if $pref is NULL. If the user has no preferences yet or the user is anonym the default preferences (defined by configuration) are being returned.

• access: public
• static:
• see: Gadget_Provider_Preferences, Gadget::setPref()

• string $pref: Preferences item

Handle PEAR Error

• access: public
• static:

• object PEAR_Error $e

Locale

This returns the I18Nv2_Locale instance configured with the locale/language retreived by Gadget::getPref('language').

• access: public
• static:
• see: Gadget::persistenObject(), I18Nv2 (http://pear.php.net/I18Nv2)

Log

• access: public
• static:

• string $source
• mixed $message

Logout

Performs the logout task. It'll regenerate the session id, delete all session variables and finally destroy the session. It will further disable autologin (delete the autologin cookie) and redirect to the home page.

• access: public

New Widget

This will instantiate and return a new widget $widget, configured by $options. You need to have a directory named "Widgets" in your include path where your custom widgets reside. If called only with one parameter being an array, a Gadget_Widget will be returned and the first parameter will be passed through to Gadget_Widget::setOptions().

• access: public
• static:
• see: Gadget, Gadget::start(), Gadget::finish(), Gadget_Widdget, Gadget_Widget::create()

• mixed $widget
• array $options

Add Error Mode

Add error mode to the actual error handling. Returns the previous error mode.

• return: Previous error mode (bitmask).
• access: public
• static:
• see: Gadget::onError()

• int $mode: Error mode to add (bitmask).

Create an persistent Object

This is a general purpose singleton, which can instantiate classes named after the PEAR coding standard or from file $file. Note that objects instantiated through this method are kept alive and may be used after their first instantiation. Also note that these classes may only require one construction parameter.

• access: public
• static:

• string $class
• mixed $params
• string $file

Provider

Provider singleton. Returns *the* instance of a certain Gadget_Provider object. It's basically a shorthand for:

  require_once 'Gadget/Provider.php';
  Gadget_Provider::singleton($provider);

• access: public
• static:
• see: Gadget_Provider

• string $provider: Name of the Provider.

Service

Service singleton. Returns *the* instance of a certain Gadget_Service object. It's basically a shorthand for:

  require_once 'Gadget/Service.php';
  Gadget_Service::singleton($service);

• access: public
• static:
• see: Gadget_Service

• string $service: Name of the Service.

Set Current User

Set the current user through its id.

• access: public
• static:
• see: Gadget_Provider_Currentuser, Gadget::currentUser()

• int $id: Users id.

Start

This starts Gadget and is usually called at the very beginning of your page/script. It does the following in right this order:

• define TIME constant holding the current unix timestamp
• sets a cookie named "first" if not already set
• filter multiple ampersands (&&&) from the query string
• retreives the configured error modes (triggers the configuration provider to read in the configuration)
• calls Gadget::onError() to set configured error handling actions (triggers PEAR::setErrorHandling(PEAR_ERROR_CALLBACK))
• start a PHP session
• runs the security service
• runs the autologin service
• negotiates I18N through HTTP
• querys the caching provider
• instantiates and returns the PageHeader widget unless $header is FALSE

  require_once 'Gadget.php';
  $header = &Gadget::start();
  // or
// Gadget::start();
  // $header = &Gadget::header();
  
  $header->addStyleSheet('about');
  Gadget::newWidget(array('template' => 'about.html'));
  Gadget::finish();

• access: public
• static:
• see: Gadget::header(), Gadget::finish(), Gadget_Widget, PageHeader

• bool $header
• array $headerOptions

Timer

Returns the time difference from Gadget::start() to the point of calling.

• access: public