class vB_Library_Functions extends vB_Library

vB_Library_Functions

Traits

Properties

static protected $instance from vB_Library
static $lastError

Methods

__sleep()

No description

__wakeup()

No description

__construct()

No description

static vB_PageCache
instance($class)

Returns singleton instance of self.

static 
getLibraryClassNameInternal($controller)

No description

static 
getContentInstance($contenttypeid)

No description

static 
clearCache()

No description

static array
fetchVersionArray(string $version)

Converts a version number string into an array that can be parsed to determine if which of several version strings is the newest.

static bool
isNewerVersion(string $new_version_str, string $cur_version_str, bool $check_same = false)

Compares two version strings.

static 
fileWrite(string $path, string $data, boolean $backup = false)

Writes data to a file

static string
fileRead(string $path)

Returns the contents of a file

static bool
installProduct($product, $path = '', $filename = '', $overwrite = false, $printinfo = false, $deferRebuild = false)

Installs a product from the xml text, currently calls the legacy function

static 
installProductTranslations($product, $productxmldir)

No description

static bool
installProductXML($xml, $overwrite = false, $printinfo = false, $deferRebuild = false)

Installs a product from the xml text, currently calls the legacy function

static 
getLastError()

No description

static 
vbMkdir($path, $mode = 0777)

No description

static string
addSlashesJs(string $text, string $quotetype = "'")

Escapes quotes in strings destined for Javascript (Taken from includes/functions.php)

Details

in vB_Trait_NoSerialize at line 15
__sleep()

in vB_Trait_NoSerialize at line 20
__wakeup()

in vB_Library at line 25
protected __construct()

in vB_Library at line 35
static vB_PageCache instance($class)

Returns singleton instance of self.

Parameters

$class

Return Value

vB_PageCache
  • Reference to singleton instance of the cache handler

in vB_Library at line 52
static protected getLibraryClassNameInternal($controller)

Parameters

$controller

in vB_Library at line 91
static getContentInstance($contenttypeid)

Parameters

$contenttypeid

in vB_Library at line 99
static clearCache()

at line 31
static array fetchVersionArray(string $version)

Converts a version number string into an array that can be parsed to determine if which of several version strings is the newest.

Parameters

string $version Version string to parse

Return Value

array Array of 6 bits, in decreasing order of influence; a higher bit value is newer

at line 124
static bool isNewerVersion(string $new_version_str, string $cur_version_str, bool $check_same = false)

Compares two version strings.

Returns true if the first is newer than the second. Returns true if 'check_same' is set and the versions are equal.

Parameters

string $new_version_str Version string; usually the latest version
string $cur_version_str Version string; usually the current version
bool $check_same Flag to allow check if the versions are the same

Return Value

bool True or False

at line 157
static fileWrite(string $path, string $data, boolean $backup = false)

Writes data to a file

Parameters

string $path Path to file (including file name)
string $data Data to be saved into the file
boolean $backup If true, will create a backup of the file called {filename}.old

at line 187
static string fileRead(string $path)

Returns the contents of a file

Parameters

string $path Path to file (including file name)

Return Value

string If file does not exist, returns an empty string

at line 205
static bool installProduct($product, $path = '', $filename = '', $overwrite = false, $printinfo = false, $deferRebuild = false)

Installs a product from the xml text, currently calls the legacy function

Parameters

$product
$path
$filename
$overwrite
$printinfo
$deferRebuild

Return Value

bool True if the product requires a template merge, false otherwise

at line 248
static installProductTranslations($product, $productxmldir)

Parameters

$product
$productxmldir

at line 284
static bool installProductXML($xml, $overwrite = false, $printinfo = false, $deferRebuild = false)

Installs a product from the xml text, currently calls the legacy function

Parameters

$xml
$overwrite
$printinfo
$deferRebuild

Return Value

bool True if the product requires a template merge, false otherwise

at line 335
static getLastError()

at line 348
static vbMkdir($path, $mode = 0777)

Parameters

$path
$mode

at line 381
static string addSlashesJs(string $text, string $quotetype = "'")

Escapes quotes in strings destined for Javascript (Taken from includes/functions.php)

Parameters

string $text String to be prepared for Javascript
string $quotetype Type of quote (single or double quote)

Return Value

string