Source for file Resource.php

Documentation is available at Resource.php

  1. <?php
  2. // vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4 fdm=marker encoding=utf8 :
  3. /**
  4.  * Pxxo - build self-supported and interoperable Web graphical components
  5.  * 
  6.  * Copyright (c) 2008, Nicolas Thouvenin
  7.  *
  8.  * All rights reserved.
  9.  *
  10.  * Redistribution and use in source and binary forms, with or without
  11.  * modification, are permitted provided that the following conditions are met:
  12.  *
  13.  *     * Redistributions of source code must retain the above copyright
  14.  *       notice, this list of conditions and the following disclaimer.
  15.  *     * Redistributions in binary form must reproduce the above copyright
  16.  *       notice, this list of conditions and the following disclaimer in the
  17.  *       documentation and/or other materials provided with the distribution.
  18.  *     * Neither the name of the author nor the names of its contributors may be
  19.  *       used to endorse or promote products derived from this software without
  20.  *       specific prior written permission.
  21.  *
  22.  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  23.  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  24.  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  25.  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  26.  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  27.  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  28.  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  29.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  31.  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32.  
  33.  * @package    Pxxo
  34.  * @copyright  Copyright (c) 2008 Nicolas Thouvenin
  35.  * @license    http://opensource.org/licenses/bsd-license.php
  36.  * @version    $Id: Resource.php,v 1.5 2008/03/05 15:17:49 thouveni Exp $
  37.  */
  38. require_once 'Pxxo/Buffer.php';
  39.  
  40. /**
  41.  * Classe permet de gérer l'accès à des flux de données comme des ressources WEB
  42.  *
  43.  * Un flux de type ressource renvoit une url vers un fichier contenant le flux.
  44.  *
  45.  * @package    Pxxo
  46.  * @copyright  Copyright (c) 2008 Nicolas Thouvenin
  47.  * @license    http://opensource.org/licenses/bsd-license.php
  48.  */
  49. class Pxxo_Buffer_Resource extends Pxxo_Buffer
  50. {
  51.     /**
  52.      * @var     string type du contenu du flux
  53.      */
  54.     protected $type = 'rsc';
  55.     /**
  56.      * @var        string url d'accès à la ressource
  57.      */
  58.     public $url = './';
  59.     /**
  60.      * @var        string chemin physique correspondant à l'url
  61.      */
  62.     public $path = '.';
  63.     /**
  64.      * @var    array chemin physique et chemin logique de la resource
  65.      */
  66.     public $file = array();
  67.     /**
  68.      * @var        string  file or inline : sous fomre de fichier ou de lignes de code inserées
  69.      */
  70.     protected $disposition = 'file';
  71.     /**
  72.      * Constructeur PHP5
  73.      *
  74.      * @param    string localisation du flux
  75.      */
  76.     function __construct($p)
  77.     {
  78.         parent::__construct($p);
  79.     }
  80.     /**
  81.      * On récupere le contenu de la ressource
  82.      *
  83.      * @return    mixed     Description
  84.      */
  85.     public function getContent() 
  86.     {
  87.         return parent::get();
  88.     }
  89.     /**
  90.      * On stocke le contenu du flux dans un fichier accessible via $this->url
  91.      *
  92.      * @return    string l'url d'accès au contenu du flux
  93.      */
  94.     public function get() 
  95.     {
  96.         // Calcul du nom et de l'emplacement du fichier
  97.         $id = $this->getID();
  98.         if (empty($id)) return null;
  99.         $filename = $id.'.'.$this->type;
  100.         $filepath = $this->path.DIRECTORY_SEPARATOR;
  101.         $file = $filepath.$filename;
  102.         $url = $this->url.'/'.str_replace(DIRECTORY_SEPARATOR, '/', $filename);
  103.  
  104.  
  105.         if (! $this->isCaching() || ! $this->testCacheLevel(P_C_RESOURCE) || ($this->isCaching() and $this->testCacheLevel(P_C_RESOURCE) and !file_exists($file))) {
  106.             $this->traceDebug("Buffer/RESOURCE\t[executed]\tlocalization(URI:".$this->uri.",\tRSC:".$url.')');
  107.  
  108.             // Création du Répertoire
  109.             if (!is_dir($filepath)) {
  110.                 if (!mkdir($filepath)) {
  111.                     trigger_error('Buffer_Resource failed  : unable to create '.$filepath, E_USER_ERROR);
  112.                 }
  113.                 chmod($filepath,0777);
  114.             }
  115.             // Création du fichier
  116.             if (!$handle = fopen($file, 'w'))
  117.             trigger_error('Buffer_Resource failed : unable to create '.$file, E_USER_ERROR);
  118.  
  119.             if (fwrite($handle, parent::get()) === FALSE)
  120.             trigger_error('Buffer_Resource failed : unable to write in'.$file, E_USER_ERROR);
  121.  
  122.             fclose($handle);
  123.             if (chmod($file,0777) === FALSE)
  124.             trigger_error('Buffer_Resource failed : unable to change permission for '.$file, E_USER_ERROR);
  125.         }
  126.         else $this->traceDebug("Buffer/RESOURCE\t[cached]\tlocalization(URI:".$this->uri.",\tRSC:".$url.')');
  127.         $this->file = array($file, $url);
  128.         return $url;
  129.     }
  130.     /**
  131.      * Merge un buffer avec le buffer courant
  132.      *
  133.      * @param   Pxxo_Buffer 
  134.      * @param boolean ajout ou non un commentaire
  135.      * @return  Pxxo_Buffer 
  136.      */
  137.     public function merge($o, $c = true) 
  138.     {
  139.         if ($c === true)
  140.             $com = $this->comment(
  141.                 ' ID('.$o->getID().')'.                
  142.                 ' URI('.$o->uri.')'.
  143.                 ' SCHEME('.$o->scheme.')'.
  144.                 ' WEIGHT('.$o->weight.')'.
  145.                 ' TYPE('.$o->getExtendedType().')');
  146.         else $com = '';
  147.  
  148.         if (method_exists($o,'getContent')) {
  149.             $this->set($this->getContent().$com.$o->getContent());
  150.             return $this;
  151.         }
  152.     }
  153.     /**
  154.      * Filtre permettant de minimiser une flux
  155.      *
  156.      * @param   string chaine de caractère
  157.      * @return    string chaine de caractère compressées
  158.      * @abstract
  159.      */
  160.     public function compress($s) 
  161.     {
  162.         return $s;
  163.     }
  164.     /**
  165.      * Fixe comme on utilisera le code Javascript
  166.      *
  167.      * @param    string 
  168.      */
  169.     public function setDisposition($s) 
  170.     {
  171.         if ($s == 'inline') $this->weight -= 50;
  172.         $this->disposition = $s;
  173.     }
  174.     /**
  175.      * Retourne le mode d'utilisation du code Javascript
  176.      *
  177.      * @return    string 
  178.      */
  179.     public function getDisposition() 
  180.     {
  181.         return $this->disposition;
  182.     }
  183.     /**
  184.      * Retrourne une chaine en HTML permettant de charger la ressource
  185.      *
  186.      * @return    string chaine de caractère en HTML
  187.      * @abstract
  188.      */
  189.     public function getHTML() 
  190.     {
  191.         // ...
  192.     }
  193.     /**
  194.      * Renvoi le type étendu du Buffer
  195.      *
  196.      * @return    string 
  197.      */
  198.     public function getExtendedType() 
  199.     {
  200.         return $this->type.':'.$this->disposition;
  201.     }
  202.     /**
  203.      * fabrique un commentaire à partir de la chaine donnée en paramètre
  204.      *
  205.      * @param string 
  206.      * @return string 
  207.      */
  208.     public function comment($s)
  209.     {
  210.         return '/* '.$s." */\n";
  211.     }    
  212. }

Documentation generated on Thu, 13 Mar 2008 22:03:20 +0100 by phpDocumentor 1.4.1