/libraries/joomla/archive/extractable.php

https://bitbucket.org/eternaware/joomus · PHP · 42 lines · 7 code · 3 blank · 32 comment · 0 complexity · 63c44cb55fbdb2fe2984562bf1bbb19b MD5 · raw file

  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. defined('JPATH_PLATFORM') or die;
  10. /**
  11. * Archieve class interface
  12. *
  13. * @package Joomla.Platform
  14. * @subpackage Archive
  15. * @since 12.1
  16. */
  17. interface JArchiveExtractable
  18. {
  19. /**
  20. * Extract a compressed file to a given path
  21. *
  22. * @param string $archive Path to archive to extract
  23. * @param string $destination Path to extract archive to
  24. * @param array $options Extraction options [may be unused]
  25. *
  26. * @return boolean True if successful
  27. *
  28. * @since 12.1
  29. */
  30. public function extract($archive, $destination, array $options = array());
  31. /**
  32. * Tests whether this adapter can unpack files on this computer.
  33. *
  34. * @return boolean True if supported
  35. *
  36. * @since 12.1
  37. */
  38. public static function isSupported();
  39. }