- PHP pathinfo
- Introduction to the PHP pathinfo() function
- PHP pathinfo() function examples
- 1) Using the pathinfo() function to get all components of a file path
- 2) Using the pathinfo() function to get only a specific component of a file path
- 3) Using the pathinfo() function to get the path components of a dot-file path
- Summary
- file_get_contents
- Parameters
- Return Values
- Errors/Exceptions
- Changelog
- Examples
- Notes
- See Also
- User Contributed Notes 6 notes
- Fileinfo Functions
PHP pathinfo
Summary: in this tutorial, you will learn how to use the PHP pathinfo() function to get the information on a file path.
Introduction to the PHP pathinfo() function
The PHP pathinfo() function accepts a file path and returns its components:
pathinfo ( string $path , int $flags = PATHINFO_ALL ) : array|string
Code language: PHP (php)
The pathinfo() function has two parameters:
- $path is the file path from which you want to get the information.
- $flags parameter specifies the part element to return.
The following table shows the valid flag values:
Flag | Meaning |
---|---|
PATHINFO_DIRNAME | Return the directory name |
PATHINFO_BASENAME | Return the base name |
PATHINFO_EXTENSION | Return the file extension |
PATHINFO_FILENAME | Return the file name (without the extension) |
If you don’t pass the $flag argument, the pathinfo() function will return all components of a file path.
PHP pathinfo() function examples
Let’s take some examples of using the pathinfo() function.
1) Using the pathinfo() function to get all components of a file path
The following example uses the pathinfo() function to get the components of a file path:
$path = 'htdocs/phptutorial/index.php'; $parts = pathinfo($path); print_r($parts);
Code language: HTML, XML (xml)
Array ( [dirname] => htdocs/phptutorial [basename] => index.php [extension] => php [filename] => index )
Code language: PHP (php)
2) Using the pathinfo() function to get only a specific component of a file path
The following example uses the pathinfo() function get the basename of a file path:
$path = 'htdocs/phptutorial/index.php'; $basename = pathinfo($path, PATHINFO_BASENAME); echo $basename;
Code language: HTML, XML (xml)
index.php
Code language: CSS (css)
3) Using the pathinfo() function to get the path components of a dot-file path
The following example uses the pathinfo() function to get components of the path of a dot-file:
$path = '/htdocs/phptutorial/.gitignore'; $parts = pathinfo($path); print_r($parts);
Code language: HTML, XML (xml)
Array ( [dirname] => /htdocs/phptutorial [basename] => .gitignore [extension] => gitignore [filename] => )
Code language: PHP (php)
Summary
- Use the PHP pathinfo() function to get the components of a file path including dirname, basename, filename, and extesion.
file_get_contents
This function is similar to file() , except that file_get_contents() returns the file in a string , starting at the specified offset up to length bytes. On failure, file_get_contents() will return false .
file_get_contents() is the preferred way to read the contents of a file into a string. It will use memory mapping techniques if supported by your OS to enhance performance.
Note:
If you’re opening a URI with special characters, such as spaces, you need to encode the URI with urlencode() .
Parameters
Note:
The FILE_USE_INCLUDE_PATH constant can be used to trigger include path search. This is not possible if strict typing is enabled, since FILE_USE_INCLUDE_PATH is an int . Use true instead.
A valid context resource created with stream_context_create() . If you don’t need to use a custom context, you can skip this parameter by null .
The offset where the reading starts on the original stream. Negative offsets count from the end of the stream.
Seeking ( offset ) is not supported with remote files. Attempting to seek on non-local files may work with small offsets, but this is unpredictable because it works on the buffered stream.
Maximum length of data read. The default is to read until end of file is reached. Note that this parameter is applied to the stream processed by the filters.
Return Values
The function returns the read data or false on failure.
This function may return Boolean false , but may also return a non-Boolean value which evaluates to false . Please read the section on Booleans for more information. Use the === operator for testing the return value of this function.
Errors/Exceptions
An E_WARNING level error is generated if filename cannot be found, length is less than zero, or if seeking to the specified offset in the stream fails.
When file_get_contents() is called on a directory, an E_WARNING level error is generated on Windows, and as of PHP 7.4 on other operating systems as well.
Changelog
Version | Description |
---|---|
8.0.0 | length is nullable now. |
7.1.0 | Support for negative offset s has been added. |
Examples
Example #1 Get and output the source of the homepage of a website
Example #2 Searching within the include_path
// If strict types are enabled i.e. declare(strict_types=1);
$file = file_get_contents ( ‘./people.txt’ , true );
// Otherwise
$file = file_get_contents ( ‘./people.txt’ , FILE_USE_INCLUDE_PATH );
?>?php
Example #3 Reading a section of a file
// Read 14 characters starting from the 21st character
$section = file_get_contents ( ‘./people.txt’ , FALSE , NULL , 20 , 14 );
var_dump ( $section );
?>?php
The above example will output something similar to:
Example #4 Using stream contexts
// Create a stream
$opts = array(
‘http’ =>array(
‘method’ => «GET» ,
‘header’ => «Accept-language: en\r\n» .
«Cookie: foo=bar\r\n»
)
);
?php
$context = stream_context_create ( $opts );
// Open the file using the HTTP headers set above
$file = file_get_contents ( ‘http://www.example.com/’ , false , $context );
?>
Notes
Note: This function is binary-safe.
A URL can be used as a filename with this function if the fopen wrappers have been enabled. See fopen() for more details on how to specify the filename. See the Supported Protocols and Wrappers for links to information about what abilities the various wrappers have, notes on their usage, and information on any predefined variables they may provide.
When using SSL, Microsoft IIS will violate the protocol by closing the connection without sending a close_notify indicator. PHP will report this as «SSL: Fatal Protocol Error» when you reach the end of the data. To work around this, the value of error_reporting should be lowered to a level that does not include warnings. PHP can detect buggy IIS server software when you open the stream using the https:// wrapper and will suppress the warning. When using fsockopen() to create an ssl:// socket, the developer is responsible for detecting and suppressing this warning.
See Also
- file() — Reads entire file into an array
- fgets() — Gets line from file pointer
- fread() — Binary-safe file read
- readfile() — Outputs a file
- file_put_contents() — Write data to a file
- stream_get_contents() — Reads remainder of a stream into a string
- stream_context_create() — Creates a stream context
- $http_response_header
User Contributed Notes 6 notes
file_get_contents can do a POST, create a context for that first:
$opts = array( ‘http’ =>
array(
‘method’ => ‘POST’ ,
‘header’ => «Content-Type: text/xml\r\n» .
«Authorization: Basic » . base64_encode ( » $https_user : $https_password » ). «\r\n» ,
‘content’ => $body ,
‘timeout’ => 60
)
);
$context = stream_context_create ( $opts );
$url = ‘https://’ . $https_server ;
$result = file_get_contents ( $url , false , $context , — 1 , 40000 );
Note that if an HTTP request fails but still has a response body, the result is still false, Not the response body which may have more details on why the request failed.
There’s barely a mention on this page but the $http_response_header will be populated with the HTTP headers if your file was a link. For example if you’re expecting an image you can do this:
$mimetype = null ;
foreach ( $http_response_header as $v ) if ( preg_match ( ‘/^content\-type:\s*(image\/[^;\s\n\r]+)/i’ , $v , $m )) $mimetype = $m [ 1 ];
>
>
if (! $mimetype ) // not an image
>
if the connection is
content-encoding: gzip
and you need to manually ungzip it, this is apparently the key
$c=gzinflate( substr($c,10,-8) );
(stolen from the net)
//从指定位置获取指定长度的文件内容
function file_start_length($path,$start=0,$length=null) if(!file_exists($path)) return false;
$size=filesize($path);
if($start <0) $start+=$size;
if($length===null) $length=$size-$start;
return file_get_contents($path, false, null, $start, $length );
>
I’m not sure why @jlh was downvoted, but I verified what he reported.
>>> file_get_contents($path false, null, 5, null)
=> «»
>>> file_get_contents($path, false, null, 5, 5)
=> «r/bin»
Fileinfo Functions
The results of this function seem to be of dubious quality.
eg
1) a Word doc returns:
‘application/msword application/msword’
. ok not too bad, but why does it come back twice?
3) a text doc that starts with the letters ‘GIF’ comes back as:
‘image/gif’
(just like in DanielWalker’s example for the unix ‘file’ command)
I had better results using the PEAR ‘MIME_Type’ package. It gave proper answers for 1 & 3 and identified the PHP file as ‘text/plain’ which is probably better than a false match for C++
Both finfo_file and MIME_Type correctly identified my other two test files which were a windows exe renamed with .doc extension, and a PDF also renamed with .doc extension.
/**
* @var str => $file = caminho para o arquivo (ABSOLUTO OU RELATIVO)
* @var arr => $file_info = array contendo as informações obtidas do arquivo informado
*/
private $file ;
private $file_info ;
/**
* @param str => $file = caminho para o arquivo (ABSOLUTO OU RELATIVO)
*/
public function get_file ( string $file ) clearstatcache ();
$file = str_replace (array( ‘/’ , ‘\\’ ), array( DIRECTORY_SEPARATOR , DIRECTORY_SEPARATOR ), $file );
if(! is_file ( $file ) && ! is_executable ( $file ) && ! is_readable ( $file )) throw new \ Exception ( ‘O arquivo informado não foi encontrado!’ );
>
$this -> file = $file ;
$this -> set_file_info ( $this -> file );
return $this ;
>
/**
* @param str => $index = se for informado um indice é retornada uma informação específica do arquivo
*/
public function get_info ( $index = » ) if( $this -> get_file_is_called ()) if( $index === » ) return $this -> file_info ;
>
if( $index != » ) if(! array_key_exists ( $index , $this -> file_info )) throw new \ Exception ( ‘A informação requisitada não foi encontrada!’ );
>
return $this -> file_info ;
>
>
>
/**
* @todo verifica se o método get_file() foi utilizado para informar o caminho do arquivo
*/
private function get_file_is_called () if(! $this -> file ) throw new \ Exception ( ‘Nenhum arquivo foi fornecido para análise. Utilize o método get_file() para isso!’ );
return false ;
>
return true ;
>
/**
* @todo preencher a array com as infos do arquivo
*/
private function set_file_info () $this -> file_info = array();
$pathinfo = pathinfo ( $this -> file );
$stat = stat ( $this -> file );
$this -> file_info [ ‘realpath’ ] = realpath ( $this -> file );
$this -> file_info [ ‘dirname’ ] = $pathinfo [ ‘dirname’ ];
$this -> file_info [ ‘basename’ ] = $pathinfo [ ‘basename’ ];
$this -> file_info [ ‘filename’ ] = $pathinfo [ ‘filename’ ];
$this -> file_info [ ‘extension’ ] = $pathinfo [ ‘extension’ ];
$this -> file_info [ ‘mime’ ] = finfo_file ( finfo_open ( FILEINFO_MIME_TYPE ), $this -> file );
$this -> file_info [ ‘encoding’ ] = finfo_file ( finfo_open ( FILEINFO_MIME_ENCODING ), $this -> file );
$this -> file_info [ ‘size’ ] = $stat [ 7 ];
$this -> file_info [ ‘size_string’ ] = $this -> format_bytes ( $stat [ 7 ]);
$this -> file_info [ ‘atime’ ] = $stat [ 8 ];
$this -> file_info [ ‘mtime’ ] = $stat [ 9 ];
$this -> file_info [ ‘permission’ ] = substr ( sprintf ( ‘%o’ , fileperms ( $this -> file )), — 4 );
$this -> file_info [ ‘fileowner’ ] = getenv ( ‘USERNAME’ );
>
/**
* @param int => $size = valor em bytes a ser formatado
*/
private function format_bytes ( int $size ) $base = log ( $size , 1024 );
$suffixes = array( » , ‘KB’ , ‘MB’ , ‘GB’ , ‘TB’ );
return round ( pow ( 1024 , $base — floor ( $base )), 2 ). » . $suffixes [ floor ( $base )];
>
>
var_dump ((new FileInfoTool )-> get_file ( ‘sitemap.xml’ )-> get_info ());
?>