interface/modules/zend_modules/library/Zend/ProgressBar/Upload/AbstractUploadHandler.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2013 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\ProgressBar\Upload;
  11
  12 use Traversable;
  13 use Zend\ProgressBar\Adapter\AbstractAdapter as AbstractProgressAdapter;
  14 use Zend\ProgressBar\Exception;
  15 use Zend\ProgressBar\ProgressBar;
  16 use Zend\Stdlib\ArrayUtils;
  17
  18 /**
  19  * Abstract class for Upload Progress Handlers
  20  */
  21 abstract class AbstractUploadHandler implements UploadHandlerInterface
  22 {
  23     /**
  24      * @var string
  25      */
  26     protected $sessionNamespace = 'Zend\ProgressBar\Upload\AbstractUploadHandler';
  27
  28     /**
  29      * @var AbstractProgressAdapter|ProgressBar
  30      */
  31     protected $progressAdapter;
  32
  33     /**
  34      * @param  array|Traversable $options Optional options
  35      * @throws Exception\InvalidArgumentException
  36      */
  37     public function __construct($options = array())
  38     {
  39         if (!empty($options)) {
  40             $this->setOptions($options);
  41         }
  42     }
  43
  44     /**
  45      * Set options for a upload handler. Accepted options are:
  46      * - session_namespace: session namespace for upload progress
  47      * - progress_adapter: progressbar adapter to use for updating progress
  48      *
  49      * @param  array|Traversable $options
  50      * @return AbstractUploadHandler
  51      * @throws Exception\InvalidArgumentException
  52      */
  53     public function setOptions($options)
  54     {
  55         if ($options instanceof Traversable) {
  56             $options = ArrayUtils::iteratorToArray($options);
  57         } elseif (!is_array($options)) {
  58             throw new Exception\InvalidArgumentException(
  59                 'The options parameter must be an array or a Traversable'
  60             );
  61         }
  62
  63         if (isset($options['session_namespace'])) {
  64             $this->setSessionNamespace($options['session_namespace']);
  65         }
  66         if (isset($options['progress_adapter'])) {
  67             $this->setProgressAdapter($options['progress_adapter']);
  68         }
  69
  70         return $this;
  71     }
  72
  73     /**
  74      * @param  string $sessionNamespace
  75      * @return AbstractUploadHandler|UploadHandlerInterface
  76      */
  77     public function setSessionNamespace($sessionNamespace)
  78     {
  79         $this->sessionNamespace = $sessionNamespace;
  80         return $this;
  81     }
  82
  83     /**
  84      * @return string
  85      */
  86     public function getSessionNamespace()
  87     {
  88         return $this->sessionNamespace;
  89     }
  90
  91     /**
  92      * @param  AbstractProgressAdapter|ProgressBar $progressAdapter
  93      * @return AbstractUploadHandler|UploadHandlerInterface
  94      */
  95     public function setProgressAdapter($progressAdapter)
  96     {
  97         $this->progressAdapter = $progressAdapter;
  98         return $this;
  99     }
 100
 101     /**
 102      * @return AbstractProgressAdapter|ProgressBar
 103      */
 104     public function getProgressAdapter()
 105     {
 106         return $this->progressAdapter;
 107     }
 108
 109     /**
 110      * @param  string $id
 111      * @return array
 112      */
 113     public function getProgress($id)
 114     {
 115         $status  = array(
 116             'total'    => 0,
 117             'current'  => 0,
 118             'rate'     => 0,
 119             'message'  => 'No upload in progress',
 120             'done'     => true
 121         );
 122         if (empty($id)) {
 123             return $status;
 124         }
 125
 126         $newStatus = $this->getUploadProgress($id);
 127         if (false === $newStatus) {
 128             return $status;
 129         }
 130         $status = $newStatus;
 131         if ('' === $status['message']) {
 132             $status['message'] = $this->toByteString($status['current']) .
 133                 " - " . $this->toByteString($status['total']);
 134         }
 135         $status['id'] = $id;
 136
 137         $adapter = $this->getProgressAdapter();
 138         if (isset($adapter)) {
 139             if ($adapter instanceof AbstractProgressAdapter) {
 140                 $adapter = new ProgressBar(
 141                     $adapter, 0, $status['total'], $this->getSessionNamespace()
 142                 );
 143                 $this->setProgressAdapter($adapter);
 144             }
 145
 146             if (!$adapter instanceof ProgressBar) {
 147                 throw new Exception\RuntimeException('Unknown Adapter type given');
 148             }
 149
 150             if ($status['done']) {
 151                 $adapter->finish();
 152             } else {
 153                 $adapter->update($status['current'], $status['message']);
 154             }
 155         }
 156
 157         return $status;
 158     }
 159
 160     /**
 161      * @param  string $id
 162      * @return array|bool
 163      */
 164     abstract protected function getUploadProgress($id);
 165
 166     /**
 167      * Returns the formatted size
 168      *
 169      * @param  int $size
 170      * @return string
 171      */
 172     protected function toByteString($size)
 173     {
 174         $sizes = array('B', 'kB', 'MB', 'GB', 'TB', 'PB', 'EB', 'ZB', 'YB');
 175         for ($i=0; $size >= 1024 && $i < 9; $i++) {
 176             $size /= 1024;
 177         }
 178
 179         return round($size, 2) . $sizes[$i];
 180     }
 181 }