[Sommaire] [Imprimer]

   1  <?php
   2  //
   3  // Definition of eZCompressionHandler class
   4  //
   5  // Created on: <13-Aug-2003 16:20:19 amos>
   6  //
   7  // SOFTWARE NAME: eZ publish
   8  // SOFTWARE RELEASE: 3.9.0
   9  // BUILD VERSION: 17785
  10  // COPYRIGHT NOTICE: Copyright (C) 1999-2006 eZ systems AS
  11  // SOFTWARE LICENSE: GNU General Public License v2.0
  12  // NOTICE: >
  13  //   This program is free software; you can redistribute it and/or
  14  //   modify it under the terms of version 2.0  of the GNU General
  15  //   Public License as published by the Free Software Foundation.
  16  //
  17  //   This program is distributed in the hope that it will be useful,
  18  //   but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  //   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  //   GNU General Public License for more details.
  21  //
  22  //   You should have received a copy of version 2.0 of the GNU General
  23  //   Public License along with this program; if not, write to the Free
  24  //   Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
  25  //   MA 02110-1301, USA.
  26  //
  27  //
  28  
  29  /*! \file ezcompressionhandler.php
  30  */
  31  
  32  /*!
  33    \class eZCompressionHandler ezcompressionhandler.php
  34    \brief Interface for file handlers using compression
  35  
  36    Generic interface for all file handlers using compression.
  37  
  38    This class introduces two new functions from the eZFileHandler base class,
  39    they are compress() and decompress() and are used for string based
  40    compression.
  41  
  42    \h1 Creating specific handlers
  43  
  44    The compressor handlers must inherit from this class and reimplement
  45    some virtual functions.
  46  
  47    For dealing with compressed strings the following functions must be reimplemented.
  48    compress() and decompress()
  49  
  50    The handlers must also implement the virtual functions defined in eZFileHandler.
  51  
  52  */
  53  
  54  include_once ( 'lib/ezfile/classes/ezfilehandler.php' );
  55  
  56  class eZCompressionHandler extends eZFileHandler
  57  {
  58      /*!
  59       Initializes the handler. Optionally the parameters \a $filename
  60       and \a $mode may be provided to automatically open the file.
  61      */
  62      function eZCompressionHandler( $handlerIdentifier, $handlerName )
  63      {
  64          $this->eZFileHandler( $handlerIdentifier, $handlerName );
  65      }
  66  
  67      /*!
  68       \pure
  69       Compress the \a $source string and return it as compressed data.
  70      */
  71      function compress( $source )
  72      {
  73      }
  74  
  75      /*!
  76       \pure
  77       Decompress the \a $source string containing compressed data and return it as a string.
  78      */
  79      function decompress( $source )
  80      {
  81      }
  82  }
  83  
  84  ?>