* -------------------------------------------------------------------- *
* Kurzbeschreibung : Funktionen zum Umgang mit XML-Templates *
* -------------------------------------------------------------------- *
- * $Revision:: $ *
- * $Date:: $ *
- * $Tag:: 0.2.1-FINAL $ *
- * $Author:: $ *
- * -------------------------------------------------------------------- *
* Copyright (c) 2003 - 2009 by Roland Haeder *
- * Copyright (c) 2009 - 2012 by Mailer Developer Team *
+ * Copyright (c) 2009 - 2013 by Mailer Developer Team *
* For more information visit: http://mxchange.org *
* *
* This program is free software; you can redistribute it and/or modify *
initXml();
// Generate FQFN for with special path
- $FQFN = sprintf("%stemplates/xml/%s%s.xml",
+ $FQFN = sprintf('%stemplates/xml/%s%s.xml',
getPath(),
detectExtraTemplatePath('xml', $template),
$template
// Is the file readable?
if (!isFileReadable($FQFN)) {
// No, use without extra path
- $FQFN = sprintf("%stemplates/xml/%s.xml",
+ $FQFN = sprintf('%stemplates/xml/%s.xml',
getPath(),
$template
);
// Is it again readable?
if (isFileReadable($FQFN)) {
// Is there cache?
- if ((!isDebuggingTemplateCache()) && (isTemplateCached('xml', $template))) {
+ if ((!isDebugTemplateCacheEnabled()) && (isTemplateCached('xml', $template))) {
// Evaluate the cache
- eval(readTemplateCache('xml', $template));
+ $templateContent = readTemplateCache('xml', $template, $content);
} else {
// Read it
$templateContent = readFromFile($FQFN);
// Prepare it for finaly eval() command
- $GLOBALS['template_eval']['xml'][$template] = '$templateContent = decodeEntities("' . compileRawCode(escapeJavaScriptQuotes($templateContent), FALSE, TRUE, TRUE, $compileCode) . '");';
+ $GLOBALS['template_eval']['xml'][$template] = '$templateContent = decodeEntities("' . compileRawCode(escapeJavaScriptQuotes($templateContent), TRUE, $compileCode) . '");';
// Eval the code, this does insert any array elements from $content
eval($GLOBALS['template_eval']['xml'][$template]);
addXmlSpecialElements($template);
// Call the call-back function
- doCallXmlCallbackFunction($content);
+ doCallXmlCallbackFunction();
} else {
// Template not found
displayMessage('{%message,XML_TEMPLATE_404=' . $template . '%}');
// Parses the XML content
function parseXmlData ($content) {
// Is there recode?
- if (!function_exists('recode')) {
+ if (!extension_loaded('recode')) {
// No fallback ATM
- reportBug('PHP extension recode is missing. Please install it.');
+ reportBug(__FUNCTION__, __LINE__, 'PHP extension recode is missing. Please install it.');
} // END - if
// Convert HTML entities to UTF-8
$characters = trim($characters);
// Are there some to handle?
- if (strlen($characters) == 0) {
+ if (empty($characters)) {
// Nothing to handle
return;
} // END - if
// @TODO Handle characters
- die(__FUNCTION__ . ':characters[]='.strlen($characters));
+ die(__FUNCTION__ . ':characters[' . gettype($characters) . ']=' . strlen($characters));
}
// Checks if given type is valid, makes all lower-case
$condition = trim(strtolower($condition));
// Is it valid?
- return (in_array($condition, array('equals')));
+ return (in_array($condition, array('equals', 'and')));
}
// Checks if given value is valid/verifyable
return $GLOBALS['__XML_CONDITIONS'][$condition];
}
+// "Getter" for FROM statement from given columns
+function getSqlXmlFromTable ($tableName) {
+ // Init SQL
+ $sql = ' FROM `{?_MYSQL_PREFIX?}_' . $tableName[0]['value'] . '`';
+
+ // Is alias set?
+ if (!empty($tableName[0]['alias'])) {
+ // Also add it
+ $sql .= ' AS `' . $tableName[0]['alias'] . '`';
+ } // END - if
+
+ // Return SQL
+ return $sql;
+}
+
// "Getter" for sql part back from given array
function getSqlPartFromXmlArray ($columns) {
// Init SQL
- $SQL = '';
+ $sql = '';
// Walk through all entries
foreach ($columns as $columnArray) {
+ // Must be an array
+ assert(is_array($columnArray));
+
// Init SQL part
$sqlPart = '';
// Is there a table/alias
if (!empty($columnArray['table'])) {
// Pre-add it
- $sqlPart .= $columnArray['table'] . '.';
+ $sqlPart .= '`' . $columnArray['table'] . '`.';
} // END - if
// Add column
} // END - if
// Add finished SQL part to the query
- $SQL .= $sqlPart . ',';
+ $sql .= $sqlPart . ',';
} // END - foreach
// Return it without last commata
- return substr($SQL, 0, -1);
+ return substr($sql, 0, -1);
+}
+
+// "Getter" for JOIN statement
+function getSqlXmlJoinedTable ($tableJoinType, $tableJoinName, $joinOnLeftTable, $joinOnCondition, $joinOnRightTable) {
+ // Are all set?
+ assert((isFilledArray($tableJoinType)) && (isFilledArray($tableJoinName)) && (isFilledArray($joinOnLeftTable)) && (isFilledArray($joinOnCondition)) && (isFilledArray($joinOnRightTable)));
+
+ // Init SQL
+ $sql = '';
+
+ // "Walk" through all JOINs
+ foreach ($tableJoinType as $key => $joinType) {
+ // 1) Add JOIN type and table name with alias
+ $sql .= ' ' . $joinType . ' `{?_MYSQL_PREFIX?}_' . $tableJoinName[$key]['name'] . '`';
+
+ // Alias set?
+ if (!empty($tableJoinName[$key]['alias'])) {
+ // Add it
+ $sql .= ' AS `' . $tableJoinName[$key]['alias'] . '`';
+ } // END - if
+
+ // 2) Add left part + condition + right part with aliases
+ // 2/1) ON + left part
+ $sql .= ' ON `' . $joinOnLeftTable[$key]['name'] . '`.`' . $joinOnLeftTable[$key]['column'] . '`';
+ // 2/2) Condition
+ $sql .= $joinOnCondition[$key];
+ // 2/3) right part
+ $sql .= '`' . $joinOnRightTable[$key]['name'] . '`.`' . $joinOnRightTable[$key]['column'] . '`';
+ } // END - foreach
+
+ // Return SQL
+ return $sql;
+}
+
+// "Getter" for WHERE statement from given columns and conditions arrays
+function getSqlXmlWhereConditions ($whereColumns, $conditions) {
+ // Init SQL
+ $sql = '';
+
+ // Are there some conditions?
+ if (isFilledArray($whereColumns)) {
+ // Then add these as well
+ if (count($whereColumns) == 1) {
+ // One entry found
+ $sql .= ' WHERE ';
+
+ // Table/alias included?
+ if (!empty($whereColumns[0]['table'])) {
+ // Add it as well
+ $sql .= $whereColumns[0]['table'] . '.';
+ } // END - if
+
+ // Add the rest
+ $sql .= '`' . $whereColumns[0]['column'] . '`' . $whereColumns[0]['condition'] . chr(39) . $whereColumns[0]['look_for'] . chr(39);
+ } elseif ((count($whereColumns > 1)) && (isFilledArray($conditions))) {
+ // More than one "WHERE" + condition found
+ foreach ($whereColumns as $idx => $columnArray) {
+ // Default is WHERE
+ $condition = ' WHERE ';
+
+ // Is the condition element there?
+ if (isset($conditions[$columnArray['column']])) {
+ // Assume the condition
+ $condition = ' ' . $conditions[$columnArray['column']] . ' ';
+ } // END - if
+
+ // Add to SQL query
+ $sql .= $condition;
+
+ // Table/alias included?
+ if (!empty($whereColumns[$idx]['table'])) {
+ // Add it as well
+ $sql .= $whereColumns[$idx]['table'] . '.';
+ } // END - if
+
+ // Add the rest
+ $sql .= '`' . $whereColumns[$idx]['column'] . '`' . $whereColumns[$idx]['condition'] . chr(39) . convertDollarDataToGetElement($whereColumns[$idx]['look_for']) . chr(39);
+ } // END - foreach
+ } else {
+ // Did not set $conditions
+ reportBug(__FUNCTION__, __LINE__, 'Supplied more than "whereColumns" entries but no conditions! Please fix your XML template.');
+ }
+ } // END - if
+
+ // Return SQL
+ return $sql;
+}
+
+// "Getter" for ORDER BY statement from given columns
+function getSqlXmlOrderBy ($orderByColumns) {
+ // Init SQL
+ $sql = '';
+
+ // Are there entries from orderByColumns to add?
+ if (isFilledArray($orderByColumns)) {
+ // Add them as well
+ $sql .= ' ORDER BY ';
+ foreach ($orderByColumns as $orderByColumn => $array) {
+ // Get keys (table/alias) and values (sorting itself)
+ $table = trim(implode('', array_keys($array)));
+ $sorting = trim(implode('', array_values($array)));
+
+ // table/alias can be omitted
+ if (!empty($table)) {
+ // table/alias is given
+ $sql .= '`' . $table . '`.';
+ } // END - if
+
+ // Add order-by column
+ $sql .= '`' . $orderByColumn . '` ' . $sorting . ',';
+ } // END - foreach
+
+ // Remove last column
+ $sql = substr($sql, 0, -1);
+ } // END - if
+
+ // Return SQL
+ return $sql;
}
// Searches in given XML array for value and returns the parent index