Subversion Repositories Applications.papyrus

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
178 jpm 1
<?php
2
/*vim: set expandtab tabstop=4 shiftwidth=4: */
3
// +------------------------------------------------------------------------------------------------------+
4
// | PHP version 4.3                                                                                      |
5
// +------------------------------------------------------------------------------------------------------+
6
// | Copyright (C) 2004 Tela Botanica (accueil@tela-botanica.org)                                         |
7
// +------------------------------------------------------------------------------------------------------+
8
// | This file is part of Papyrus.                                                                        |
9
// |                                                                                                      |
10
// | Foobar is free software; you can redistribute it and/or modify                                       |
11
// | it under the terms of the GNU General Public License as published by                                 |
12
// | the Free Software Foundation; either version 2 of the License, or                                    |
13
// | (at your option) any later version.                                                                  |
14
// |                                                                                                      |
15
// | Foobar is distributed in the hope that it will be useful,                                            |
16
// | but WITHOUT ANY WARRANTY; without even the implied warranty of                                       |
17
// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                                        |
18
// | GNU General Public License for more details.                                                         |
19
// |                                                                                                      |
20
// | You should have received a copy of the GNU General Public License                                    |
21
// | along with Foobar; if not, write to the Free Software                                                |
22
// | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                            |
23
// +------------------------------------------------------------------------------------------------------+
453 ddelon 24
// CVS : $Id: Papyrus.class.php,v 1.7 2005-09-23 13:58:07 ddelon Exp $
178 jpm 25
/**
26
* Classe configurant le formatage pour Papyrus.
27
*
28
* Ce fichier contient une classe configurant les règles de formatage de Papyrus.
29
* Nécessite que l'application appelant ce fichier est précédement inclu le fichier de Pear:
30
* 'Text/Wiki.php';
31
*
32
*@package Text_Wiki
33
*@subpackage Papyrus
34
//Auteur original :
35
*@author        Jean-Pascal MILCENT <jpm@tela-botanica.org>
36
//Autres auteurs :
37
*@author        Aucun
38
*@copyright     Tela-Botanica 2000-2004
453 ddelon 39
*@version       $Revision: 1.7 $ $Date: 2005-09-23 13:58:07 $
178 jpm 40
// +------------------------------------------------------------------------------------------------------+
41
*/
42
 
43
// +------------------------------------------------------------------------------------------------------+
44
// |                                            ENTETE du PROGRAMME                                       |
45
// +------------------------------------------------------------------------------------------------------+
46
 
47
// +------------------------------------------------------------------------------------------------------+
48
// |                                            CORPS du PROGRAMME                                        |
49
// +------------------------------------------------------------------------------------------------------+
50
/**
51
*
52
* Parse structured wiki text and render into arbitrary formats such as XHTML.
53
*
54
* Cette classe fille permet de configurer les régles de formatage pour Papyrus.
55
* Généralement nous avons à faire à des actions.
56
*
57
* @author Paul M. Jones <pmjones@ciaweb.net>
58
* @package Text_Wiki
59
* @version 0.23.1
60
* @license LGPL
61
*/
62
class Text_Papyrus extends Text_Wiki {
63
 
64
    /**
65
    *
66
    * Liste de règles par défaut du format Papyrs dans leur ordre d'application au texte
67
    * à transformer.
68
    *
69
    * @access public
70
    *
71
    * @var array
72
    *
73
    */
74
    var $rules = array(
335 jpm 75
        'Inclure', // Action Inclure
76
        'Motcles', // Action Motcles
77
        'Categorie', // Action Categorie
345 jpm 78
        'Nouveaute', // Action Nouveaute
79
        'Plan', // Action Plan
80
        'Syndication', // Action Syndication
453 ddelon 81
        'Redirection' // Action Redirection
178 jpm 82
    );
83
 
84
    /**
85
    *
86
    * The list of rules to not-apply to the source text.
87
    *
88
    * @access public
89
    *
90
    * @var array
91
    *
92
    */
179 jpm 93
    var $disable = array();
178 jpm 94
 
95
    /**
96
    *
97
    * The delimiter for token numbers of parsed elements in source text.
98
    *
99
    * @access public
100
    *
101
    * @var string
102
    *
103
    */
104
    var $delim = 12;
105
 
247 jpm 106
    function Text_Papyrus($rules = null)
178 jpm 107
    {
247 jpm 108
        //Text_Wiki::Text_Wiki();
109
        if (is_array($rules)) {
110
            $this->rules = $rules;
111
        }
112
        // Nous devons sortir les fichiers de Text_Wiki du dépot Pear car la fonction file_exists de PHP utilisée dans
113
        // la méthode findfile de Text_Wiki renvoie false.
114
        $this->addPath('parse', $this->fixPath(dirname(__FILE__)) .'../../pear/Text/Wiki/Parse/');
115
        $this->addPath('render', $this->fixPath(dirname(__FILE__)) .'../../pear/Text/Wiki/Render/');
116
        // Pour les règles spécifiques à Papyrus:
117
        $this->addPath('parse', $this->fixPath(dirname(__FILE__)) . 'Parse/');
118
        $this->addPath('render', $this->fixPath(dirname(__FILE__)) . 'Render/');
178 jpm 119
 
120
 
121
    }
122
 
123
    /**
124
    *
125
    * Renders tokens back into the source text, based on the requested format.
126
    *
127
    * @access public
128
    *
129
    * @param string $format The target output format, typically 'xhtml'.
130
    * If a rule does not support a given format, the output from that
131
    * rule is rule-specific.
132
    *
133
    * @return string The transformed wiki text.
134
    *
135
    */
136
    function render($format = 'Xhtml')
137
    {
138
        // the rendering method we're going to use from each rule
139
        $format = ucwords(strtolower($format));
140
 
141
        // the eventual output text
142
        $output = '';
143
 
144
        // when passing through the parsed source text, keep track of when
145
        // we are in a delimited section
146
        $in_delim = false;
147
 
148
        // when in a delimited section, capture the token key number
149
        $key = '';
150
 
151
        // load the format object
152
        $this->loadFormatObj($format);
153
 
154
        // pre-rendering activity
224 jpm 155
        if (isset($this->formatObj[$format]) && is_object($this->formatObj[$format])) {
178 jpm 156
            $output .= $this->formatObj[$format]->pre();
157
        }
158
 
159
        // load the render objects
160
        foreach (array_keys($this->parseObj) as $rule) {
161
            $this->loadRenderObj($format, $rule);
162
        }
163
 
164
        // pass through the parsed source text character by character
165
        $k = strlen($this->source);
166
        for ($i = 0; $i < $k; $i++) {
167
 
168
            // the current character
169
            $char = $this->source{$i};
170
 
171
            // are alredy in a delimited section?
172
            if ($in_delim) {
173
 
174
                // yes; are we ending the section?
175
                if ($char == chr($this->delim)) {
176
 
177
                    // yes, get the replacement text for the delimited
178
                    // token number and unset the flag.
179
                    $key = (int)$key;
247 jpm 180
                    $rule = null;
181
                    if (isset($this->tokens[$key][0])) {
182
                        $rule = $this->tokens[$key][0];
183
                    }
184
                    $opts = null;
185
                    if (isset($this->tokens[$key][1])) {
186
                        $opts = $this->tokens[$key][1];
187
                    }
188
                    if (isset($this->renderObj[$rule]) && is_object($this->renderObj[$rule])) {
189
                        $output .= $this->renderObj[$rule]->token($opts);
190
                    }
178 jpm 191
                    $in_delim = false;
192
 
193
                } else {
194
 
195
                    // no, add to the dlimited token key number
196
                    $key .= $char;
197
 
198
                }
199
 
200
            } else {
201
 
202
                // not currently in a delimited section.
203
                // are we starting into a delimited section?
204
                if ($char == chr($this->delim)) {
205
                    // yes, reset the previous key and
206
                    // set the flag.
207
                    $key = '';
208
                    $in_delim = true;
209
                } else {
210
                    // no, add to the output as-is
211
                    $output .= $char;
212
                }
213
            }
214
        }
215
 
216
        // post-rendering activity
224 jpm 217
        if (isset($this->formatObj[$format]) && is_object($this->formatObj[$format])) {
178 jpm 218
            $output .= $this->formatObj[$format]->post();
219
        }
220
 
221
        // return the rendered source text.
222
        return $output;
223
    }
224
 
225
    /**
226
    *
227
    * Add a token to the Text_Wiki tokens array, and return a delimited
228
    * token number.
229
    *
230
    * @access public
231
    *
232
    * @param array $options An associative array of options for the new
233
    * token array element.  The keys and values are specific to the
234
    * rule, and may or may not be common to other rule options.  Typical
235
    * options keys are 'text' and 'type' but may include others.
236
    *
237
    * @param boolean $id_only If true, return only the token number, not
238
    * a delimited token string.
239
    *
240
    * @return string|int By default, return the number of the
241
    * newly-created token array element with a delimiter prefix and
242
    * suffix; however, if $id_only is set to true, return only the token
243
    * number (no delimiters).
244
    *
245
    */
246
    function addToken($rule, $options = array(), $id_only = false)
247
    {
248
        // increment the token ID number.  note that if you parse
249
        // multiple times with the same Text_Wiki object, the ID number
250
        // will not reset to zero.
251
        static $id;
252
        if (! isset($id)) {
253
            $id = 0;
254
        } else {
255
            $id ++;
256
        }
257
 
258
        // force the options to be an array
259
        settype($options, 'array');
260
 
261
        // add the token
262
        $this->tokens[$id] = array(
263
 
264
            1 => $options
265
        );
266
 
267
        // return a value
268
        if ($id_only) {
269
            // return the last token number
270
            return $id;
271
        } else {
272
            // return the token number with delimiters
273
            return chr($this->delim) . $id . chr($this->delim);
274
        }
275
    }
276
}
277
 
278
// +------------------------------------------------------------------------------------------------------+
279
// |                                            PIED du PROGRAMME                                         |
280
// +------------------------------------------------------------------------------------------------------+
281
 
282
 
283
 
284
/* +--Fin du code ----------------------------------------------------------------------------------------+
285
*
286
* $Log: not supported by cvs2svn $
453 ddelon 287
* Revision 1.6  2005/04/18 16:41:53  jpm
288
* Ajout des actions Plan et Syndication.
289
*
345 jpm 290
* Revision 1.5  2005/04/14 16:35:42  jpm
291
* Ajout de nouvelles actions pour Papyrus XHTML.
292
*
335 jpm 293
* Revision 1.4  2005/01/20 19:39:39  jpm
294
* Correction bogue du à la fonction file_exists qui renvoie false pour les fichiers présent dans le dossier Pear /usr/local/lib/php/.
295
*
247 jpm 296
* Revision 1.3  2004/12/07 12:17:37  jpm
297
* Correction message d'erreur.
298
*
224 jpm 299
* Revision 1.2  2004/11/26 12:13:03  jpm
300
* Correction de résidu...
301
*
179 jpm 302
* Revision 1.1  2004/11/26 12:11:49  jpm
303
* Ajout des action Papyrus à Text_Wiki.
304
*
178 jpm 305
* Revision 1.2  2004/11/25 15:36:41  jpm
306
* Suppression régle Delimiter car problème avec les délimitations de fin de ligne.
307
*
308
* Revision 1.1  2004/11/23 17:25:38  jpm
309
* Début classe PEAR WIKI pour la syntaxe Wikini.
310
*
311
*
312
* +-- Fin du code ----------------------------------------------------------------------------------------+
313
*/
314
?>