Tuskfish API
  • Package
  • Class

Packages

  • content
  • core
  • database
  • installation
  • security
  • user
  • utilities

Classes

  • TfishAncestralObject
  • TfishAngryTree
  • TfishCache
  • TfishFileHandler
  • TfishLogger
  • TfishPreference
  • TfishPreferenceHandler

Functions

  • tfish_autoload

Class TfishPreferenceHandler

Handler class for Tuskfish preference object.

Retrieve and set site configuration data.

Package: core
Copyright: Simon Wilkinson 2013-2017 (https://tuskfish.biz)
License: GNU General Public License (GPL) V2
Author: Simon Wilkinson simon@isengard.biz
Version: Release: 1.0
Since: 1.0
Located at trust_path/libraries/tuskfish/class/TfishPreferenceHandler.php

Methods summary

public
# __construct( TfishPreference $tfish_preferences )

Initialise default property values.

Initialise default property values.

Parameters

$tfish_preferences
Instance of TfishPreference class, holds site preference info.
public static mixed|null
# get( string $pref )

Get the value of a particular site preference.

Get the value of a particular site preference.

Parameters

$pref
Name of preference.

Returns

mixed|null
Value of preference if it exists, otherwise null.
public static boolean
# updatePreferences( TfishPreference $obj )

Updates the site preferences in the database.

Updates the site preferences in the database.

Parameters

$obj
TfishPreference object.

Returns

boolean
True on success false on failure.
Tuskfish API API documentation generated by ApiGen