Към съдържанието

Парсване на XML през PHP

  • Versus
  • 15 365 прочитания

Парсване на XML през PHP

Урокът е от архива на сайта и е писан преди години. Някои бутони и менюта в програмите вече може да изглеждат различно.

С този урок, ще се опитам да ви покажа основната идея при парсването на xml файлове с php.
Урока е доста труден и определено е за хора напреднали в РНР и запознати с основните методи и функции за писане на код.
XML файловете са много "модерни" и удобни в днешния Интернет свят, могат да служат за много и различни цели, от просто маркиране на дадена файлова система, до сложна комуникация между два различни сървъра. Всеки решил да се занимава с разработването на уеб рано или късно ще му се наложи да работи именно с такъв тип файлове.

За урока предполагаме, че имаме дърво от директории с неограничена дълбочина, като във всяка директория (без основната) има по един xml файл, който маркира съдържанието на съответната директория (в случая на примерите - книги), всички xml файлове са със сходна структура и имат някой задължителни елементи.
Отбележете, че може би няма да е лоша идея да си вземете под ръка PHP Manual-а за да погледнете някой от функциите ползвани в по-долните примери. Има и доста коментари по кодовете така, че им обърнете внимание.
На края на урока има и линк към цялата работеща система, с подробно описание какви настройки да нпарваите за да тръгне, предварително се изивнявам, че всички файлове са с коментари на английски ( колкото и лош да е той), но ситуацията го изискваше :)

Опис на файловете:

Основни:
  • bpclass.php -- файла, който съдържа класа на самият парсър
  • inclu_fns.php -- файла, който съдържа библиотеката от функции, който ще ползваме
  • merged.php -- файла, с чиято помощ ще можем да направим един голям общ XML файл

Конфигурационни:
  • config.php -- файла, който съдържа основните настройки, без който "системата" няма да работи
  • db_info.php -- файла, който съдържа данни за връзката с базата данни ТРЯБВА ДА СЕ НАМИРА ИЗВЪН ПАПКАТА public_html
Допълнителни:
  • bottom.php -- съдържа, фуутъра на страницата
  • top.php -- съдържа, хедъра на страницата

index.php -- единствения файл, с който борави потребителя

И така...време е да се мятаме :)

Започваме с основния BookParser клас, който се намира в bpclass.php.

<?php
class BookParser
{
var $_mode;
var $_url;
var $_content;
var $_stack = array();//краен масив на всички намерени обекти във файла
var $_names = array();//Тук съхраняваме всички времени имена на получените обекти

function set_BP($mode, $url, $file_content)
{
$this->_content = $file_content;
$this->_mode = $mode;
$this->_url = $url;
}
function parser()
{
$this->parseXML();
return $this->_stack;
}

// Основния метод, който парсва всички обекти/елементи на XMl файла
function parseXML()
{
$xml_parser = xml_parser_create("UTF-8"); //Казваме на парсъра, че нашите файлове са с UTF кодировка, доста е важно ако искаме да се държи нормално и с файлове, които съдържат не само латински букви
xml_parser_set_option($xml_parser, XML_OPTION_SKIP_WHITE, 1); //Задаваме опции на парсъра
xml_set_object($xml_parser, $this);
xml_set_element_handler($xml_parser, "startElementHandler", "endElementHandler");//Показваме на парсъра кои методи да вика в определени ситуации
xml_set_character_data_handler($xml_parser, 'cdataHandler');//същото като горното

if ($this->_mode != 'all')
{
if (@!($fp = fopen($this->_url, "rb")))
{
die("Could not open XML input");
}
while ($data = fread($fp, 4096))
{
if (@!xml_parse($xml_parser, $data, feof($fp)))
{
die(sprintf("XML error: %s at line %d", xml_error_string(xml_get_error_code($xml_parser)),
xml_get_current_line_number($xml_parser)));
}
}
}
elseif($this->_mode == 'all')
{
if (@!xml_parse($xml_parser, $this->_content, feof($fp)))
{
die(sprintf("XML error: %s at line %d", xml_error_string(xml_get_error_code($xml_parser)),
xml_get_current_line_number($xml_parser)));
}
}
xml_parser_free($xml_parser);
}

// Метод, към който се обръщаме когато парсъра достигне началото на обект
function startElementHandler($parser, $name, $attrs)
{
array_push($this->_names, $name);

if ($name == 'BOOKCONTAINER')
{
$this->_currentBook = array();
$this->_currentBook['num'] = -1;
}
elseif ($name == 'BOOK')
{
$this->_currentBook['num']++;
}
}

// Метод, към който се обръщаме когато парсъра достигне стойноста на обекта
function cdataHandler($parser, $cdata)
{
$cdata = trim($cdata);
$this->_currentName = array_slice($this->_names, -1, 1);
$this->_currentName = $this->_currentName[0];

if (empty($this->_stack['BOOK' . $this->_currentBook['num']][$this->
_currentName]))
{
if (!empty($cdata))
$this->_stack['BOOK' . $this->_currentBook['num']][$this->_currentName] = $cdata;
}
else
{
if (!empty($cdata))
$this->_stack['BOOK' . $this->_currentBook['num']][$this->_currentName] .= $cdata;
}
}

// Метод към който парсъра се обръща, когато стигне края на обект
function endElementHandler($parser, $name)
{
//в нашия простоват пример нямаме нужда да правим нищо
}
}
?>


Този клас е ядрото на цялата система, тук се извършват няколко доста прости, но и важни неща. Първо ще обърна внимание на двата метода, които ще се "викат" от този клас, това са set_BP($mode, $url, $file_content) и parser().
Първият метод, очевидно подава на класа някой витални за него данни: $mode показва на класа дали ще парсваме само един XML файл или ще ги вземем всичките веднъж, $url съвсем ясно задава пътя към дадения файл, а $file_content подава съдържанието на всички файлове при положение че mode е указало това.
Методът parser() извиква големият метод parseXML() и връща неговия резултат.

Ще разгледаме следващите методи малко по-подробно.


parseXML()
Няма да обърна много внимание на първите редове от този метод, тъй кат това са функции на PHPи можете да ги проверите в ръководствтото на PHP, само да отбележа, че не можете да пропуснете никоя от тях, тъй като те са основните за същинското четене на XML файла.

if ($this->_mode != 'all')
{
if (@!($fp = fopen($this->_url, "rb")))
{
die("Could not open XML input");
}
while ($data = fread($fp, 4096))
{
if (@!xml_parse($xml_parser, $data, feof($fp)))
{
die(sprintf("XML error: %s at line %d", xml_error_string(xml_get_error_code($xml_parser)),
xml_get_current_line_number($xml_parser)));
}
}
}

Тази част от метода се активира при положение, че имаме само един файл за четене. С fopen($this->_url, "rb") отваряме файла за бинарно четене ( бинарното четене е въпрос на избор, и обикновенни също върши работа) след което започваме да го четем на порции $data = fread($fp, 4096) и да подаваме тези "порции" на xml_parse(). Тъй като ползваме тази функция за четенето на файла на "парче" трябва да бъде използвана с третия и параметър, който указва края на файла, в случая се възползваме от feof($fp) което ще върне true при положение че това е края.

elseif($this->_mode == 'all')
{
.........
}


Този случай ще се активира при положение, че подаваме на класа стринг с цялото съдържание на всички файлове. Тя е идентична на горната с единствената разлика, че не зареждаме съдържанието на файл.

С викането на xml_parse() се виат още три метода, които обуславят държанието на РНР в различните положения:

startElementHandler() cdataHandler() endElementHandler() тези методи се активират съответно в началото -> средата -> края на елемент. Като под елемент разбираме <началото>средата </края>. Тези методи могат да бъдат написани според нуждите на скрипта, който пишете в момента, основната идея е да създадете подходящ масив, който да можете да обработите по-късно или направо да обработите данните получавани от файла ( което не ви го препоръчвам).

В нашия случай пресъздаваме съдържанието на XML файла в "масивен" формат, като всеки обект ( съвкупност от елементи) зареждаме в отделен подмасив и получаваме един многомерен масив с предвидима структура.

Мисля, че това е достатъчно за да започнете експиремнтите с по горния клас или да напишете свой собствен.

Продължаваме със съдържанието на файла inclu_fns.php :
Няма да показвам цялото съдържание на файла, за да не заемаме ненужно пространство.


<?php
/**
* Тази функция "обхожда" цялото дърво от директории
* Връща масив: 'nav' навигационната система и 'tree' карта на дървото
*/

function map_dirs($path, $level = 0)
{
$node = '';
$text = '';

global $text, $node, $tree;
$dir = $node;

if (is_dir($path))
{
if ($contents = opendir($path))
// "Отваряме" директорията
{
while (($node = readdir($contents)) !== false)
{
if ($node != "." && $node != ".." && strtolower($node) != "images")
//Exclude some DIRs from the list
{
if (is_dir($path . "/" . $node)) //Взима само директориите
{
while (@!chdir($node))
// Подсигуряваме се, че сме в директорията отговаряща на $node
chdir('..');

if ($level == 0)
// Добавяме някой красоти :) за да създадем просто меню
{
$img = '<img xsrc="images/star.gif" alt="">';
$node_txt = strtoupper($node);
}
else
{
$img = '<img xsrc="images/halfstar.gif" alt="">';
$node_txt = ucfirst($node);
}

for ($i = 0; $i < $level; $i++)
$text .= "   ";

$text .= "nt" . '<span class="category">' . $img . '<a xhref="index.php?dir=' .
base64_encode(getcwd()) . '&mode=show">' . $node_txt . '</a></span><br>';

$tree[] = getcwd();
}
map_dirs("$path/$node", $level + 1);
// За да обходим дървото изцяло имаме нужда от рекурсивна функция именно затова тази фунция вика сама себе си
}
}
}
}
$result['nav'] = $text;
$result['tree'] = $tree;

return $result;
}
/**
* Зарежда извлечения XML документ в таблица
* Връща стринг
*/

function show_deteils($deteils)
{
................
}
/**
* Въвежда книги в база данни
* Параметъра трябва да бъде масив с индекси 'BOOK0','BOOK1' и т.н....
* Echo успех или грешка
*/

function add_query($data)
{
global $db_colons;

$colons = $db_colons;
$output = '';
$id = '';

if (!is_array($data)) //Проверка
{
echo "<p><b>Невалиден ресурс! Параметъра трябва да бъде масив</b></p>";
return false;
}


for ($i = 0; $i < count($data); $i++)
{
//clear the query string
$add = '';
$add_array = '';

if (!check_array($data['BOOK' . $i]))
return false;

foreach ($data['BOOK' . $i] as $key => $value)
//Премахва всички елемнти, които не са нужни на БД
{
if (in_array(strtolower($key), $colons))
{
$add_array[] .= '`' . strtolower($key) . '` = "' . addslashes($value) . '"';
}
else
$warning = 1;
}

$num = count($add_array);
for ($y = 0; $y < $num; $y++) //Изгражда заявката за БД
{
$z = $y;
$z++;
if ($z < $num)
$add .= $add_array[$y] . ',';
else
$add .= $add_array[$y];
}

open_connection();//Отваряме връзка към БД и въвеждаме данните

$add_query = 'INSERT INTO `books` SET ' . $add;
$add_result = mysql_query($add_query) or die('There was an error: ' .
mysql_error());
$id .= mysql_insert_id() . ', ';//Изграждаме стринг с въведените ИД за информация

}
$num = count(explode(',', $id)) - 1;//Общия брой на всички въведени редове

if ($warning)
$output .= "nt" . 'Внимание: Имаше неразпознати елементи в XML файла<br>';

$output .= "nt" . 'Бяха въведени следните ID: ' . $id . ' общо ' . $num .
' rows.<br>';

return $output;
//$xml->show_xml();
}
/**
* Проверява дали XML файла има всички задължителни елемнти и че няма празни такива
* Параметър: масив
* Връща true при успех и false с предупреждение при неуспех
*/

function check_array($array)
{
global $oblig_obj;
$oblig_str = $oblig_obj;

if (!is_array($oblig_str))
return false;

foreach ($array as $key => $value)
{
$value = trim($value);
if (empty($array[$key])) //Проверка дали елемента е празен
{
echo "<p><b>Празен елемент '$key'. Проверете XML файла.</b></p>";
return false;
}
}

for ($i = 0; $i < count($oblig_str); $i++)
{
if (!array_key_exists($oblig_str[$i], $array))
//Проверява за съществуването на задължителните полета, които са указани в config.php
{
echo "<p><b>Грешка в XML файла: Парсърът откри липсващ елемент '$oblig_str[$i]'.</b></p>";
return false;
}
}
return true;
}
/**
* Отваря връзка към ДБ
*/

function open_connection()
{
................
}
/**
* Зарежда всички XMLфайлове, които са налични в дървото от директории
* Parameters: масива генериран от map_dirs() и името на файла
* Return: стринг със съдържанието на всички XMl файлове
*/

function load_all($nav, $filename)
{

for ($i = 0; $i < count($nav['tree']); $i++)
// събира всички XML файлове в един стринг
{
if (@!($string .= file_get_contents($nav['tree'][$i] . '/' . $filename)))
echo '<p>Внимание има директория без XML <b>' . $filename . '</b>!';
}
$tok = strtok($string, "nt");// Раздробява получения стринг по нови редове
while ($tok !== false)
{
$add[] = $tok;
$tok = strtok(" nt");
}
//Ще премахнем някой елемнти от стринга за да избегнем повторение
$replace = array('<?xml version="1.0" encoding="UTF-8"?>',
'<?xml version="2.0" encoding="UTF-8"?>', '<bookContainer>', '</bookContainer>');

for ($i = 0; $i < count($replace); $i++)
$string = str_ireplace($replace[$i], '', $string);

$string = $add[0] . $add[1] . $string . $add[count($add) - 1];//задаваме начало и край н ановополучения XML файл
return $string;
}
?>

Няма да се впускам в обяснение. Пълния вариант на файла ще намерите в архива към урока.

Ще разгледаме съдържанието на index.php, което само по себе си е пример за ползването на класа и библиотеката от функции. Тук отново няма да се впускам в подробности, проследете коментарите по скрипта

<?php
session_start();
//Марка за стартовото време
$time_start = microtime(true);
//Зареждаме нужните ни файлове
require_once ("inclu_fns.php");
require_once ("config.php");
require_once ("bpclass.php");

if (($_GET['dir']) || (($_GET['mode']) && ($_GET['mode']) == 'all'))
//Проверяваме за подадени параметри през GET
{
if ($_GET['dir'])
{
$code_dir = $_GET['dir'];
$dir = base64_decode($code_dir);
if (!eregi('^[A-Z0-9_/:-]+$', $dir))
//стринга може да съдържа само числа и букви и знаците _ - като всички позволени имена на директории
$dir = '';
if (!empty($dir))
define("SCRIPT", "ON");//Ако всичко е наред, задаваме началото на скрипта
}
elseif ($_GET['mode'] && $_GET['mode'] == 'all')
{
define("SCRIPT", "ON");//Ако всичко е наред, задаваме началото на скрипта
}
}
require_once ('topbar.php');

$nav = map_dirs($main_path, 0); //Обхождаме дървото от директории

if (defined("SCRIPT"))
//Ако сме дефинирали началото, основната част от скрипта започва
{
$filename = $xml_file;
$url = $dir . '/' . $filename;
$stack = array();
if ($_GET['mode'])
$mode = $_GET['mode'];
else
$mode = 'show';

switch ($mode) //разглеждаме различните варианти на $mode, който е различни в различните етапи на процеса
{
case 'show':
$xml = new BookParser;// Правим инстация на парсър класа
$xml->set_BP($mode, $url, null);// зареждаме нужните на класа променливи
$stack = $xml->parser();// зареждаме резултата от XML файла

$deteils = show_deteils($stack);
echo $deteils;
echo '<p><a xhref="index.php?dir=' . $code_dir .
'&mode=queryadd">Add this table in the DataBase.</a></p>';
break;
case 'queryadd':
if (isset($_SESSION['content']))
$content = $_SESSION['content'];
else
$content = '';
if ($dir == 'all')
$mode = 'all';

$xml = new BookParser;// Правим инстация на парсър класа
$xml->set_BP($mode, $url, $content);// зареждаме нужните на класа променливи
$stack = $xml->parser();// зареждаме резултата от XML файла

$query_res = '<h1>' . add_query($stack) . '</h1>';
echo $query_res;
break;
case 'all':
$content = load_all($nav, $filename);
// Зареждаме съдържанието на всички XMl файлове в дървото
$xml = new BookParser;// Правим инстация на парсър класа
$xml->set_BP($mode, $url, $content);//зареждаме нужните на класа променливи
$stack = $xml->parser();//зареждаме резултата от XML файла

$_SESSION['content'] = $content; // запазваме съдържанието на заредения XML файл, който съдържа всички файлове от всички директории за по-късна употреба

$deteils = show_deteils($stack);
// извикваме deteils() от библиотеката с функции
echo $deteils;
echo '<p><a xhref="index.php?dir=' . base64_encode('all') .
'&mode=queryadd">Add this table in the DataBase.</a></p>';
break;

}
}

echo "nt".'<h3><a xhref="index.php?mode=all">Show All</a></h3>';
echo $nav['nav'];

require_once ('bottom.php');
?>




  Работните файлове от урока.

Have Fun!
Versus
Споделете: