/libraries/joomla/archive/extractable.php
PHP | 42 lines | 7 code | 3 blank | 32 comment | 0 complexity | 63c44cb55fbdb2fe2984562bf1bbb19b MD5 | raw file
Possible License(s): LGPL-2.1
1<?php 2/** 3 * @package Joomla.Platform 4 * @subpackage Archive 5 * 6 * @copyright Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved. 7 * @license GNU General Public License version 2 or later; see LICENSE 8 */ 9 10defined('JPATH_PLATFORM') or die; 11 12/** 13 * Archieve class interface 14 * 15 * @package Joomla.Platform 16 * @subpackage Archive 17 * @since 12.1 18 */ 19interface JArchiveExtractable 20{ 21 /** 22 * Extract a compressed file to a given path 23 * 24 * @param string $archive Path to archive to extract 25 * @param string $destination Path to extract archive to 26 * @param array $options Extraction options [may be unused] 27 * 28 * @return boolean True if successful 29 * 30 * @since 12.1 31 */ 32 public function extract($archive, $destination, array $options = array()); 33 34 /** 35 * Tests whether this adapter can unpack files on this computer. 36 * 37 * @return boolean True if supported 38 * 39 * @since 12.1 40 */ 41 public static function isSupported(); 42}