Class JArchiveGzip

Description
Description | Methods (details)

Implements interfaces:

Gzip format adapter for the JArchive class

This class is inspired from and draws heavily in code and concept from the Compress package of The Horde Project <http://www.horde.org>

  • since: 11.1

Located in /libraries/joomla/archive/gzip.php (line 27) 


	
			







	
	

		
Method Summary

		

			Description |
												Methods (details)
		

		
			
			

																			
				

					 
					static 						boolean
										isSupported
										()
									

																											
				

					 
											boolean
										extract
											(string $archive, string $destination, [array $options = array ()])
									

																							
				

					 
											integer
										_getFilePosition
										()
									

											

		

	
		

	
	
	

		
Methods

		

			Description |
																Methods (details)
						
		

		

			



	
	

		
		static isSupported (line 188)
	
 
	
	

Tests whether this adapter can unpack files on this computer.

	
    
				
  • return: True if supported
    • 
				
  • since: 11.3
    • 
				
  • access: public
    • 
			

	
	

		static boolean
		
			isSupported
		
				()
			

	
		
				

		
Implementation of:

			

			
JArchiveExtractable::isSupported()

						
Tests whether this adapter can unpack files on this computer.

					

			
	




	
	

		
		extract (line 57)
	
 
	
	

Extract a Gzip compressed file to a given path

	
    
				
  • return: True if successful
    • 
				
  • since: 11.1
    • 
				
  • throws: RuntimeException
    • 
				
  • access: public
    • 
			

	
	

		boolean
		
			extract
		
					(string $archive, string $destination, [array $options = array ()])
			

	
			
    
					
  • 
				string
				$archive: Path to ZIP archive to extract			
    • 
					
  • 
				string
				$destination: Path to extract archive to			
    • 
					
  • 
				array
				$options: Extraction options [unused]			
    • 
				

		
				

		
Implementation of:

			

			
JArchiveExtractable::extract()

						
Extract a compressed file to a given path

					

			
	




	
	

		
		_getFilePosition (line 201)
	
 
	
	

Get file data offset for archive

	
    
				
  • return: Data position marker for archive
    • 
				
  • since: 11.1
    • 
				
  • throws: RuntimeException
    • 
				
  • access: public
    • 
			

	
	

		integer
		
			_getFilePosition
		
				()
			

	
		
			
	

						
		

	


	
	

		Documentation generated on Tue, 19 Nov 2013 15:04:12 +0100 by phpDocumentor 1.4.3