Главная > Программирование > РНР: настольная книга программиста
<< Предыдущий параграф
Следующий параграф >>
<< Предыдущий параграф Следующий параграф >>
Макеты страниц

26.3. Основные операции над файлами в PHP

Изучив материал этого параграфа, вы научитесь получать доступ к файлам для работы с их содержимым: производить чтение строк файлов, перемещать указатель в конец и определять, что именно это место и является завершением файла. Рассмотрим следующие функции:

• fopen(),

• fclose(),

• popen(),

• pclose(),

• feof(),

• fgets(),

• fgetss(),

• fread().

Очень часто, чтобы получить доступ к файлу, необходимо установить на него указатель (т. е. что-то вроде курсора, только невидимый). Для выполнения этой операции в РНР существует несколько функций, мы рассмотрим одну из самых главных, часто используемых и наиболее эффективных — функцию fopen(). Она позволяет открыть файл или URL. Функция fopen() имеет следующий синтаксис:

int fopen (string filename, string mode [, int use_include_path])

Если параметр filename начинается с http:// (без учета регистра), то открывается соединение HTTP 1.0 с заданным сервером и указатель файла возвращается на начало текста ответа. Посколькуредиректы НТТР не обрабатываются, нужно включать в указание директории завершающие слеши.

Если filename начинается с ftp:// (без учета регистра), то открывается ftp-соединение с задазанным сервером и указатель возвращается на искомый файл. Если сервер не поддерживает режим пассивного ftp, данная операция завершится ошибкой. Можно открывать файлы какдля чтения, так и для записи через ftp (но не обе операции одновременно).

Если filename начинается как-нибудь иначе, открывается файл вашей файловой системы и указатель возвращается на открытый файл.

Если при открытии файла происходит ошибка, функция возвращает false.

Параметр mode в зависимости от поставленной задачи может принимать следующие значения.

r — открыть только для чтения, помещает указатель на начало файла.

r+ — открыть для чтения и для записи, помещает указатель на начало файла.

w — открыть только гля записи, помещает указатель на начало файла и очищает все содержимое файла. Если файл не существует, то создается новый.

w+ — открыть для чтения и для записи, помещает указатель на начало файла и очищает все содержимое файла. Если файл не существует, создается новый.

a — открыть только для записи, помещает указатель на конец файла. Если файл не существует, создается новый.

a+ — открыть для чтения и для записи, помещает указатель на конец файла. Если файл не существует, создается новый.


ВНИМАНИЕ

Параметр mode также может содержать символ 'b' — используется в системах, различающих бинарные и текстовые файлы (не используется в Unix). Если данное значение не имеет смысла, оно игнорируется.


Третий параметр — use_include_path — устанавливается как «1». Его используют, если нужно исследовать файл в include_path, в файле конфигурации php.ini.

Например:

1. unix include_path

include_path=.:/home/httpd/php-lib

2. Windows include_path

include_path=".;с:\www\phplib"

Рассмотрим примеры работы функции fopen():

1. $filepointer = fopen("/home/localhost/file,txt", "r");

2. $ filepointer = fopen ("/home/localhost/file.gif", "wb") ;

3. $filepointer = fopen ("http://www.any_name_domain.com/", "r") ;

4. $filepointer = fopen ("ftp://user:password@example.com/", "w");

Мы пронумеровали строки для того, чтобы можно было легче описать последовательность функций. При программировании нумерация не применяется. Впервой строке происходит открытие файла по имени file.txt с установленным параметром "г". В этом случае указатель $filepointer будет помещен на начало открытого файла, но этот файл можно только читать, производить какие-либо другие операции, например запись или удаление каких-либо текстовых блоков, нельзя.

Вторая строка — на основании указанных параметров можно сделать вывод, что файл file.gif открывается только для записи. После того как он был открыт, сразу происходит помещение указателя на начало файла и очистка всего содержимого файла. Если файл не существует, то создается новый файл. За это все отвечает параметр "w", но помимо этого был указан и параметр "b", который используется в системах, различающих бинарные и текстовые файлы.

В третьей строке примера доступ к файлу осуществляется посредством протокола http://(HyperText Transfer Protocol).

В четвертой строке — ftp://(File Transfer Protocol).

Если у вас возникают проблемы с чтением и записью в файл при использовании РНРкак серверного модуля, помните, что применяемые файлы и директории должны быть доступными для серверных процессов. На платформе Windows будьте осторожны, избегайте обратных слешей в путях и используйте слеши в следующем направлении:

$filepointer = fopen("c:\\dir1\\dir2Wtest.txt", "r" );

После того как вы открыли файл, произвели необходимые действия над его содержимым, нужно закрыть файловый указатель. Это показывает интерпретатору, что все действия над содержимым этого файла будут прекращены. Просто запомните, что если вы производите вызов функции, открытие файла и установление файлового указателя, ниже должна быть приведена функция, которая будет закрывать этот файл с файловым указателем. Для функции fopen() используется функция fclose(). Она имеет следующий синтаксис:

int fclose(int fp)

На месте параметра fp записывается переменная файлового указателя. В вышеописанном примере переменной файлового указателя является $filepointer.

При удачном выполнении программы, т. е. при правильном задании параметров функции fclose(), она возвратит значение true, в противном случае — false. Обратите внимание: указатель, используемый в функции fclose(), должен быть действующим и указывать на файл, открытый функцией fopen(). Рассмотрим пример:

<?php

$fp = fopen ("Z:\\home\\localhost\\newname.txt"; "r"); $str = fgets ($fp, 5) ;

//на этом месте применяется код для работы с содержимым файла

if(fclose($fp)) {

    есho "Закрытие файла newname.txt осуществлено успешно<br>";

}

else {

    есho "Функция выполнила ошибку<br>";

}

Пример очень простой, открывает и устанавливает указатель файла, а после этого производит закрытие. Условный оператор проверяет файл на правильность выполнения операции. Пример не содержит каких-либо ошибок, поэтому результатом выполнения этой программы будет строка:

Закрытие файла newname.txt осуществлено успешно

Основные тонкости работы этой функции вы освоите при самостоятельном экспериментировании. На начальном этапе главное понять, как правильно производить работу с функцией fclose().

Чтобы открыть файл, в РНР существует далеко не одна функция. Мы рассмотрели наиболее распространенные и эффективные — fopen() и fclose(). Теперь же рассмотрим функции, которые по принципу работы аналогичны, но имеют кое-какие тонкости при вызове.

Функция popen() производит открытие файла с установлением указателя. Она не получила такого широкого распространения, как fopen(), что обусловлено способом работы этой функции. Синтаксис функции popen():

int popen (string command, string mode)

Функция возвращает файловый указатель, идентичный возвращаемому fopen(), но этот указатель мононаправленный (может использоваться только для чтения или только для записи) и должен быть закрыт pclose(). Этот указатель можно использовать с fgets(), fgetss() (см. ниже).

Второй параметр mode полностью аналогичен mode в файле fopen().

При правильной работе функция возвращает значение, равное true, в противном случае — false. Например:

$filepointer = popen("/bin/ls", "r") ;

После открытия файла функцией popen() можно производить операции, связанные только с чтением или записью файла. Проделав все необходимые операции, нужно закрыть существующий файл. Если в начале вы воспользовались функцией popen(),чтобы закрыть файл, над которымпроизводились операции, необходимо вызвать функцию pclose(). Функция fclose() в этом случае вызовет ошибку. Синтаксис функции pclose():

int pclose(int fp)

Функция pclose() закрывает файловый указатель к каналу, открытому popen(). Файловый указатель должен быть действующим и возвращенным успешным вызовом popen(). В качестве параметра нужно указать переменную файлового указателя, на который ссылается функция popen(). Функции popen() и pclose() также не могут существовать по отдельности, как и fopen() и fclose().

Функция pclose() возвращает true при отсутствии каких-либо ошибок, в противном случае — Рассмотрим пример:

<?php

$filepointer = popen("/bin/ls", "r");

// тут может быть ваш код

pclose($filepointer);

?>

Между функциями popen() и pclose() выполняются необходимые операции работы с содержимым файла.

Перейдем непосредственно к изучению процессов, связанных с работой содержимого файла и указателя.

Чтобы проверить, находится ли указатель в конце файла, необходимо воспользоваться функцией feof(), Она очень полезна при последовательном считывании строк файла, при этом эта функция позволяет определить, когдадостигается конец файла. Функция имеет очень простой и понятный синтаксис:

int feof(int fp)

Функция возвращает true, если указатель файла равен EOF (end of file — конец файла) или в случае ошибки; в противном случае возвращается false. Указатель должен быть действующим и указывать на файл, успешно открытый fopen() или popen(). Как правило, эта функция применяется в циклах для создания условия выполнения. Если указатель достиг конца файла, необходимо прервать выполнение цикла, иначе это может вызвать ошибку. Например:

<?php

if ($fp = fopen ("Z:\\home\\localhost\\www\\newname.txt", "r"))

    echo "Работа функции fopen() произведена успешно!<br>";

do {

    $str = fgets ($fp, 3);

    echo $str, "<br>";

}

while(!feof($fp));

if(!fclose ($fp)) {

    echo "Функция fclose () выполнила ошибку<br>";

}

else {

    echo "Закрытие файла newname.txt осуществлено успешно<br>";

}

?>

В данном примере использована функция fgets() возврата указанного количества символов из файла, расположенного по адресу Z:\\hone\\localhost\\www\\newname.txt.

После того как указатель достиг конца файла, мы прерываем выполнение цикла и производим закрытие файла функцией fclose(). Результат действия данной программы:

Работа функции fopen() произведена успешно!

Удачное выполнение программы!

Закрытие файла newname.txt осуществлено успешно

Как видно из результата, файл newname.txt содержал следующую фразу. «Удачное выполнение программы!». Как только указатель достиг конца файла, выполнение цикла было прервано.

В рассмотренном примере была использована функция fgets(). Это очень распространенная функция, созданная для того, чтобы получать необходимое количество символов, начинаяс того места, в котором расположен файловый указатель. При задании количества символов происходит перемещение этого файлового указателя, и он остается в том месте, в котором заканчивается заданное в функции fgets() количество символов. Синтаксис функции fgets():

string fgets(int fp, int length)

Функция fgets () возвращает строку длинной, равную length. Параметр length принимает значения, например 2,3,... 26, т. е. численные значения, в зависимости оттого, как много символов вам необходимо получить. Параметр length читается по одному байту из файла, заданного в параметре файлового указателя fp. Чтение заканчивается, если обработано указанное количество (length) символов — или

до символов перевода строки и возврата каретки, или до EOF. Один байт прочитается в любом случае. В случае возникновения ошибки возвращается false.

Указатель должен быть действующим и указывать на файл, успешно открытый fopen() или popen().

Рассмотрим пример:

<?php

$fp = fopen ("Z:\\home\\localhost\\www\\newname.txt", "r");

while (!feof ($fp)) {

    $buf = fgets($fp, 3000);

    echo $buf;

}

fclose ($fp)

?>

Данная программа произведет последовательно вызов 3000 символов до тех пор, пока указатель не достигнет конца файла. Результат примера не будем приводить, так как не имеет никакого смысла просто переписывать все содержимое файла. Просто проделайте эту операцию самостоятельно для какого-нибудь файла.

Когда нужно получить строки из какой-то Web-страницы и при этом HTML-теги должны быть удалены, то не надо придумывать какие-либо новые операции по удалению этих зловредных тегов, можно просто воспользоваться функцией fgetss(). Она получила распространение при работе с HTML-страницами. Функция fgetss() позволяет производить удаление всех тегов в строке, длину которой вы указали. По характеру работы функция аналогична fgets(). Синтаксис функции fgetss():

string fgetss (int fp, int length [, string allowable_tags] )

Функция также возвращает строку символов, отличие же ее от fgets() состоит в том, что fdetss() позволяет удалить HTML и PHP-теги из текста. Помимо изученных двух параметров (frulength) данная функция располагает также третьим — string allowable_tags. Этот параметр является необязательным и применяется при необходимости. Параметр указывается в качестве тега или тегов,

удаление которых не требуется. Если вы указали, допустим, тег <br> в качестве третьего параметра, то интерпретатор произведет удаление всех тегов HTML, содержащихся в полученной строке, кроме тега <br>.

Для примера создадим файл newname.txt, содержащий следующий текст:

<html><body><h3>Добро пожаловать <br> в новый виртуальный мир </h3></body></html>

Обратите внимание, что текст содержиттеги HTML. После этого напишем следующий скрипт:

<?php

$fp = fopen("Z:\\home\\localhost\\www\\newname.txt", "r");

while(!feof ($fp)) {

    $buf = fgetss($fp, 50);

    echo $buf;

}

fclose($fp)

?>

При выполнении этого скрипта все теги будут удалены и результат программы будет выглядеть следующим образом:

Добро пожаловать в новый виртуальный мир

Обычное предложение без каких-либо разделений, строковых переносов и шрифтовых выделений. Теперь применим к этому файлу немного другой скрипт, в котором у функции fgetss() будет присутствовать третий параметр.

<?php

$fp = fopen("Z:\\home\\localhost\\www\\newname.txt", "r");

while(!feof ($fp)) {

    $buf2 = fgetss($fp, 50, "<br>");

    echo $buf2;

}

fclose ($fp)

?>

В примере в качестве третьего параметра указан тег <br>, это значит что удалит все теги в строке, кроме <br>. В этом можно убедиться, посмотрев на результат работы скрипта:

Добро пожаловать

в новый виртуальный мир

Таким образом, начальная строка разбита на две.

Третий параметр функции fgetss() allowable_tags был добавлен в РНР 3.0,13.

В РНР существуют функции бинарного чтения файлов. Чтобы прочесть байты из файла, на который ссылается файловый указатель, используют функцию fread().

Она имеет следующий синтаксис:

string fread(int fp, int length)

Функция fread() читает байты из файла, на который ссылается файловый указатель fp, до заданной длины (length). Чтение заканчивается, когда прочитано такое количество байтов, которое было указано в параметре length, или достигнут EOF. Например:

$path = "/home/localhost/www/newname.txt";

$fp = fopen($path, "r");

$contents = fread($fp, filesize ($path));

fclose ($fp);

Функция возвращает строку со всем содержимым файла. В примере использована функция filesize(), которая позволяет получить размер файла (см. п. 26. 4).


ВНИМАНИЕ

В системах, которые имеют различия между двоичным файлом и текстовым (например, Windows), файл должен быть открыт при помощи включенного параметра 'b' в функцию fopen(). Например:

$path = "с:\\files\\newpic.gif";

$fp = fopen($path, "rb");

$contents = fread($fp, filesize ($path));

fclose($fp);

Все описанные функции используются в РНР 3 и PHP 4.

<< Предыдущий параграф Следующий параграф >>
Оглавление