PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class TTarFileExtractor

TTarFileExtractor class

Package: System\IO
Copyright: Copyright © 1997-2003 The PHP Group
Author: Vincent Blavet <vincent@phpconcept.net>
Since: 3.0
Located at IO/TTarFileExtractor.php
Methods summary
public
# __construct( string $p_tarname )

Archive_Tar Class constructor. This flavour of the constructor only declare a new Archive_Tar object, identifying it by the name of the tar file.

Archive_Tar Class constructor. This flavour of the constructor only declare a new Archive_Tar object, identifying it by the name of the tar file.

Parameters

$p_tarname
string
$p_tarname The name of the tar archive to create
public
# __destruct( )
public
# extract( mixed $p_path = '' )
protected boolean
# extractModify( string $p_path, string $p_remove_path )

This method extract all the content of the archive in the directory indicated by $p_path. When relevant the memorized path of the files/dir can be modified by removing the $p_remove_path path at the beginning of the file/dir path. While extracting a file, if the directory path does not exists it is created. While extracting a file, if the file already exists it is replaced without looking for last modification date. While extracting a file, if the file already exists and is write protected, the extraction is aborted. While extracting a file, if a directory with the same name already exists, the extraction is aborted. While extracting a directory, if a file with the same name already exists, the extraction is aborted. While extracting a file/directory if the destination directory exist and is write protected, or does not exist but can not be created, the extraction is aborted. If after extraction an extracted file does not show the correct stored file size, the extraction is aborted. When the extraction is aborted, a PEAR error text is set and false is returned. However the result can be a partial extraction that may need to be manually cleaned.

This method extract all the content of the archive in the directory indicated by $p_path. When relevant the memorized path of the files/dir can be modified by removing the $p_remove_path path at the beginning of the file/dir path. While extracting a file, if the directory path does not exists it is created. While extracting a file, if the file already exists it is replaced without looking for last modification date. While extracting a file, if the file already exists and is write protected, the extraction is aborted. While extracting a file, if a directory with the same name already exists, the extraction is aborted. While extracting a directory, if a file with the same name already exists, the extraction is aborted. While extracting a file/directory if the destination directory exist and is write protected, or does not exist but can not be created, the extraction is aborted. If after extraction an extracted file does not show the correct stored file size, the extraction is aborted. When the extraction is aborted, a PEAR error text is set and false is returned. However the result can be a partial extraction that may need to be manually cleaned.

Parameters

$p_path
string
$p_path The path of the directory where the files/dir need to by extracted.
$p_remove_path
string
$p_remove_path Part of the memorized path that can be removed if present at the beginning of the file/dir path.

Returns

boolean
true on success, false on error.
protected
# _error( mixed $p_message )
protected
# _extractList( mixed $p_path, mixed & $p_list_detail, mixed $p_mode, mixed $p_file_list, mixed $p_remove_path )
protected boolean
# _dirCheck( string $p_dir )

Check if a directory exists and create it (including parent dirs) if not.

Check if a directory exists and create it (including parent dirs) if not.

Parameters

$p_dir
string
$p_dir directory to check

Returns

boolean
true if the directory exists or was created
protected
# _translateWinPath( mixed $p_path, mixed $p_remove_disk_letter = true )
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO