[Summary view]

   1  <?php
   2  
   3  namespace Box\Spout\Writer\Common\Helper;
   4  
   5  use Box\Spout\Common\Helper\FileSystemHelperInterface;
   6  
   7  /**
   8   * Class FileSystemHelperInterface
   9   * This interface describes helper functions to help with the file system operations
  10   * like files/folders creation & deletion
  11   */
  12  interface FileSystemWithRootFolderHelperInterface extends FileSystemHelperInterface
  13  {
  14      /**
  15       * Creates all the folders needed to create a spreadsheet, as well as the files that won't change.
  16       *
  17       * @throws \Box\Spout\Common\Exception\IOException If unable to create at least one of the base folders
  18       * @return void
  19       */
  20      public function createBaseFilesAndFolders();
  21  
  22      /**
  23       * @return string
  24       */
  25      public function getRootFolder();
  26  }