Class JArchive

Description
Description | Vars (details) | Methods (details)

An Archive handling class

  • since: 11.1

Located in /libraries/joomla/archive/archive.php (line 22) 


	
			






	
	

		
Variable Summary

		

			Description |
						Vars (details)
							| 
									Methods (details)
							
								

		

			

												

					 
					static array
					$adapters
				

																							

		

	


	
	

		
Method Summary

		

			Description |
																		Vars (details)
				 
				|
						Methods (details)
		

		
			
			

											
				

					 
					static 						boolean
										extract
											(string $archivename, string $extractdir)
									

															
				

					 
					static 						JArchiveExtractable
										getAdapter
											(string $type)
									

																															

		

	
		

	
	

		
Variables

		

			Description |
										Vars (details)
						
			
										| 
									Methods (details)
							
					

		

			



	

		
		
			static array
			$adapters
			 = array()			(line 28)
		
	


	
	
    
				
  • var: The array of instantiated archive adapters.
    • 
				
  • since: 12.1
    • 
				
  • access: protected
    • 
			

	
	
		
		




						
		

	

	
	
	

		
Methods

		

			Description |
															Vars (details)
																	Methods (details)
						
		

		

			



	
	

		
		static extract (line 41)
	
 
	
	

Extract an archive file to a directory.

	
    
				
  • return: True for success
    • 
				
  • throws: InvalidArgumentException
    • 
				
  • since: 11.1
    • 
				
  • access: public
    • 
			

	
	

		static boolean
		
			extract
		
					(string $archivename, string $extractdir)
			

	
			
    
					
  • 
				string
				$archivename: The name of the archive file			
    • 
					
  • 
				string
				$extractdir: Directory to unpack into			
    • 
				

		
			
	




	
	

		
		static getAdapter (line 181)
	
 
	
	

Get a file compression adapter.

	
    
				
  • return: Adapter for the requested type
    • 
				
  • throws: UnexpectedValueException
    • 
				
  • since: 11.1
    • 
				
  • access: public
    • 
			

	
	

		static JArchiveExtractable
		
			getAdapter
		
					(string $type)
			

	
			
    
					
  • 
				string
				$type: The type of adapter (bzip2|gzip|tar|zip).			
    • 
				

		
			
	

						
		

	


	
	

		Documentation generated on Tue, 19 Nov 2013 14:53:49 +0100 by phpDocumentor 1.4.3