The Settings class enables you to get and set Perch settings.

$Settings = $API->get('Settings');


The PerchAPI_Settings class exposes a number of methods

PerchAPI_Settings::set(string $id, string \value)

Sets the setting $id to the value \value.

If you create your own settings within an app, you should prefix the ID with your app ID.

$Settings->set('my_sample_username', 'joesmith');

PerchAPI_Settings::get(string $id)

Gets the setting $id. Returns a PerchSetting object.

PerchSetting Methods

PerchAPI_Settings returns PerchSetting objects, which expose the following methods.


Returns the value of the setting.

echo $Settings->get('my_sample_username')->settingValue();