XXXVII. System plików

Wstęp

Wymagania

Żadne zewnętrzne biblioteki nie są potrzebne do zbudowania tego rozszeżenia, jeśli jednak potrzebujesz PHP z obsługą LFS (dużych plików) na Linuksie, musisz mieć nowy glibc i skompilować PHP z następującą flagą kompilatora: -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64.

Instalacja

By używać tych funkcji, nie trzeba niczego instalować. Są one częścią jądra PHP.

Konfiguracja czasu wykonywania

Na działanie tych funcji wpływają ustawienia zawarte w pliku php.ini.

Tabela 1. Filesystem and Streams Configuration Options

Name	Default	Changeable	Changelog
allow_url_fopen	"1"	PHP_INI_SYSTEM	PHP_INI_ALL in PHP <= 4.3.4. Available since PHP 4.0.4.
user_agent	NULL	PHP_INI_ALL	Available since PHP 4.3.0.
default_socket_timeout	"60"	PHP_INI_ALL	Available since PHP 4.3.0.
from	NULL	??
auto_detect_line_endings	"0"	PHP_INI_ALL	Available since PHP 4.3.0.

Oto krótkie wyjaśnienie dyrektyw konfiguracji.

allow_url_fopen boolean

This option enables the URL-aware fopen wrappers that enable accessing URL object like files. Default wrappers are provided for the access of remote files using the ftp or http protocol, some extensions like zlib may register additional wrappers.

Notatka: This setting can only be set in php.ini due to security reasons.

Notatka: This option was introduced immediately after the release of version 4.0.3. For versions up to and including 4.0.3 you can only disable this feature at compile time by using the configuration switch --disable-url-fopen-wrapper.

Ostrzeżenie

On Windows versions prior to PHP 4.3.0, the following functions do not support remote file accessing: include(), include_once(), require(), require_once() and the imagecreatefromXXX functions in the Materiały źródłowe LII, Image Functions extension.

user_agent string

Define the user agent for PHP to send.

default_socket_timeout integer

Default timeout (in seconds) for socket based streams.

Notatka: This configuration option was introduced in PHP 4.3.0

from string

Define the anonymous ftp password (your email address).

auto_detect_line_endings boolean

When turned on, PHP will examine the data read by fgets() and file() to see if it is using Unix, MS-Dos or Macintosh line-ending conventions.

This enables PHP to interoperate with Macintosh systems, but defaults to Off, as there is a very small performance penalty when detecting the EOL conventions for the first line, and also because people using carriage-returns as item separators under Unix systems would experience non-backwards-compatible behaviour.

Notatka: This configuration option was introduced in PHP 4.3.0

Typy zasobów

Stałe predefinopwane

Poniższe stałe są zdefiniowane w tym rozszerzeniu i stają się dostępne, gdy rozszerzenie jest dokompilowane do PHP, lub załadowane dynamicznie przy starcie.

GLOB_BRACE (integer)
GLOB_ONLYDIR (integer)
GLOB_MARK (integer)
GLOB_NOSORT (integer)
GLOB_NOCHECK (integer)
GLOB_NOESCAPE (integer)
PATHINFO_DIRNAME (integer)
PATHINFO_BASENAME (integer)
PATHINFO_EXTENSION (integer)
FILE_USE_INCLUDE_PATH (integer)
FILE_APPEND (integer)
FILE_IGNORE_NEW_LINES (integer)
FILE_SKIP_EMPTY_LINES (integer)

Patrz także

Związane z tym działem funkcje, znajdziesz w rozdziale Katalog i Wykonywanie programów.

Listę wraz z opisem różnych wrapperów URL, które mogą zostać użyte jako zdalne pliki, znajdziesz tu Dodatek L.

Spis treści
basename -- Zwraca nazwę pliku, będącego składową ścieżki
chgrp -- Zmienia grupę pliku
chmod -- Zmienia prawa dostępu do pliku
chown -- Zmienia właściciela pliku
clearstatcache -- Czyści bufor statusu pliku
copy -- Kopiuje plik
delete -- Zobacz unlink() lub unset()
dirname -- Zwraca nazwę katalogu, będącego składową ścieżki
disk_free_space -- Zwraca ilość wolnego miejsca w katalogu
disk_total_space -- Zwraca całkowity rozmiar katalogu
diskfreespace -- Alias do disk_free_space()
fclose -- Zamyka otwarty wskaźnik pliku
feof -- Sprawdza czy wskaźnik pliku jest na końcu pliku (EOF)
fflush -- Przekierowuje wyjście do pliku
fgetc -- Pobiera znak ze wskaźnika pliku
fgetcsv -- Pobiera linię ze wskanika pliku i przetwarza na pola CSV
fgets -- Pobiera linię ze wskaźnika pliku
fgetss -- Pobiera linię ze wskaźnika pliku i usuwa tagi HTML
file_exists -- Sprawdza czy plik lub katalog istnieje
file_get_contents -- Reads entire file into a string
file_put_contents -- Write a string to a file
file -- Czyta całą zawartość pliku do tablicy
fileatime -- Pobiera ostatni czas dostępu do pliku
filectime -- Pobiera i-węzłowy czas zmiany pliku
filegroup -- Pobiera grupę pliku
fileinode -- Pobiera i-węzeł pliku
filemtime -- Pobiera czas ostatniej modyfikacji pliku
fileowner -- Pobiera właściciela pliku
fileperms -- Pobiera prawa dostępu pliku
filesize -- Pobiera rozmiar pliku
filetype -- Pobiera typ pliku
flock -- Portable advisory file locking
fnmatch -- Match filename against a pattern
fopen -- Otwiera plik lub URL
fpassthru -- Output all remaining data on a file pointer
fputcsv -- Format line as CSV and write to file pointer
fputs -- Alias funkcji fwrite()
fread -- Odczyt pliku binarnie bezpieczy
fscanf -- Przetwarza dane z pliku według formatu
fseek -- Seeks on a file pointer
fstat -- Pobiera informacje o pliku używając otwartego wskaźnika pliku
ftell -- Mówi o pozycji odczyt/zapis wskaźnika pliku
ftruncate -- Przycina plik do podanej długości
fwrite -- Zapis pliku binarnie bezpieczny
glob -- Find pathnames matching a pattern
is_dir -- Mówi czy nazwa_pliku jest katalogiem
is_executable -- Mówi czy plik jest wykonywalny
is_file -- Mówi czy nazwa_pliku jest zwykłym plikiem
is_link -- Mówi czy nazwa_pliku jest dowiązaniem symbolicznym
is_readable -- Tells whether the filename is readable
is_uploaded_file -- Mówi czy plik został przysłany przez HTTP POST.
is_writable -- Tells whether the filename is writable
is_writeable -- Alias do is_writable()
link -- Tworzy dowiązanie twarde
linkinfo -- Pobiera informacje o linku
lstat -- Podaje informacje o pliku lub dowiązaniu symbolicznym
mkdir -- Tworzy katalog
move_uploaded_file -- Przenieś uploadowany plik do innej lokalizacji
parse_ini_file -- Parse a configuration file
pathinfo -- Returns information about a file path
pclose -- Closes process file pointer
popen -- Otwiera wskaźnik pliku do procesu
readfile -- Wyświetla plik
readlink -- Zwraca cel linku symbolicznego
realpath -- Returns canonicalized absolute pathname
rename -- Renames a file or directory
rewind -- Rewind the position of a file pointer
rmdir -- Removes directory
set_file_buffer -- Alias of stream_set_write_buffer()
stat -- Gives information about a file
symlink -- Creates a symbolic link
tempnam -- Create file with unique file name
tmpfile -- Tworzy plik tymczasowy
touch -- Ustawia czas modyfikacji pliku
umask -- Changes the current umask
unlink -- Kasowanie pliku

User Contributed Notes


Here's a little function I wrote that I thought someone might find useful.  Ever notice those fancy breadcrumbed headings on Web sites such as Macromedia.com?  Ever say, "I want one, but I don't want to write the HTML in each time?"  Well, here you go.  This does that based on your directory structure.



Do note, however, that it only works if you use files and folders that are named like:

/my-folder/my-file.php

/my_folder/my_file.php

/My_Folder/My_File.php

/My-Folder/My-File.php

...and the variable <i>$path</i> must be similarly formatted.  A preceding forward slash (/) must be on that <i>$path</i>.  $_SERVER['PHP_SELF'], $_SERVER['DOCUMENT_ROOT'], and other $_SERVER variables always add that.



When I have some free time (sooner rather than later), I'm going to write a more in-depth script for this.  I just needed something simple for now.  You can expect a PHP 4 and PHP 5 script class dedicated to this one idea.  For now, this simple function does the trick.  Anyway, here you go:



<?php

function breadCrumbs($path)

{

    /**

     *  What it does is split a path string into its two base objects -- a

     *  file name and a directory name.

     *  

     *  After that, it then splits the directory into an array of sub-

     *  directories and adds them to a stack of links with keys of 'name'

     *  (directory name) and 'href' (hyperlink reference path).

     *

     *  Each item in this indexed associative array is then stacked again

     *  into an array of actual hyperlinks (i.e. <a href="Blah/Blah2.php">)

     *  split by a tree notification ( > ) of sorts.

     *

     *  Finally, the entire string, which may look like:

     *  <a href="#">Services</a> > <a href="#">Web</a>

     *  has the current file being viewed added to it.  That finished string

     *  is then returned to the calling script/function for display to the

     *  browser.

     *

     *  The returned HTML may look like:

     *  <a href="#">Services</a> > <a href="#">Web</a> > Home

     */

    

    // set the index file and name for each directory

    $dirIndex = 'Home.php';

    $dirIndexName = 'Home';

    

    // split $path into basename and dirname

    $file = basename($path, '.php');

    $dir  = dirname($path);

    

    // change all backslashes to forward slashes

    $dir  = str_replace('\\', '/', $dir);

    

    // remove preceding forward slash (/)

    $dir  = substr($dir, 1, strlen($dir));

    

    // ** ADDED **

    // add a trailing '/ ' to add a blank folder name - will be removed

    // NOTE: This is to ensure that an array IS created

    $dir .= '/ ';

    

    // split dirname into an array

    $dirs = preg_split('@\/@', $dir);

    

    // get the last array index from $dirs

    $lastIndex = count($dirs) - 1;

    

    // remove last $dirs if empty

    if ($dirs[$lastIndex] == '' || is_null($dirs[$lastIndex])) {

        unset($dirs[$lastIndex]);

    }

    

    // remove empty dir

    if ($dirs[$lastIndex] == ' ') {

        unset($dirs[$lastIndex]);

    }

    

    // get an accurate directory count

    $dirCount = count($dirs);

    

    // create $link and $links variables

    $link  = '/';

    $links = array();

    

    // stack each directory into a link and dirname

    for ($i = 0; $i < count($dirs); $i++) {

        // change $dirs[$i] into capitalized word(s) and add spaces (for

        // grammatical correctness)

        $link .= ucwords(preg_replace('@(-|_)@', ' ', $dirs[$i])) . '/';

        

        $links[$i]['href'] = $link . $dirIndex;

        $links[$i]['name'] = ucwords($dirs[$i]);

    }

    

    // instanciate $breadcrumbs array

    $breadcrumbs = array();

    

    // stack $links into HTML-equivalent links

    for ($i = 0; $i < count($links); $i++) {

        $breadcrumbs[$i] = '<a href="' . $links[$i]['href'] . '">' . $links[$i]['name'] . '</a>';

    }

    

    // see if links are needed or if a parent document

    if ($dirs[0] == '' || empty($dirs[0])) {

        // it is not so use just the file name

        $breadcrumb = $file;

    } else {

        // it is so compile the links into a breadcrumb string

        $breadcrumb  = '<a href="/' . $dirIndex . '">' . $dirIndexName . '</a> &#8212; ' . join($breadcrumbs, ' > ');

        $breadcrumb .= ' > ' . $file;

    }

    

    // return compiled breadcrumb string

    return $breadcrumb;

}

?>


Here is a little script that will enumerate a directory (given as a string) recursively.



The main working function is get_dir($path,$max_depth='')

Optional aguments:

$max_depth : obvious it'll limit the recursive depth.

Not so optional:

$l=0 : the first call must omit this, or explicitly set it to 0, since it represents the starting depth

$total='': the current total filesize; it should also be left alone, although it autosets itself to 0 on the first call;



In order to do something with the files other than just echoing them, simply replace the echo functions with your own;



Thanks to: 

dave at birko dot cjb dot net (for the nice filesize function)

vbwebprofi at gmx dot de  (for the fileperms function)



function get_dir($path,$max_depth='',$l=0,$total=''){

    if(!is_dir($path))return;

    $path=substr($path,-1)!="/"?$path."/":$path;

    if(!$l){

        echo "\nEnumerating directory $path :\n\n";

        $total=0;

    }

    if($max_depth==='' || ($max_depth>$l && is_int($max_depth))) $test_depth=true;

    else $test_depth=false;

    $pre="";

    $c=$l;

    while($c--)$pre.="\t";

    $dir=opendir($path);

    while($f=readdir($dir)){

        if($f=="."||$f=="..")continue;

        $file=$path.$f;

        $size="";

        if(is_file($file)||!is_dir($file)){

            $s=filesize($file);

            $total+=$s;

            $size="[ ".fsize($s)." ]";

            }

        else $f.="/";

        while(strlen($size)<16)

            $size=" ".$size;

        echo "\n".get_permissions(fileperms($file)).$size.$pre."\t".$f;

        if(is_dir($file) && $test_depth)

            $total=get_dir($file,$max_depth,$l+1,$total);

    }

    if(!$l)

        echo "\n\nTotal size: ".fsize($total);

    return $total;

}



function get_permissions($fperms) { 

   $out;

   if($fperms & 0x1000)     // FIFO pipe

     $out = 'p'; 

   elseif($fperms & 0x2000) // Character outecial

     $out = 'c'; 

   elseif($fperms & 0x3000) // Socket [ original value 0xD000, wrong for linux, but this is also registering as a directory... ant ideas?]

     $out = 's';

   elseif($fperms & 0x4000) // Directory

     $out = 'd'; 

   elseif($fperms & 0x6000) // Block outecial

     $out = 'b';

   elseif($fperms & 0x8000) // Regular

     $out = '-';

   elseif($fperms & 0xA000) // Symbolic Link

     $out = 'l';

   else                         // UNKNOWN

     $out = 'u'; 

   // owner

   $out .= (($fperms & 0x0100) ? 'r' : '-') .

          (($fperms & 0x0080) ? 'w' : '-') . 

          (($fperms & 0x0040) ? (($fperms & 0x0800) ? 's' : 'x' ) : 

                                   (($fperms & 0x0800) ? 'S' : '-')); 

   // group

   $out .= (($fperms & 0x0020) ? 'r' : '-') .

          (($fperms & 0x0010) ? 'w' : '-') . 

          (($fperms & 0x0008) ? (($fperms & 0x0400) ? 's' : 'x' ) : 

                                   (($fperms & 0x0400) ? 'S' : '-')); 

   // world

   $out .= (($fperms & 0x0004) ? 'r' : '-') .

           (($fperms & 0x0002) ? 'w' : '-') . 

           (($fperms & 0x0001) ? (($fperms & 0x0200) ? 't' : 'x' ) : 

                                  (($fperms & 0x0200) ? 'T' : '-')); 

   return $out;

 }



function fsize($size) {

       $a = array("B", "KB", "MB", "GB", "TB", "PB");

       $pos = 0;

       while ($size >= 1024) {

               $size /= 1024;

               $pos++;

       }

       return round($size,2)." ".$a[$pos];

}



//usage example

get_dir("/tmp/");    // full depth

get_dir("/tmp/",4); //maximum depth set to 4