Práce s textovým souborem v PHP

Obsah lekce:

Požití textového souboru jako komponenty dynamického webu

Jednou z částí dynamického webu může být stránka obsahující informace uložené v rámci textového souboru v adresářové strukutře webu. Může se jednat o jednoduchý soubor s informacemi, které je jednodušší uložit do souboru namísto databáze (nebo nemáme databázový server k dispozici - například v rámci nějakého webhostingu, který je zdarma a databázovou technologii zkrátka nelze využívat).

V našem příkladu na zpracování textového souboru budeme uvažovat seznam zaměstnanců uložený v textovém souboru a ten budeme ze souboru vizualizovat jako html stránku.

Zdrojový soubor s daty

Vstupním souborem našeho skriptu bude soubor v tabulkovém kalkulátoru Microsoft Excel obsahující tabulku zaměstnanců. Soubor je k dispozici v jedné z následujících variant:

• zamestnanci.xls - formát pro Excel 97-2003
• zamestnanci.xlsx - formát pro Excel 2007

Vzhledem k tomu, že zdrojový soubor v tabulkovém kalkulátoru je binární (obsahuje standardně nečitelná data - zkuste si prohlédnout jeden ze stažených souborů nějakým obyčejným textovým editorem např. poznámkový blok nebo pspad apod.), tak je třeba obsah tohoto souboru uložit tak, aby byl pro nás a náš skript čitelný.

V našem příkladu exportujeme seznam zaměstanců do textového souboru ze seznamu vytvořeného v tabulkovém procesoru typu Excel. K tomuto účelu použijeme formát CSV (v tabulkovém procesoru zvolíme uložit jako formát CSV). Uložením do formátu CSV dojde k tomu, že vznikne textový soubor se stejnými textovými daty jako v tabulkovém procesoru. Každému řádku v tabulce tabulkového procesoru odpovídá v textovém souboru je jeden řádek s tím, že údaje z jednotlivých sloupců jsou v textovém souboru odděleny středníkem (zpravidla).

Textový soubor bude na každém řádku obsahovat všechny informace o jednom člověku (kontaktu).

CSV soubor bude po zobrazení textovým editorem vypadat takto:

Pomineme-li první tři řádky, pak vidíme, že každý řádek obsahuje informace o jednom konktrétním zaměstnanci ve tvaru Jméno;Příjmení;Titul;E-mail;Telefon;Fotografie;Zkratka. Je tedy možné soubor jednoduše zpracovat, neboť jsou v něm všechny hodnoty jednoduše čitelné.

O formátu CSV

Podívejme se přesněji na to, jak soubor ve formátu CSV vypadá. Jedná se o jednoduchý souborový formát určený pro výměnu tabulkových dat (například mezi různými systémy). Takovýto soubor se skládá z řádků, ve kterých jsou jednotlivé sloupce v rámci jednoho řádku odděleny oddělovacím znakem (nejčastěji to bývá čárka nebo středník) - toto je také význam CSV neboli "Comma-separated values". Jednotlivé položky řádku (sloupce) mohou být uzavřeny do uvozovek (například proto, že text v rámci sloupce může obsahovat oddělovací znak - například středník - a je tedy nutno takový řetězec uzavřít do uvozovek, aby bylo zřejmé, že se nejedná o oddělovač sloupců, ale o znak ve sloupci obsažený).

Uvědomme si, že převodem z tabulky v tabulkovém procesoru, která obsahuje jiné písmo, barvy apod. o tyto informace v textovém souboru přijdeme a zůstanou pouze textová data. Na tento fakt nás tabulkový procesor při ukládání upozorní.

Pro výměnu dat se již dnes používá spíše formát xml, ale práce s ním je o něco složitější a pro naši potřebu formát CSV postačí.

Práce s textovým souborem v PHP

Vytvoříme složku a v ní vytvoříme testovací soubor zobraz-soubor.php se skriptem pro načtení souboru a do vnořené složky se jménem data uložíme náš CSV soubor pod jménem zamestnanci.csv.

Nyní se dostáváme k problematice samotného skriptu, který by měl soubor otevřít a vypsat nám jeho obsah do prohlížeče. V první řadě vložíme do našeho souboru základní kostru html dokumentu.

Náš skript bude fungovat tak, že otevře soubor v daném umístění, projde ho řádek po řádku a aktuální řádek vždy vypíše do html. V krocích bychom si to mohli představit jako následující postup:

• Pokus se otevřít soubor zamestnanci.csv pro čtení.
• Pokud se to nepovede, tak napiš chybové hlášení a jinak:
• Vezmi jeden řádek souboru, ulož jej do proměnné a dokud nebude konec souboru, tak proměnnou vypiš a pokračuj stejně na dalším řádku.

Otevření souboru v PHP

K otevření souboru slouží v PHP funkce fopen (popis). Tato funkce má celkem dva povinné parametry:

• umístění souboru - to je v našem případě relativní cesta data/zamestnanci.csv
• režim otevření souboru - zde specifikujeme, co hodláme se souborem dělat - v jakém režimu jej chceme otevřít (zda jen pro čtení, pro zápis, pro obojí apod.). V našem případě jej chceme pouze číst a tak jej otevřeme v režimu pro čtení (parametr "r").

Test na existenci zadaného souboru v PHP

Na ověření existence požadovaného otevíraného souboru v PHP slouží funkce file_exists (popis). Tato funkce vrací hodnotu TRUE pokud zadaná cesta existuje a FALSE v opačném případě. Tato funkce má jeden povinný parametr:

• umístění souboru - to je v našem případě relativní cesta data/zamestnanci.csv

Test na konec souboru v PHP

Na ověření zda se nacházíme na konci souboru v PHP slouží funkce feof (popis). Tato funkce vrací hodnotu TRUE pokud je ukazatel v souboru na konci souboru a FALSE v opačném případě. Tato funkce má jeden povinný parametr:

• ukazatel na soubor - to je v našem případě ukazatel na náš cílový soubor

Po úspěšném otevření souboru získáme ukazatel $soubor na nás soubor a cyklus while obstará proces procházení souboru řádek po řádku dokud není konec souboru. Jinak řečeno: "Dokud nám funkce feof nevrátí true (tzn. je konec souboru), pak pokračujeme ve čtení souboru řádek po řádku.".

Přečtení jednoho řádku ze souboru v PHP

Na přečtení jednoho řádku ze souboru v PHP slouží funkce fgets (popis). Tato funkce vrací řetězec o délce delka-1 (delka je volitelný parametr). Tato funkce má jeden povinný a jeden volitelný parametr:

• ukazatel na soubor - to je v našem případě ukazatel na náš cílový soubor
• délka - počet znaků, který se nejvýše z daného řádku přečte

Výsledná podoba skriptu na přepis souboru do prohlížeče

Výsledný skript vložíme mezi značky <?php a ?> do těla stránky mezi tagy <body></body>. Skript se pokudí otevřít soubor a provádí čtení souboru řádek po řádku a výpis jednotlivých řádků do prohlížeče.

          $nazev_souboru="data/zamestnanci.csv";
          if (file_exists($nazev_souboru)) {
                $soubor=fopen($nazev_souboru, "r");
                if($soubor){
                    while (!feof($soubor)){
                        $radek = fgets($soubor,5000);
                        print($radek);
                        print("<br />");
                    }
                } 
                else 
                {
                    print("Soubor ".$nazev_souboru." se nepodařilo otevřít pro čtení.");
                }
           } 
           else 
           {
           print("Soubor ".$nazev_souboru." neexistuje.");
           }
        

Výsledný výpis souboru v prohlížeči by měl vypadat takto:

Další čtení

Otázky

1. Je nějakým způsobem možné exportovat data z tabulkového procesoru v textové podobě?
2. Jaké nevýhody může přinést převod tabulky z tabulkového procesoru do textového formátu?
3. Charakterizujte formát CSV.
4. Jaké základní funkce pro čtení textového souboru v PHP znáte?