File Source for xt_page.class.php

<?php /*
*@=@=@=@ START LICENSE @=@=@=@*
Copyright or © or Copr. Stéphane TRICHET and Nicolas SOTRON
stephane.t@simpliciweb.net and nicolas.s@simpliciweb.net
This software is a computer program whose purpose is to make a
web hosting platform
This software is governed by the CeCILL license under French law and
abiding by the rules of distribution of free software. You can use,
modify and/ or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info".
As a counterpart to the access to the source code and rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors have only limited
liability.
In this respect, the user's attention is drawn to the risks associated
with loading, using, modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean that it is complicated to manipulate, and that also
therefore means that it is reserved for developers and experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or
data to be ensured and, more generally, to use and operate it in the
same conditions as regards security.
The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.
*@=@=@=@ END LICENSE @=@=@=@*
*/?><?php
/**
* XTPage Class
*
*
* @author SimpliciWeb
* @version $Id: xt_page.class.php 738 2007-12-05 15:16:46Z nicolas_s $
* @package Common
* @subpackage FrameWork
*/
/**
* Include the ocject cache class
*/
require_once('internal_components/common/cache_class/object_cached.class.php');
/**
* Command part for managing the web page of the front office web site
*
* @author SimpliciWeb
* @version $Id: xt_page.class.php 738 2007-12-05 15:16:46Z nicolas_s $
* @package Common
* @subpackage FrameWork
*/
class XTPage extends ObjectCached {
// member object
/**
* Format Object
*
* @var Format
*/
var $m_object_format = NULL;
/**
* db page level
*
* @var array
*/
var $m_db_page_level = array();
/**
* page id
*
* @var array
*/
var $m_db_page_id = array();
/**
* @var array
*/
var $m_product = array();
/**
* @var array
*/
var $m_r_product = array();
/**
* @var array
*/
var $m_cached = array();
/**
* @var array
*/
var $m_r_cached = array();
/**
* @var array
*/
var $m_visibility = array();
/**
* @var array
*/
var $m_r_visibility = array();
/**
* @var array
*/
var $m_type = array();
/**
* @var array
*/
var $m_r_type = array();
/**
* @var array
*/
var $m_access = array();
/**
* @var array
*/
var $m_r_access = array();
/**
* @var array
*/
var $m_robot = array();
/**
* @var array
*/
var $m_r_robot = array();
/**
* @var array
*/
var $m_distribution = array();
/**
* @var array
*/
var $m_r_distribution = array();
/**
* Set array for translate all plici_page_id in page_id
*
* @var array
*/
var $m_plici_page_id_translate_array = array();
/**
* List separator for stock array in database
*
* Is not private. This symbol is used in request
* @var string
*/
var $m_dbc_dbname_list_separator= "|";
/**
* SQL Request : Get all plici page id not null with page id.
* Usefull to build translate array
*
* @var string
*/
var $req_get_plici_page_id =
"SELECT page_id, plici_page_id
FROM t_page
WHERE plici_page_id IS NOT NULL;";
/**
* Constructor, init the requests and objects
*
* @return XTPage
*/
function XTPage() {
global $g_object_loader;
$this->m_object_format =& $g_object_loader->getFormat();
// Structure
$this->m_db_page_id["SITE"] = 1;
$this->m_db_page_id["ADVANCE"] = 2;
$this->m_db_page_id["NORMAL"] = 3;
$this->m_db_page_id["PARTICULAR"] = 4;
$this->m_db_page_id["INTERNAL"] = 5;
$this->m_db_page_id["TOP"] = 6;
$this->m_db_page_id["BOTTOM"] = 7;
$this->m_db_page_id["LEFT"] = 8;
$this->m_db_page_id["RIGHT"] = 9;
$this->m_db_page_id["TRASH"] = 70;
// Special Page
$this->m_db_page_id["INDEX"] = 10;
$this->m_db_page_id["NOEXIST"] = 11;
$this->m_db_page_id["NOVISIBLE"] = 12;
$this->m_db_page_id["NOACCESS"] = 13;
$this->m_db_page_id["AUTHENTIFICATION"] = 14;
$this->m_db_page_id["NOPRODUCT"] = 28;
$this->m_db_page_id["SHOPPING_CART"] = 30;
$this->m_r_db_page_id = array_flip($this->m_db_page_id);
$this->m_db_page_level["MIN_MENU"] = 1;
$this->m_db_page_level["MAX_MENU"] = 2;
$this->m_db_page_level["CONTAINER"] = $this->m_db_page_level["MAX_MENU"]+1;
$this->m_db_page_level["PAGE"] = $this->m_db_page_level["CONTAINER"]+1;
$this->m_product["YES"] = "Y";
$this->m_product["NO"] = "N";
$this->m_r_product = array_flip($this->m_product);
$this->m_cached["YES"] = "YES";
$this->m_cached["NO"] = "NO";
$this->m_r_cached = array_flip($this->m_cached);
$this->m_visibility["VISIBLE"] = "VI";
$this->m_visibility["HIDDEN"] = "HI";
$this->m_r_visibility = array_flip($this->m_visibility);
$this->m_type["SYSTEM"] = "SY";
$this->m_type["C1"] = "C1";
$this->m_type["INTERNAL"] = "IN"; //C2=IN
$this->m_type["UNIT"] = "UN"; //C3=UN
$this->m_type["CONTAINER"] = "CO";
$this->m_type["SPECIAL"] = "SP"; //C4=SP
$this->m_type["USER"] = "US";
$this->m_type["NO_DELETE"] = "ND";
$this->m_type["MODULE"] = "MO";
$this->m_type["INDEX"] = "IX"; //INDEX
$this->m_r_type = array_flip($this->m_type);
$this->m_access["ALWAYS"]= "AL";
$this->m_access["NEVER"]= "NE";
$this->m_access["LOGIN_PASS"]= "LP";
$this->m_r_access = array_flip($this->m_access);
$this->m_robot[""]="";
$this->m_robot["INDEX, FOLLOW"]="IF";
$this->m_robot["INDEX, FOLLOW, ALL"]="IFA";
$this->m_robot["INDEX, NOFOLLOW"]="IN";
$this->m_robot["INDEX, NOFOLLOW, ALL"]="INA";
$this->m_robot["NOINDEX, FOLLOW"]="NF";
$this->m_robot["NOINDEX, FOLLOW, ALL"]="NFA";
$this->m_robot["NOINDEX, NOFOLLOW"]="NN";
$this->m_robot["NOINDEX, NOFOLLOW, ALL"]="NNA";
$this->m_r_robot = array_flip($this->m_robot);
$this->m_distribution["GLOBAL"] = "GLOBAL";
$this->m_distribution["LOCAL"] = "LOCAL";
$this->m_r_distribution = array_flip($this->m_distribution);
}
// xIsNotValid
// **********
/**
* Parameter Integrity checker
*
* @access private
* @param string $p_value
* @return bool TRUE if not valid
*/
function isNotValidPageId($p_value) {
return $this->m_object_format->isNotUnsignedInteger($p_value, 8);
}
/**
* Parameter Integrity checker
*
* @access private
* @param string $p_value
* @return bool TRUE if not valid
*/
function isNotValidPliciPageId($p_value) {
return $this->m_object_format->isNotVarchar($p_value, 32);
}
/**
* Parameter Integrity checker
*
* @access private
* @param string $p_value
* @return bool TRUE if not valid
*/
function xIsNotValidPageBorder($p_value) {
return $this->m_object_format->isNotUnsignedInteger($p_value, 5);
}
/**
* Parameter Integrity checker
*
* @access private
* @param string $p_value
* @return bool TRUE if not valid
*/
function xIsNotValidPageLevel($p_value) {
return $this->m_object_format->isNotUnsignedInteger($p_value, 3);
}
/**
* Parameter Integrity checker
*
* @access private
* @param string $p_value
* @return bool TRUE if not valid
*/
function xIsNotValidPageLogin($p_value) {
return $this->m_object_format->isNotVarchar($p_value, 16);
}
/**
* Parameter Integrity checker
*
* @access private
* @param string $p_value
* @return bool TRUE if not valid
*/
function xIsNotValidPagePass($p_value) {
return $this->m_object_format->isNotVarchar($p_value, 45);
}
/**
* Return the template name for a link
*
* @param string $p_name
* @return string
*/
function convertLinkDisplayName($p_name) {
if ((isset($p_name)) && (null != $p_name))
{
//Suppression de répertoire detail du chemin des scripts
$tmp = strstr($p_name, "detail/");
$tmp = FALSE === $tmp?$p_name:substr($tmp, strlen("detail/"));
$temp = explode(".", $tmp);
$tmp = str_replace("/","-",$temp[0]);
} else {
$tmp = null;
}
return $tmp;
}
/**
* Translate PLICI_PAGE_ID in page_id
* Return page id for one page identified by plici page id
*
* @param string $p_plici_page_id
* @param array $r_result
* @return bool TRUE on error
*/
function translatePliciPageId($p_plici_page_id, &$r_result)
{
$r_result = -1;
global $g_object_loader;
$g_object_message =& $g_object_loader->getMessage();
// Valid input
onErrorThrow($this->isNotValidPliciPageId($p_plici_page_id), plici_lang("lang_error_internal"));
if ($g_object_message->thereIsAnError()) {
return true;
}
if ((0==count($this->m_plici_page_id_translate_array))
|| (!isset($this->m_plici_page_id_translate_array[$p_plici_page_id])))
{
// Translate table is empty or page is not found
// Reload translate table
$this->xFillPliciPageIdTranslateArray();
}
if (isset($this->m_plici_page_id_translate_array[$p_plici_page_id]))
{
$r_result = $this->m_plici_page_id_translate_array[$p_plici_page_id];
} else {
trigger_error("This PLICI page id :".$p_plici_page_id." is unknow");
}
// Return no error code
return false;
}
/**
* Translate page_id in PLICI_PAGE_ID
* Return plici page id for one page identified by page id
*
* @param integer $p_page_id
* @param array $r_result
* @return bool TRUE on error
*/
function translatePageId($p_page_id, &$r_result)
{
$r_result = -1;
global $g_object_loader;
$g_object_message =& $g_object_loader->getMessage();
// Valid input
onErrorThrow($this->isNotValidPageId($p_page_id), plici_lang("lang_error_internal"));
if ($g_object_message->thereIsAnError()) {
return true;
}
$translate_array = array_flip($this->m_plici_page_id_translate_array);
if ((0==count($translate_array))
|| (!isset($translate_array[$p_page_id])))
{
// Translate table is empty or page is not found
// Reload translate table
$this->xFillPliciPageIdTranslateArray();
}
$translate_array = array_flip($this->m_plici_page_id_translate_array);
if (isset($translate_array[$p_page_id]))
{
$r_result = $translate_array[$p_page_id];
} else {
trigger_error("This page id :".$p_page_id." is unknow");
}
// Return no error code
return false;
}
/**
* Fill plici page id translate array
*
* @access private
* @return bool TRUE on error
*/
function xFillPliciPageIdTranslateArray()
{
// Erase old value
$this->m_plici_page_id_translate_array = array();
// Set request parameter
$parameters = array();
// Declare database request result
$result = "";
// Execute request
if ($this->m_object_dbconnexion->makeSqlQuery($this->req_get_plici_page_id, $parameters, $result)) {
return onErrorThrow(true, 'sqlGetPliciPageId', plici_lang("lang_error_internal"));
}
// Arrange result
while ($row = mysql_fetch_row($result)) {
$this->m_plici_page_id_translate_array[$row[1]] = $row[0];
}
// Return no error code
return false;
}
/**
* Transform array in string
*
* @param array $r_result
* @param array $p_page_dbc_dbname_list
* @return bool TRUE on error
*/
function xTransformPageDbcDbnameListForBD(&$r_result, $p_page_dbc_dbname_list)
{
$r_result = $this->m_dbc_dbname_list_separator."".implode($this->m_dbc_dbname_list_separator, $p_page_dbc_dbname_list);
// Return no error code
return false;
}
/**
* Return parameters
*
* @param array $r_result
* @return bool TRUE on error
*/
function getCurrentPageDbcDbNameListParameterForSearch(&$r_result)
{
$r_result = "";
global $g_object_siteinformation;
if ($this->xTransformPageDbcDbnameListForBD($r_result, array($g_object_siteinformation->getDatabaseSiteName())))
return true;
return false;
}
}
?>

Documentation generated on Tue, 25 Mar 2008 15:37:35 +0100 by phpDocumentor 1.3.2

Source for file xt_page.class.php