{"id":2986,"date":"2023-09-26T05:21:15","date_gmt":"2023-09-26T03:21:15","guid":{"rendered":"https:\/\/nyamsprod.com\/blog\/?p=2986"},"modified":"2023-09-26T05:21:15","modified_gmt":"2023-09-26T03:21:15","slug":"extracting-data-from-html-table-in-php","status":"publish","type":"post","link":"https:\/\/nyamsprod.com\/blog\/extracting-data-from-html-table-in-php\/","title":{"rendered":"Extracting data from HTML table in PHP"},"content":{"rendered":"\n

Have you ever face a situation where you want to get some data out of a HTML table because you did not find the clean and clear API to consume which can deliver the same data but via JSON, XML or CSV. If so I am happy to present to you a simple package to parse HTML table called bakame\\html-table<\/code>.<\/p>\n\n\n\n

The package was initially a script build to get some data in a complex old archived HTML page. But the more I was working on it, the more I was able to refine the code to extract a small package with a nice DX. <\/p>\n\n\n\n

How parsing works ?<\/h2>\n\n\n\n

Simply put, the package consists of one main class Bakame\\Html\\Table\\Parser<\/code> that you will need to configure in order to parse a specific table. Under the hood, for parsing, the package relies on PHP DOM, and libxml extensions to correctly parse a single table contained in the submitted HTML text. It relies on XPath to traverse and detect each section of the table and uses the DOM to iterate over each table row and cells.<\/p>\n\n\n\n

Assuming you have the following HTML table:<\/p>\n\n\n

\n<table>\n  <caption>Yearly Sales<\/caption>\n  <thead>\n    <tr>\n      <th>Year<\/th>\n      <th>Product<\/th>\n      <th>Units Sold<\/th>\n    <\/tr>\n  <\/thead>\n  <tbody>\n    <tr>\n      <td>2020<\/td>\n      <td>Widgets<\/td>\n      <td>3200<\/td>\n    <\/tr>\n    <tr>\n      <td>2021<\/td>\n      <td>Widgets<\/td>\n      <td>4800<\/td>\n    <\/tr>\n  <\/tbody>\n  <tfoot>\n    <tr>\n      <td colspan="2">Total Sales<\/td>\n      <td>8000<\/td>\n    <\/tr>\n  <\/tfoot>\n<\/table>\n<\/pre><\/div>\n\n\n
The parser will converted it into a iterable structure as shown below. <\/p>\n\n\n
\n<?php\n\nuse Bakame\\Html\\Table\\Parser;\n$html = <<<TABLE\nthe table content goes here.\nTABLE;\n\n$table = Parser::new()->parseHtml($html);\nvar_dump($table);\n\/\/ returns something like this\n\/\/ [\n\/\/   [\n\/\/     "Year" => "2020",\n\/\/     "Product" => "Widgets",\n\/\/     "Units Sold" => "3200",\n\/\/   ],\n \/\/  [\n \/\/    "Year" => "2021",\n \/\/    "Product" => "Widgets",\n \/\/    "Units Sold" => "4800",\n\/\/   ],\n\/\/   [\n\/\/     "Year" => "Total Sales",\n\/\/     "Product" => "Total Sales",\n\/\/     "Units Sold" => "8000",\n \/\/  ],\n\/\/ ]\n<\/pre><\/div>\n\n\n
As you may have notice the package autodetected the table header and used its content has keys for each record. Cells with the colspan<\/code> and\/or rowspan<\/code> attributes are handled, in both cases the content will be duplicated so that each record contains the exact same number of cell. the caption<\/code> tag however is skipped and there’s no way currently to retrieve its value.<\/p>\n\n\n\n
The parser can be configure to handle all sorts of situations regarding how the table was constructed.<\/p>\n\n\n
\nuse Bakame\\Html\\Table\\Parser;\nuse Bakame\\Html\\Table\\Section;\n\n$formatter = fn (array $record): array => array_map(\n    strtoupper(...),\n    $record\n);\n\n$parser = Parser::new()\n    ->excludeTableFooter()\n    ->withFormatter($formatter)\n    ->tableHeaderPosition(Section::tbody, 2)\n    ->tablePosition('statistics-sells');\n\n$table = $parser->parseFile('https:\/\/www.example.com\/page-with-table.html');\n<\/pre><\/div>\n\n\n
In the example above:<\/p>\n\n\n\n