project/modules/imagestream/Module.php

   1 <?php
   2
   3 /**
   4  * Pivip
   5  * Copyright (C) 2008  Vincent Tunru
   6
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; version 2
  10
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA
  19  *
  20  * @license   http://www.fsf.org/licensing/licenses/info/GPLv2.html GPL v.2
  21  * @category  PivipModulesDefault
  22  * @package   Module_Imagestream
  23  * @copyright (C) 2008 Vincent Tunru
  24  * @author    Vincent Tunru <email@vincentt.org>
  25  */
  26
  27 /**
  28  * Manage the Imagestream module
  29  *
  30  * @see /library/Pivip/Module/Abstract.php
  31  */
  32 class Imagestream_Module extends Pivip_Module_Abstract
  33 {
  34         /**
  35          * Check whether the Imagestream table exists
  36          *
  37          * @return boolean Whether the Imagestream module is installed
  38          */
  39         public static function isInstalled()
  40         {
  41                 if(!file_exists(CODE_PATH
  42                                 . 'application/models/generated/BaseImagestream.php'))
  43                 {
  44                         return false;
  45                 }
  46                 try
  47                 {
  48                         $imagestreamTable = Doctrine::getTable('Imagestream');
  49                 } catch(Exception $e) {
  50                         return false;
  51                 }
  52                 return true;
  53         }
  54
  55         /**
  56          * @return boolean False
  57          */
  58         public static function needsConfiguring()
  59         {
  60                 return false;
  61         }
  62
  63         /**
  64          * Install the Imagestream module
  65          */
  66         public function install()
  67         {
  68                 $nextRequest = new Zend_Controller_Request_Simple('index',
  69                                                              'install',
  70                                                              'imagestream');
  71                 $this->_pushStack($nextRequest);
  72         }
  73
  74         /**
  75          * Load the generic cache for use by this module
  76          *
  77          * @return Zend_Cache
  78          */
  79         public static function loadCache()
  80         {
  81                 $frontendOptions = array('cache_id_prefix' => 'imagestream_',
  82                                          'automatic_serialization' => true);
  83                 $cacheConfig = Zend_Registry::get('cacheConfig');
  84                 $cache = Zend_Cache::factory('Core',
  85                                              $cacheConfig->cache->backend,
  86                                              $frontendOptions,
  87                                              $cacheConfig->backendOptions->toArray());
  88                 return $cache;
  89         }
  90
  91         /**
  92          * @return array A list of the blocks this module provides for normal pages,
  93          *               in the format:
  94          *               array('section' => array('Link to add this block'
  95                                                         => 'Block name'))
  96          */
  97         public static function getPageBlocks($location)
  98         {
  99                 if(!self::isInstalled())
 100                 {
 101                         return array();
 102                 }
 103                 $translate = Zend_Registry::get('Zend_Translate');
 104                 $route = Zend_Controller_Front::getInstance()->getRouter()
 105                          ->getRoute('Imagestream_AddStream');
 106                 $blocks = array();
 107                 $sections = array('main');
 108                 foreach($sections as $section)
 109                 {
 110                         $blocks[$section] = array($route->assemble(array('section' => $section,
 111                                                                          'location'
 112                                                                                 => $location))
 113                                                         => $translate->_('Image stream'));
 114                 }
 115                 return $blocks;
 116         }
 117
 118         /**
 119          * Load the module
 120          */
 121         public function bootstrap()
 122         {
 123                 // Define the Access Control List
 124                 $acl = Zend_Registry::get('acl');
 125                 $acl->add(new Zend_Acl_Resource('imagestream'))
 126                     ->allow('admin', 'imagestream', 'write');
 127                 Zend_Registry::set('acl', $acl);
 128                 // Define the routes
 129                 $router = Zend_Controller_Front::getInstance()->getRouter();
 130                 $options = array('module' => 'imagestream', 'controller' => 'stream',
 131                                  'action' => 'add', 'location' => '');
 132                 $route = new Zend_Controller_Router_Route(
 133                                 'imagestream/add/:section/:location', $options);
 134                 $router->addRoute('Imagestream_AddStream', $route);
 135                 $options = array('module' => 'imagestream', 'controller' => 'stream',
 136                                  'action' => 'edit');
 137                 $route = new Zend_Controller_Router_Route('imagestream/edit/:stream_id',
 138                                                           $options);
 139                 $router->addRoute('Imagestream_EditStream', $route);
 140                 $options = array('module' => 'imagestream', 'controller' => 'stream',
 141                                  'action' => 'delete');
 142                 $route = new Zend_Controller_Router_Route('imagestream/delete/:stream_id',
 143                                                           $options);
 144                 $router->addRoute('Imagestream_DeleteStream', $route);
 145         }
 146 }