Docs For Class BP_Transients

Interface BP_Transients_Interface

Description

Interface for BP_Transients;

A BP_Transients class must be implemented by the host application for BackPress to operate. This interface supplies a boilerplate for that class but can only be implemented in PHP 5 environments.

since: r205

Located in /includes/interface.bp-options.php (line 91)

Method Summary

void delete (string $transient)

void get (string $transient)

void prefix ()

void set (string $transient, mixed $value, [integer $expiration = 0])

Methods

delete (line 127)

Deletes an existing transient.

since: r205

void delete (string $transient)

string $transient: Transient name.

get (line 107)

Retrieve the value of the transient.

since: r205

void get (string $transient)

string $transient: Transient name.

prefix (line 98)

Retrieve the prefix to be appended to the beginning of the transient key.

since: r205

void prefix ()

set (line 118)

Sets the value of a transient with a given value.

since: r205

void set (string $transient, mixed $value, [integer $expiration = 0])

string $transient: Transient name.
mixed $value: Transient value.
integer $expiration: The time in seconds the transient will be held for. Default is 0, meaning it is held indefinitely.

Documentation generated on Fri, 18 May 2012 01:34:02 +0100 by phpDocumentor 1.4.3