Docs For Class BlueBox

$cachefile_content =

[line 110]

Variable that contains cache file content

Tags:

access:

public

Type:

string

[ Top ]

$cacheID =

[line 34]

Variable that contains cache ID

Tags:

access:

public

Type:

int

[ Top ]

$database = "bluebox"

[line 23]

Variable that contains database name

Tags:

access:

public

Type:

string

[ Top ]

$debug = false

[line 127]

Variable that contains debug switch

Tags:

access:

public

Type:

bool

[ Top ]

$error =

[line 132]

Variable that contains returned errors array

Tags:

access:

public

Type:

array

[ Top ]

$filename =

[line 94]

Variable that contains filename of the cache

Tags:

access:

public

Type:

string

[ Top ]

$filetypeID = 0

[line 69]

Variable that contains file type ID

Tags:

access:

public

Type:

int

[ Top ]

$from_filesize = 0

[line 74]

Variable that contains from octal filesize

Tags:

access:

public

Type:

int

[ Top ]

$from_ts = 0

[line 59]

Variable that contains from timestamp date

Tags:

access:

public

Type:

int

[ Top ]

$query_ts =

[line 84]

Variable that contains query timestamp date

Tags:

access:

public

Type:

int

[ Top ]

$query_url =

[line 89]

Variable that contains query url

Tags:

access:

public

Type:

string

[ Top ]

$request_result =

[line 100]

Variable that contains query result on search in DB

Tags:

access:

public

Type:

array

[ Top ]

$result =

[line 121]

Variable that contains result of query

Tags:

access:

public

Type:

array

[ Top ]

$search_method =

[line 44]

Variable that contains search method (OR, AND)

Tags:

access:

public

Type:

string

[ Top ]

$search_str =

[line 39]

Variable that contains search string

Tags:

access:

public

Type:

string

[ Top ]

$siteID = 0

[line 54]

Variable that contains site ID

Tags:

access:

public

Type:

int

[ Top ]

$stockage_method = "XML"

[line 105]

Variable that contains method to be used to stock cache

Tags:

access:

public

Type:

string

[ Top ]

$strict = false

[line 49]

Variable that contains switch defining if search must be strict or not

Tags:

access:

public

Type:

bool

[ Top ]

$table = "cache_control"

[line 28]

Variable that contains table name

Tags:

access:

public

Type:

string

[ Top ]

$to_filesize = 0

[line 79]

Variable that contains to octal filesize

Tags:

access:

public

Type:

int

[ Top ]

$to_ts = 0

[line 64]

Variable that contains to timestamp date

Tags:

access:

public

Type:

int

[ Top ]

constructor __construct [line 149]

BlueBox_CacheControl __construct(
)

Construction function

This function is used when object is generated. It places the right values from DB in each variables.

<?php
$oBB_CacheControl = new BlueBox_CacheControl();
?>

Tags:

since:	Version 1.0
uses:	BlueBox_Config::ValueByName()

[ Top ]

method CacheFile_Creation [line 348]

bool CacheFile_Creation(
string
$this->search_str, string
$this->search_method, int
$this->siteID, string
$this->cachefiles_directory)

Cache file creation function

This function is used to generates cache file content Result is returned

<?php
$oBB_CC = new BlueBox_CacheControl();
$oBB_CC->search_str = $searchstr;
$oBB_CC->search_method = "AND";
$oBB_CC->siteID = 1;
echo $oBB_CC->CacheFile_Creation();
// 1
?>

Tags:

return:	true when function has encountered success
since:	Version 1.0
usedby:	BlueBox_CacheControl::InsertQuery()
uses:	BlueBox_CacheControl::MD5_Creation()
uses:	BlueBox_CacheControl::InsertQuery()
uses:	BlueBox_CacheControl::CacheFile_Generation()

Parameters:

string	$this->search_str	search string (required)
string	$this->search_method	search method (required)
int	$this->siteID	ID of the site (required)
string	$this->cachefiles_directory	directory where to put the cache files (required)

[ Top ]

method CacheFile_Generation [line 268]

void CacheFile_Generation(
array
$this->request_result, string
$this->stockage_method)

Database searching function

This function is used to generates cache file content Result is stored in $this->cachefile_content

<?php
$oBB_CC = new BlueBox_CacheControl();
$oBB_CC->request_result = $aResults;
$oBB_CC->CacheFile_Generation();
echo $oBB_CC->cachefile_content;
// cachefilecontent
?>

Tags:

since:	Version 1.0
usedby:	BlueBox_CacheControl::CacheFile_Creation()

Parameters:

array	$this->request_result	array containing cache content (required)
string	$this->stockage_method	way to store the data

[ Top ]

method CheckFile [line 554]

int CheckFile(
string
$this->filename, string
$this->cachefiles_directory)

File check function

This function is used to check if cache file exists and suppresses DB entry if cache file is not present Result is returned

<?php
$oBB_CC = new BlueBox_CacheControl();
$oBB_CC->filename = $filename;
echo $oBB_CC->CheckFile();
// 1
?>

Tags:

return:	ID of the deleted row
since:	Version 1.0
uses:	BlueBox_CacheControl::InDB()

Parameters:

string	$this->filename	filename
string	$this->cachefiles_directory	directory that contains cachefiles

[ Top ]

method InDB [line 186]

bool InDB(
string
$this->search_str, string
$this->search_method, int
$this->siteID)

Database searching function

This function is used to search in database if query exists Result is returned

<?php
$oBB_CC = new BlueBox_CacheControl();
$oBB_CC->search_str = $searchstr;
$oBB_CC->search_method = "AND";
$oBB_CC->siteID = 1;
echo $oBB_CC->InBB();
// 1
?>

Tags:

return:	True if is in database
since:	Version 1.0
usedby:	BlueBox_CacheControl::CheckFile()
usedby:	BlueBox_CacheControl::InsertQuery()
uses:	BlueBox_CacheControl::SortSearch_str()
uses:	BlueBox_CacheControl::MD5_Creation()
uses:	MySQL::SelectRow()

Parameters:

string	$this->search_str	text corresponding to text entered (required)
string	$this->search_method	used searched method (required)
int	$this->siteID	ID of the site to be searched in (required)

[ Top ]

method InsertQuery [line 494]

int InsertQuery(
string
$this->search_str, string
$this->search_method, int
$this->siteID)

Query insertion function

This function is used to create an entry in table to identify that query has been executed Result is returned

<?php
$oBB_CC = new BlueBox_CacheControl();
$oBB_CC->search_str = $searchstr;
$oBB_CC->search_method = "AND";
$oBB_CC->siteID = 1;
echo $oBB_CC->InsertQuery();
// 12
?>

Tags:

return:	ID of the inserted row
since:	Version 1.0
usedby:	BlueBox_CacheControl::CacheFile_Creation()
uses:	MySQL::InsertDatas()
uses:	BlueBox_CacheControl::InDB()
uses:	BlueBox_CacheControl::CacheFile_Creation()

Parameters:

string	$this->search_str	search string (required)
string	$this->search_method	search method (required)
int	$this->siteID	ID of the site (required)

[ Top ]

method MD5_Creation [line 424]

string MD5_Creation(
string
$this->search_str, string
$this->search_method, int
$this->siteID)

MD5 generation function

This function is used to generates a md5 string for query Result is returned

<?php
$oBB_CC = new BlueBox_CacheControl();
$oBB_CC->search_str = $searchstr;
$oBB_CC->search_method = "AND";
$oBB_CC->siteID = 1;
echo $oBB_CC->MD5_Creation();
// generatedmd5
?>

Tags:

return:	md5 string
since:	Version 1.0
usedby:	BlueBox_CacheControl::CacheFile_Creation()
usedby:	BlueBox_CacheControl::InDB()

Parameters:

string	$this->search_str	search string (required)
string	$this->search_method	search method (required)
int	$this->siteID	ID of the site (required)

[ Top ]

method ParseCache [line 602]

array ParseCache(
string
$this->filename, string
$this->cachefiles_directory, string
$this->stockage_method)

File check function

This function is used to open and parse the cache file Result is returned

<?php
$oBB_CC = new BlueBox_CacheControl();
$oBB_CC->filename = $filename;
print_r($oBB_CC->ParseCache());
// cachecontent
?>

Tags:

return:	array containing results
since:	Version 1.0
uses:	Files::GetExtensionByFilename()

Parameters:

string	$this->filename	filename (required)
string	$this->cachefiles_directory	directory that contains cachefiles
string	$this->stockage_method	stockage method

[ Top ]

method SortSearch_str [line 235]

void SortSearch_str(
string
$this->search_str)

Database searching function

This function is used to sort search string in manner to have "Blue Box" reacting exactly like "Box Blue" Result is stored in $this->search_str

<?php
$oBB_CC = new BlueBox_CacheControl();
$oBB_CC->search_str = $searchstr;
echo $oBB_CC->SortSearch_str();
// $sortedsearchstr
?>

Tags:

since:	Version 1.0
usedby:	BlueBox_CacheControl::InDB()

Parameters:

string

$this->search_str

text corresponding to text entered (required)

[ Top ]

Class: BlueBox_CacheControl

Class Overview

Author(s):

Version:

Variables

Methods

Class Details

Tags:

Class Variables

$cachefile_content =

Tags:

$cacheID =

Tags:

$database = "bluebox"

Tags:

$debug = false

Tags:

$error =

Tags:

$filename =

Tags:

$filetypeID = 0

Tags:

$from_filesize = 0

Tags:

$from_ts = 0

Tags:

$query_ts =

Tags:

$query_url =

Tags:

$request_result =

Tags:

$result =

Tags:

$search_method =

Tags:

$search_str =

Tags:

$siteID = 0

Tags:

$stockage_method = "XML"

Tags:

$strict = false

Tags:

$table = "cache_control"

Tags:

$to_filesize = 0

Tags:

$to_ts = 0

Tags:

Class Methods

constructor __construct [line 149]

Tags:

method CacheFile_Creation [line 348]

Tags:

Parameters:

method CacheFile_Generation [line 268]

Tags:

Parameters:

method CheckFile [line 554]

Tags:

Parameters:

method InDB [line 186]

Tags:

Parameters:

method InsertQuery [line 494]

Tags:

Parameters:

method MD5_Creation [line 424]

Tags:

Parameters:

method ParseCache [line 602]

Tags:

Parameters:

method SortSearch_str [line 235]

Tags:

Parameters: