Docs For Class XTKeyword

Description

Manage mother class to manage differents keywords

author: SimpliciWeb
version: $Id: xt_keyword.class.php 602 2007-07-18 16:18:38Z stephanet $

Located in /core/internal_components/admin_sites/t_keyword/xt_keyword.class.php (line 57)

Direct descendents

Class	Description
TKeywordTPage	Manage the keywords for pages

Variable Summary

array $m_max_keyword

DbConnexion $m_object_dbconnexion

Format $m_object_format

array $m_r_type

array $m_type

string $req_count

string $req_delete

string $req_delete_in_mass

string $req_insert

string $req_select

string $req_select_by_primary_key

string $req_select_list

string $req_update

Method Summary

XTKeyword XTKeyword ()

bool exist ( &$r_is_existing, integer $p_pk_key_number, string $p_pk_key_type, integer $p_pk_key_id, bool $r_is_existing)

bool getCount ( &$r_result_count, integer $r_result_count)

bool getOne ( &$r_result, integer $p_pk_key_number, string $p_pk_key_type, integer $p_pk_key_id, array $r_result)

bool insertList ( &$p_key_list, array $p_key_type, integer $p_page_id, &$r_keyword_string, array $p_key_list, string $r_keyword_string)

bool linearize ( &$p_input_list, &$r_linearize_list, array $p_input_list, array $r_linearize_list)

bool xDelete (integer $p_pk_key_id, string $p_pk_key_type, &$r_nb_row_affected, integer $r_nb_row_affected)

bool xDeleteInMass (array $p_list_id, string $p_pk_key_type, &$r_nb_row_affected, integer $r_nb_row_affected)

bool xGetList (integer $p_page_id, string $p_key_type, &$r_result, array $r_result)

bool xIsNotValidKeyId (string $p_value)

bool xIsNotValidKeyNumber (string $p_value)

bool xIsNotValidKeyTitle (string $p_value)

bool xIsNotValidKeyType (string $p_value)

void xRowToArray (array $p_row, &$r_result, array $r_result)

bool xUpdate (integer $p_pk_key_id, &$p_key_list, string $p_pk_key_type, &$r_linear_keyword, array $p_key_list, string $r_linear_keyword)

Variables

array $m_max_keyword = array() (line 106)

DbConnexion $m_object_dbconnexion = NULL (line 87)

Database Connexion object

Format $m_object_format = NULL (line 81)

Format Object

array $m_r_type = array() (line 100)

List of type reversed

array $m_type = array() (line 94)

List of type

string $req_count = "SELECT COUNT(*)
FROM t_keyword;" (line 131)

SQL Request : Count

string $req_delete = "DELETE
FROM t_keyword
WHERE key_type = '%s' AND key_id = %d;" (line 150)

SQL Request : Delete

string $req_delete_in_mass = "DELETE
FROM t_keyword
WHERE key_type = '%s' AND key_id IN %s;" (line 158)

SQL Request : Delete in mass

string $req_insert = "" (line 138)

SQL Request : Insert

string $req_select = "SELECT key_number, key_type, key_id, key_title_l1,
key_title_l2, key_title_l3, key_title_l4, key_title_l5
FROM t_keyword ORDER BY @TOCHANGE@;" (line 123)

SQL Request : Select

string $req_select_by_primary_key = "SELECT key_number, key_type, key_id, key_title_l1,
key_title_l2, key_title_l3, key_title_l4, key_title_l5
FROM t_keyword
WHERE key_number = %d AND key_type = '%s' AND key_id = %d;" (line 114)

SQL Request : Select by primary key

string $req_select_list = "" (line 144)

SQL Request : Select list

string $req_update = "UPDATE t_keyword
SET key_title_l1='%s', key_title_l2='%s'
, key_title_l3='%s', key_title_l4='%s', key_title_l5='%s'
WHERE key_number = %d AND key_type = '%s' AND key_id = %d;" (line 166)

SQL Request : Update

Methods

Constructor XTKeyword (line 178)

Constructor, init the requests and objects

XTKeyword XTKeyword ()

exist (line 316)

Test if exist

return: TRUE on error

bool exist ( &$r_is_existing, integer $p_pk_key_number, string $p_pk_key_type, integer $p_pk_key_id, bool $r_is_existing)

bool $r_is_existing
integer $p_pk_key_number
string $p_pk_key_type: enum('PA', 'RA', 'PR')
integer $p_pk_key_id
&$r_is_existing

getCount (line 288)

Count

return: TRUE on error

bool getCount ( &$r_result_count, integer $r_result_count)

integer $r_result_count
&$r_result_count

getOne (line 250)

Get one

return: TRUE on error

bool getOne ( &$r_result, integer $p_pk_key_number, string $p_pk_key_type, integer $p_pk_key_id, array $r_result)

array $r_result
integer $p_pk_key_number
string $p_pk_key_type: enum('PA', 'RA', 'PR')
integer $p_pk_key_id
&$r_result

insertList (line 371)

Insert list

return: TRUE on error

bool insertList ( &$p_key_list, array $p_key_type, integer $p_page_id, &$r_keyword_string, array $p_key_list, string $r_keyword_string)

array $p_key_list
array $p_key_type
integer $p_page_id
string $r_keyword_string
&$p_key_list
&$r_keyword_string

linearize (line 356)

Linearize

return: TRUE on error

bool linearize ( &$p_input_list, &$r_linearize_list, array $p_input_list, array $r_linearize_list)

array $p_input_list
array $r_linearize_list
&$p_input_list
&$r_linearize_list

xDelete (line 470)

Delete

return: TRUE on error
access: private

bool xDelete (integer $p_pk_key_id, string $p_pk_key_type, &$r_nb_row_affected, integer $r_nb_row_affected)

integer $p_pk_key_id
string $p_pk_key_type: enum('PA', 'RA', 'PR')
integer $r_nb_row_affected
&$r_nb_row_affected

xDeleteInMass (line 506)

Delete in mass

return: TRUE on error
access: private

bool xDeleteInMass (array $p_list_id, string $p_pk_key_type, &$r_nb_row_affected, integer $r_nb_row_affected)

array $p_list_id
string $p_pk_key_type: enum('PA', 'RA', 'PR')
integer $r_nb_row_affected
&$r_nb_row_affected

xGetList (line 431)

Get list

return: TRUE on error
access: private

bool xGetList (integer $p_page_id, string $p_key_type, &$r_result, array $r_result)

integer $p_page_id
string $p_key_type: enum('PA', 'RA', 'PR')
array $r_result
&$r_result

xIsNotValidKeyId (line 226)

Parameter Integrity checker

return: TRUE if not valid
access: private

bool xIsNotValidKeyId (string $p_value)

string $p_value

xIsNotValidKeyNumber (line 206)

Parameter Integrity checker

return: TRUE if not valid
access: private

bool xIsNotValidKeyNumber (string $p_value)

string $p_value

xIsNotValidKeyTitle (line 236)

Parameter Integrity checker

return: TRUE if not valid
access: private

bool xIsNotValidKeyTitle (string $p_value)

string $p_value

xIsNotValidKeyType (line 216)

Parameter Integrity checker

return: TRUE if not valid
access: private

bool xIsNotValidKeyType (string $p_value)

string $p_value

xRowToArray (line 336)

Convert a number indexed array to an fieldname indexed array

void xRowToArray (array $p_row, &$r_result, array $r_result)

array $p_row
array $r_result
&$r_result

xUpdate (line 413)

Update

return: TRUE on error
access: private

bool xUpdate (integer $p_pk_key_id, &$p_key_list, string $p_pk_key_type, &$r_linear_keyword, array $p_key_list, string $r_linear_keyword)

integer $p_pk_key_id
array $p_key_list
string $p_pk_key_type: enum('PA', 'RA', 'PR')
string $r_linear_keyword
&$p_key_list
&$r_linear_keyword