apidoc
[ class tree: apidoc ] [ index: apidoc ] [ all elements ]
Packages:
HTTP_Download


Classes:
HTTP_Download
   HTTP_Download

Class: HTTP_Download

Source Location: /HTTP_Download-0.8.0/Download.php

Class Overview




Send HTTP Downloads.




Author(s):






        
        

Version:


    
  
  • $Revision: 1.30 $
    • 








Variables






Methods
















Inherited Variables





Inherited Methods














Class Details



[line 133]

Send HTTP Downloads.
Error constants
With this package you can handle (hidden) downloads.  It supports partial downloads, resuming and sending  raw data ie. from database BLOBs.
ATTENTION:  You shouldn't use this package together with ob_gzhandler or  zlib.output_compression enabled in your php.ini, especially  if you want to send already gzipped data!
Usage Example 1:  
  1.  $params = array(
    2. 

  2.    'file'                  => '../hidden/download.tgz',
    3. 

  3.    'contenttype'           => 'application/x-gzip',
    4. 

  4.    'contentdisposition'    => array(HTTP_DOWNLOAD_ATTACHMENT, 'latest.tgz'),
    5. 

  5.  );
    6. 

  6.  
    7. 

  7.  $error = HTTP_Download::staticSend($params, false);
    8. 

Usage Example 2:  
  1.  $dl = &new HTTP_Download();
    2. 

  2.  $dl->setFile('../hidden/download.tgz');
    3. 

  3.  $dl->setContentDisposition(HTTP_DOWNLOAD_ATTACHMENT, 'latest.tgz');
    4. 

  4.  // with ext/magic.mime
    5. 

  5.  // $dl->guessContentType();
    6. 

  6.  // else:
    7. 

  7.  $dl->setContentType('application/x-gzip');
    8. 

  8.  $dl->send();
    9. 

Usage Example 3:  
  1.  $dl = &new HTTP_Download();
    2. 

  2.  $dl->setData($blob_from_db);
    3. 

  3.  $dl->setLastModified($unix_timestamp);
    4. 

  4.  $dl->setContentType('application/x-gzip');
    5. 

  5.  $dl->setContentDisposition(HTTP_DOWNLOAD_ATTACHMENT, 'latest.tgz');
    6. 

  6.  $dl->send();
    7. 



    

  • Author: Michael Wallner <mike@php.net>
    • 

  • Version: $Revision: 1.30 $
    • 

  • Access: public
    • 









[ Top ]







Class Variables



	
	

	
$cache =  true

	
[line 177]

  Whether to allow caching of the download on the clients side
Error constants


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      bool
    

      

	



	
[ Top ]


	
	

	
$data =  null

	
[line 152]

  Data for download
Error constants


    

  • See: HTTP_Download::setData()
    • 

  • Access: protected
    • 





  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$etag =  ''

	
[line 222]

  ETag
Error constants


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$file =  ''

	
[line 143]

  Path to file for download
Error constants


    

  • See: HTTP_Download::setFile()
    • 

  • Access: protected
    • 





  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$gzip =  false

	
[line 169]

  Whether to gzip the download
Error constants


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      bool
    

      

	



	
[ Top ]


	
	

	
$handle =  null

	
[line 161]

  Resource handle for download
Error constants


    

  • See: HTTP_Download::setResource()
    • 

  • Access: protected
    • 





  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]


	
	

	
$headers = array(

        'Content-Type'  => 'application/x-octetstream',

        'Cache-Control' => 'public',

        'Accept-Ranges' => 'bytes',

        'Connection'    => 'close'

    )

	
[line 201]

  HTTP headers
Error constants


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      array
    

      

	



	
[ Top ]


	
	

	
$HTTP =  null

	
[line 214]

  HTTP_Header
Error constants


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      object
    

      

	



	
[ Top ]


	
	

	
$lastModified =  ''

	
[line 193]

  Last modified (GMT)
Error constants


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      string
    

      

	



	
[ Top ]


	
	

	
$size =  0

	
[line 185]

  Size of download
Error constants


    

  • Access: protected
    • 





  

	

  

    

      Type:  
      int
    

      

	



	
[ Top ]










Method Detail



	
	
HTTP_Download (Constructor)   [line 254]

	

    

    

		HTTP_Download HTTP_Download(
[array
$params = array()])
    

    


	
		Constructor
Error constants  Set supplied parameters.


    

  • See: HTTP_Download::setContentDisposition()
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $params  
        — 
        
associative array of parameters
one of: 
  • 'file'                => path to file for download
  • 'data'                => raw data for download
  • 'resource'            => resource handle for download
 
    
           and any of:
  • 'gzip'                => whether to gzip the download
  • 'lastmodified'        => unix timestamp
  • 'contenttype'         => content type of download
  • 'contentdisposition'  => content disposition
  
  'Content-Disposition' is not HTTP compliant, but most browsers  follow this header, so it was borrowed from MIME standard.
It looks like this:  "Content-Disposition: attachment; filename=example.tgz".

      

        

    


        
[ Top ]

  

  
  
	
	
compareAsterisk   [line 877]

	

    

    

		bool compareAsterisk(
string
$svar, string
$compare)
    

    


	
		Compare against an asterisk or check for equality
Error constants


    

  • Access: protected
    • 








        
Parameters:

    

    

          

        string  
        $svar  
        — 
        key for the $_SERVER array
      

          

        string  
        $compare  
        — 
        string to compare
      

        

    


        
[ Top ]

  

  
  
	
	
generateETag   [line 703]

	

    

    

		string generateETag(
)
    

    


	
		Generate ETag
Error constants


    

  • Access: protected
    • 








        
[ Top ]

  

  
  
	
	
getChunks   [line 791]

	

    

    

		array getChunks(
)
    

    


	
		Get chunks to send
Error constants


    

  • Access: protected
    • 








        
[ Top ]

  

  
  
	
	
getRanges   [line 828]

	

    

    

		array getRanges(
)
    

    


	
		Get range request
Error constants


    

  • Access: protected
    • 








        
[ Top ]

  

  
  
	
	
guessContentType   [line 516]

	

    

    

		mixed guessContentType(
)
    

    


	
		Guess content type of file
Error constants  This only works if PHP is installed with ext/magic.mime AND php.ini  is setup correct! Otherwise it will result in a FATAL ERROR.  So be WARNED!
Returns PEAR_Error (HTTP_DOWNLOAD_E_NO_EXT_MMAGIC) if ext/magic.mime  is not installed, or not properly configured.


    

  • Return: Returns true on success or PEAR_Error on failure.
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
isCached   [line 840]

	

    

    

		bool isCached(
)
    

    


	
		Check if entity is cached
Error constants


    

  • Access: protected
    • 








        
[ Top ]

  

  
  
	
	
isRangeRequest   [line 814]

	

    

    

		bool isRangeRequest(
)
    

    


	
		Check if range is requested
Error constants


    

  • Access: protected
    • 








        
[ Top ]

  

  
  
	
	
isValidRange   [line 856]

	

    

    

		bool isValidRange(
)
    

    


	
		Check if entity hasn't changed
Error constants


    

  • Access: protected
    • 








        
[ Top ]

  

  
  
	
	
send   [line 543]

	

    

    

		mixed send(
)
    

    


	
		Send
Error constants  Returns PEAR_Error if: 
  • HTTP headers were already sent (HTTP_DOWNLOAD_E_HEADERS_SENT)
  • HTTP Range was invalid (HTTP_DOWNLOAD_E_INVALID_REQUEST)


    

  • Return: Returns true on success or PEAR_Error on failure.
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
sendArchive   [line 649]

	

    

    

		mixed sendArchive(
string
$name, mixed
$files, [string
$type = HTTP_DOWNLOAD_TGZ], [string
$add_path = ''], [string
$strip_path = ''])
    

    


	
		Send a bunch of files or directories as an archive
Error constants  Example:  
  1.    require_once 'HTTP/Download.php';
    2. 

  2.    HTTP_Download::sendArchive(
    3. 

  3.        'myArchive.tgz',
    4. 

  4.        '/var/ftp/pub/mike',
    5. 

  5.        HTTP_DOWNLOAD_BZ2,
    6. 

  6.        '',
    7. 

  7.        '/var/ftp/pub'
    8. 

  8.    );
    9. 



    

  • Return: Returns true on success or PEAR_Error on failure.
    • 

  • See: Archive_Tar::createModify()
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $name  
        — 
        name the sent archive should have
      

          

        mixed  
        $files  
        — 
        files/directories
      

          

        string  
        $type  
        — 
        archive type
      

          

        string  
        $add_path  
        — 
        path that should be prepended to the files
      

          

        string  
        $strip_path  
        — 
        path that should be stripped from the files
      

        

    


        
[ Top ]

  

  
  
	
	
sendChunk   [line 751]

	

    

    

		mixed sendChunk(
array
$chunk, [string
$cType = null], [string
$bound = null])
    

    


	
		Send chunk of data
Error constants


    

  • Return: Returns true on success or PEAR_Error on failure.
    • 

  • Access: protected
    • 








        
Parameters:

    

    

          

        array  
        $chunk  
        — 
        start and end offset of the chunk to send
      

          

        string  
        $cType  
        — 
        actual content type
      

          

        string  
        $bound  
        — 
        boundary for multipart/byteranges
      

        

    


        
[ Top ]

  

  
  
	
	
sendChunks   [line 722]

	

    

    

		mixed sendChunks(
array
$chunks)
    

    


	
		Send multiple chunks
Error constants


    

  • Return: Returns true on success or PEAR_Error on failure.
    • 

  • Access: protected
    • 








        
Parameters:

    

    

          

        array  
        $chunks  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
sendHeaders   [line 893]

	

    

    

		void sendHeaders(
)
    

    


	
		Send HTTP headers
Error constants


    

  • Access: protected
    • 








        
[ Top ]

  

  
  
	
	
setCache   [line 423]

	

    

    

		void setCache(
[bool
$cache = true])
    

    


	
		Whether to allow caching
Error constants  If set to true (default) we'll send some headers that are commonly  used for caching purposes like ETag, Cache-Control and Last-Modified.
If caching is disabled, we'll send the download no matter if it  would actually be cached at the clients side.


    

  • Access: public
    • 








        
Parameters:

    

    

          

        bool  
        $cache  
        — 
        whether to allow caching
      

        

    


        
[ Top ]

  

  
  
	
	
setContentDisposition   [line 466]

	

    

    

		void setContentDisposition(
[string
$disposition = HTTP_DOWNLOAD_ATTACHMENT], [string
$file_name = null])
    

    


	
		Set Content-Disposition header
Error constants


    

  • See: HTTP_Download::HTTP_Download
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $disposition  
        — 
        whether to send the download                                    inline or as attachment
      

          

        string  
        $file_name  
        — 
        
the filename to display in                                    the browser's download window
Example:  
  1.  $HTTP_Download->setContentDisposition(
    2. 

  2.    HTTP_DOWNLOAD_ATTACHMENT,
    3. 

  3.    'download.tgz'
    4. 

  4.  );
    5. 


      

        

    


        
[ Top ]

  

  
  
	
	
setContentType   [line 491]

	

    

    

		mixed setContentType(
[string
$content_type = 'application/x-octetstream'])
    

    


	
		Set content type of file for download
Error constants  Default content type of the download will be 'application/x-octetstream'.  Returns PEAR_Error (HTTP_DOWNLOAD_E_INVALID_CONTENT_TYPE) if  $content_type doesn't seem to be valid.


    

  • Return: Returns true on success or PEAR_Error on failure.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $content_type  
        — 
        content type of file for download
      

        

    


        
[ Top ]

  

  
  
	
	
setData   [line 350]

	

    

    

		void setData(
[$data
$data = null])
    

    


	
		Set data for download
Error constants  Set $data to null if you want to unset this.


    

  • Access: public
    • 








        
Parameters:

    

    

          

        $data  
        $data  
        — 
        raw data to send
      

        

    


        
[ Top ]

  

  
  
	
	
setFile   [line 323]

	

    

    

		mixed setFile(
string
$file, [bool
$send_404 = true])
    

    


	
		Set path to file for download
Error constants  The Last-Modified header will be set to files filemtime(), actually.  Returns PEAR_Error (HTTP_DOWNLOAD_E_INVALID_FILE) if file doesn't exist.  Sends HTTP 404 Status if $send_404 is set to true.


    

  • Return: Returns true on success or PEAR_Error on failure.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $file  
        — 
        path to file for download
      

          

        bool  
        $send_404  
        — 
        whether to send HTTP/404 if                                the file wasn't found
      

        

    


        
[ Top ]

  

  
  
	
	
setGzip   [line 398]

	

    

    

		mixed setGzip(
[bool
$gzip = false])
    

    


	
		Whether to gzip the download
Error constants  Returns a PEAR_Error (HTTP_DOWNLOAD_E_NO_EXT_ZLIB)  if ext/zlib is not available/loadable.


    

  • Return: Returns true on success or PEAR_Error on failure.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        bool  
        $gzip  
        — 
        whether to gzip the download
      

        

    


        
[ Top ]

  

  
  
	
	
setLastModified   [line 440]

	

    

    

		void setLastModified(
int
$last_modified)
    

    


	
		Set "Last-Modified"
Error constants  This is usually determined by filemtime($file) in HTTP_Download::setFile()  If you set raw data for download with HTTP_Download::setData() and you  want do send an appropiate "Last-Modified" header, you should call this  method.


    

  • Access: public
    • 








        
Parameters:

    

    

          

        int  
        $last_modified  
        — 
        unix timestamp
      

        

    


        
[ Top ]

  

  
  
	
	
setParams   [line 282]

	

    

    

		mixed setParams(
array
$params)
    

    


	
		Set parameters
Error constants  Set supplied parameters through its accessor methods.


    

  • Return: true on success or PEAR_Error
    • 

  • See: HTTP_Download::HTTP_Download()
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $params  
        — 
        associative array of parameters
      

        

    


        
[ Top ]

  

  
  
	
	
setResource   [line 367]

	

    

    

		mixed setResource(
[int
$handle = null])
    

    


	
		Set resource for download
Error constants  The resource handle supplied will be closed after sending the download.  Returns a PEAR_Error (HTTP_DOWNLOAD_E_INVALID_RESOURCE) if $handle  is no valid resource. Set $handle to null if you want to unset this.


    

  • Return: Returns true on success or PEAR_Error on failure.
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        int  
        $handle  
        — 
        resource handle
      

        

    


        
[ Top ]

  

  
  
	
	
staticSend   [line 608]

	

    

    

		mixed staticSend(
array
$params, [bool
$guess = false])
    

    


	
		Static send
Error constants


    

  • Return: Returns true on success or PEAR_Error on failure.
    • 

  • See: HTTP_Download::HTTP_Download()
    • 

  • See: HTTP_Download::send()
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $params  
        — 
        associative array of parameters
      

          

        bool  
        $guess  
        — 
        whether HTTP_Download::guessContentType()                                should be called
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Mon, 11 Mar 2019 10:17:21 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright ©  PHP Group 2004.