lib/plugin/CacheTest.php

   1 <?php // -*-php-*-
   2 // $Id$
   3 /*
   4  * Copyright (C) 2002 Johannes Große
   5  *
   6  * This file is part of PhpWiki.
   7  *
   8  * PhpWiki is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * PhpWiki is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with PhpWiki; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 // +---------------------------------------------------------------------+
  24 // | CacheTest.php                                                       |
  25 // +---------------------------------------------------------------------+
  26 // | simple test of the WikiPluginCached class which provides a          |
  27 // | text to image conversion.                                           |
  28 // | This is a usage example of WikiPluginCached.                        |
  29 // |                                                                     |
  30 // | You may copy this code freely under the conditions of the GPL       |
  31 // +---------------------------------------------------------------------+
  32
  33 /*------------------------------------------------------------------------
  34  | CacheTest
  35  *------------------------------------------------------------------------
  36  |
  37  | You may call this plugin as follows:
  38  |
  39  |        <<CacheTest text="What a wonderful test!" >>
  40  |
  41
  42 /*-----------------------------------------------------------------------
  43  |
  44  |  Source
  45  |
  46  *----------------------------------------------------------------------*/
  47
  48 /*-----------------------------------------------------------------------
  49  | WikiPlugin_CacheTest
  50  *----------------------------------------------------------------------*/
  51
  52 require_once "lib/WikiPluginCached.php";
  53
  54 class WikiPlugin_CacheTest
  55 extends WikiPluginCached
  56 {
  57     /* --------- overwrite virtual or abstract methods ---------------- */
  58
  59     function getPluginType() {
  60         return PLUGIN_CACHED_IMG_ONDEMAND;
  61     }
  62
  63     function getName() {
  64         return "CacheTest";
  65     }
  66
  67     function getDescription() {
  68         return 'This is a simple example using WikiPluginCached.';
  69     }
  70
  71     function getDefaultArguments() {
  72         return array('text' => $this->getDescription(),
  73                      'font' => '3',
  74                      'type' => 'png' );
  75     }
  76
  77     // should return image handle
  78     //
  79     // if an error occurs you MUST call
  80     // $this->complain('aboutwhichidocomplain') you may produce an
  81     // image handle to an error image if you do not,
  82     // WikiPluginImageCache will do so.
  83
  84     function getImage($dbi, $argarray, $request) {
  85         extract($argarray);
  86         return $this->produceGraphics($text,$font);
  87
  88         // This should also work
  89         // return $this->lazy_produceGraphics($text,$font);
  90     } // getImage
  91
  92
  93     function getImageType($dbi, $argarray, $request) {
  94         extract($argarray);
  95         if (in_array($type, array('png', 'gif', 'jpg'))) {
  96             return $type;
  97         }
  98         return 'png';
  99     }
 100
 101     function getAlt($dbi, $argarray, $request) {
 102         // ALT-text for <img> tag
 103         extract($argarray);
 104         return $text;
 105     }
 106
 107     function getExpire($dbi, $argarray, $request) {
 108         return '+600'; // 600 seconds life time
 109     }
 110
 111
 112     /* -------------------- extremely simple converter -------------------- */
 113
 114
 115     function produceGraphics($text, $font ) {
 116         // The idea (and some code) is stolen from the text2png plugin
 117         // but I did not want to use TTF. ImageString is quite ugly
 118         // and quite compatible. It's only a usage example.
 119
 120         if ($font<1 || $font>5) {
 121             $text = "Fontnr. (font=\"$font\") should be in range 1-5";
 122             $this->complain($text);
 123             $font = 3;
 124         }
 125
 126         $ok = ($im = @ImageCreate(400, 40));
 127         $bg_color    = ImageColorAllocate($im, 240, 240, 240);
 128         $text_color1 = ImageColorAllocate($im, 120, 120, 120);
 129         $text_color2 = ImageColorAllocate($im, 0, 0, 0);
 130
 131         ImageFilledRectangle($im, 0, 0, 149, 49, $bg_color);
 132         ImageString($im, $font, 11, 12, $text, $text_color1);
 133         ImageString($im, $font, 10, 10, $text, $text_color2);
 134
 135         if (!$ok) {
 136             // simple error handling by WikiPluginImageCache
 137             $this->complain("Could not create image");
 138             return false;
 139         }
 140
 141         // image creation takes really _much_ time :-)
 142         // so caching is very useful!
 143         sleep(4);
 144
 145         return $im;
 146     } // produce_Graphics
 147
 148     /* -------------------------------------------------------------------- */
 149
 150     // we could have used the simple built-in text2img function
 151     // instead of writing our own:
 152
 153     function lazy_produceGraphics( $text, $font ) {
 154         if ($font<1 || $font>5) {
 155             $text = "Fontnr. (font=\"$font\") should be in range 1-5";
 156             $this->complain($text);
 157             $font = 3;
 158
 159         }
 160
 161         return $this->text2img($text, $font, array(0, 0, 0),
 162                                array(255, 255, 255));
 163     } // lazy_produceGraphics
 164
 165 }
 166
 167 // Local Variables:
 168 // mode: php
 169 // tab-width: 8
 170 // c-basic-offset: 4
 171 // c-hanging-comment-ender-p: nil
 172 // indent-tabs-mode: nil
 173 // End:
 174 ?>