PHP_Archive
[ class tree: PHP_Archive ] [ index: PHP_Archive ] [ all elements ]
Packages:
PHP_Archive


Classes:
PHP_Archive
PHP_Archive_Creator
PHP_Archive_Exception
PHP_Archive_Manager
PHP_Archive
   PHP_Archive_ExceptionExtended
Files:
Archive.php
Creator.php
Exception.php
Manager.php

Class: PHP_Archive_Creator

Source Location: /PHP_Archive-0.9.2/Archive/Creator.php

Class Overview




PHP_Archive Class creator (implements .phar)




Author(s):






            
          
      

Version:


    
  
  • $Id: Creator.php,v 1.34 2006/12/16 04:22:20 cellog Exp $
    • 




Copyright:


    
  
  • Copyright ? David Shafik and Synaptic Media 2004. All rights reserved.
    • 







Variables






Methods
















Inherited Variables





Inherited Methods














Class Details



[line 30]

PHP_Archive Class creator (implements .phar)
PHAR files a singular archive from which an entire application can run.  To use it, simply package it using {@see PHP_Archive_Creator} and use phar://  URIs to your includes. i.e. require_once 'phar://config.php' will include config.php  from the root of the PHAR file.
Gz code borrowed from the excellent File_Archive package by Vincent Lascaux.









[ Top ]







Class Variables



	
	

	
$alias = 

	
[line 50]

  


    

  • Var: The phar alias
    • 

  • Access: protected
    • 





  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$archive_name = 

	
[line 35]

  


    

  • Var: The Archive Filename
    • 

  • Access: protected
    • 





  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$collapse =  false

	
[line 60]

  


    

  • Var: Whether or not to collapse (remove whitespace/comments)
    • 

  • Access: protected
    • 





  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$compress =  false

	
[line 55]

  


    

  • Var: Whether or not the archive should be compressed
    • 

  • Access: protected
    • 





  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$manifest = array()

	
[line 72]

  Used to construct the internal manifest, or listing of files/directories


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$modified =  false

	
[line 65]

  


    

  • Var: Whether or not a file has been added to the archive
    • 

  • Access: protected
    • 





  

	

  

    

      Type:  
      boolean
    

      

	



	
[ Top ]


	
	

	
$save_path = 

	
[line 45]

  


    

  • Var: Where the TAR archive will be saved
    • 

  • Access: protected
    • 





  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$temp_path = 

	
[line 40]

  


    

  • Var: The temporary path to the TAR archive
    • 

  • Access: protected
    • 





  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]










Method Detail



	
	
__construct (Constructor)   [line 146]

	

    

    

		PHP_Archive_Creator __construct(
[string|false
$init_file = 'index.php'], string
$alias, [boolean
$compress = false], [bool
$relyOnPhar = false], [bool
$collapse = false])
    

    


	
		PHP_Archive Constructor


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string|false  
        $init_file  
        — 
        Init file (file called by default upon PHAR execution).                                 if false, none will be called, and execution will return.                                 use this option for libraries
      

          

        string  
        $alias  
        — 
        alias name like "go-pear.phar" to be used for opening                       files from this phar
      

          

        boolean  
        $compress  
        — 
        Whether to compress the files or not (will cause slowdown!)
      

          

        bool  
        $relyOnPhar  
        — 
        if true, then a slim, phar extension-dependent .phar will be                          created
      

          

        bool  
        $collapse  
        — 
        Remove whitespace and comments from PHP_Archive class
      

        

    


        
[ Top ]

  

  
  
	
	
addArray   [line 567]

	

    

    

		unknown addArray(
unknown_type
$files, [bool
$magicrequire = false])
    

    


	
		add an array of files to the archive


    

  • Access: public
    • 








        
Parameters:

    

    

          

        unknown_type  
        $files  
        — 
        
      

          

        bool  
        $magicrequire  
        — 
        determines whether to attempt to replace all                            calls to require or include with internal                            phar includes
      

        

    


        
[ Top ]

  

  
  
	
	
addDir   [line 519]

	

    

    

		boolean addDir(
string
$dir, [array
$ignore = array()], [array
$include = array()], [bool
$magicrequire = false])
    

    


	
		Add a directory to the archive


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $dir  
        — 
        The directory path to add
      

          

        array  
        $ignore  
        — 
        files to ignore
      

          

        array  
        $include  
        — 
        files to include (all others ignored)
      

          

        bool  
        $magicrequire  
        — 
        If set, then "require_once '" will be replaced with                "require_once 'phar://$magicrequire/"
      

        

    


        
[ Top ]

  

  
  
	
	
addFile   [line 227]

	

    

    

		boolean addFile(
string
$file, string
$save_path, [
$magicrequire = false])
    

    


	
		Add a file to the PHP Archive


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $file  
        — 
        Path of the File to add
      

          

        string  
        $save_path  
        — 
        The save location of the file in the archive
      

          

          
        $magicrequire  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
addMagicRequireCallback   [line 212]

	

    

    

		void addMagicRequireCallback(
callback
$callback)
    

    


	
		Specify a custom "magic require" callback for processing file contents.
This will be called regardless of the magicrequire parameter's  value for addString() or addFile()


    

  • Access: public
    • 








        
Parameters:

    

    

          

        callback  
        $callback  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
addString   [line 240]

	

    

    

		boolean addString(
string
$file_contents, string
$save_path, [
$magicrequire = false])
    

    


	
		Add a string to the PHP Archive as a file


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $file_contents  
        — 
        Contents of the File to add
      

          

        string  
        $save_path  
        — 
        The save location of the file in the archive
      

          

          
        $magicrequire  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
dirList   [line 458]

	

    

    

		array dirList(
string
$directory, [
$toplevel = null])
    

    


	
		Retrieve a listing of every file in $directory and  all subdirectories.
The return format is an array of full paths to files


    

  • Return: list of files in a directory
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $directory  
        — 
        full path to the directory you want the list of
      

          

          
        $toplevel  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
limitedSmartMagicRequire   [line 300]

	

    

    

		void limitedSmartMagicRequire(
string
$contents, string
$path)
    

    


	
		prepends "phar://alias" only to include/require that use quotes


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $contents  
        — 
        file contents
      

          

        string  
        $path  
        — 
        internal path of the file
      

        

    


        
[ Top ]

  

  
  
	
	
offsetExists   [line 85]

	

    

    

		void offsetExists(

$offset)
    

    


	
		ArrayAccess methods


    

  • Access: public
    • 








        
Parameters:

    

    

          

          
        $offset  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
offsetGet   [line 90]

	

    

    

		void offsetGet(

$offset)
    

    


	
		ArrayAccess methods


    

  • Access: public
    • 








        
Parameters:

    

    

          

          
        $offset  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
offsetSet   [line 97]

	

    

    

		void offsetSet(

$offset, 
$value)
    

    


	
		ArrayAccess methods


    

  • Access: public
    • 








        
Parameters:

    

    

          

          
        $offset  
        — 
        
      

          

          
        $value  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
offsetUnset   [line 104]

	

    

    

		void offsetUnset(

$offset)
    

    


	
		ArrayAccess methods


    

  • Access: public
    • 








        
Parameters:

    

    

          

          
        $offset  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
processFile   [line 115]

	

    

    

		void processFile(
string
$path)
    

    


	
		


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $path  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
savePhar   [line 584]

	

    

    

		bool savePhar(
string
$file_path)
    

    


	
		Construct the .phar and save it


    

  • Return: success of operation
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $file_path  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
serializeManifest   [line 641]

	

    

    

		string serializeManifest(
array
$manifest)
    

    


	
		serialize the manifest in a C-friendly way


    

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $manifest  
        — 
        An array like so:  
  1.    $manifest[] = array(
    2. 

  2.       $savepath,
    3. 

  3.       $size, // original size = 0
    4. 

  4.       time(), // save time = 1
    5. 

  5.       $offset, // offset from start of files = 2
    6. 

  6.       $info['actualsize']); // actual size in the .phar = 3
    7. 


      

        

    


        
[ Top ]

  

  
  
	
	
simpleMagicRequire   [line 285]

	

    

    

		void simpleMagicRequire(
string
$contents, string
$path)
    

    


	
		prepends all include/require calls with "phar://alias"


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $contents  
        — 
        file contents
      

          

        string  
        $path  
        — 
        internal path of the file
      

        

    


        
[ Top ]

  

  
  
	
	
smartMagicRequire   [line 314]

	

    

    

		void smartMagicRequire(
string
$contents, string
$path)
    

    


	
		The basic magicrequire callback (implements old-fashioned magicrequire)


    

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $contents  
        — 
        file contents
      

          

        string  
        $path  
        — 
        internal path of the file
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Mon, 11 Mar 2019 14:53:03 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright ©  PHP Group 2004.