Search »

$module->getSettings()

Module Development (Form Tools 3)

Anatomy of a Module
Lifecycle Methods
Database Tables and Data
Module Navigation
Displaying your Pages
Helper Methods
Hooks
Common Tasks
Example Modules

This function is the sister of $module->setSettings() described previously. It retrieves values stored in the database for your module. It accepts a single parameter: a string of the setting name (key), or an array of strings if you want to retrieve multiple values. For example:

// getting a single value
$age = $module->getSettings("age");

// getting multiple values
$info = array("age", "name");
list($age, $name) = $module->getSettings($info);

The $module->setSettings() and $module->getSettings() functions are good for small snippets of data. If you need to store larger quantities of data, we recommend you create your own database table.

DOCUMENTATION

Module Development (Form Tools 3)