File: Render.php

package info (click to toggle)
diogenes 0.9.20-2
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 2,976 kB
  • ctags: 3,271
  • sloc: php: 12,285; sh: 828; perl: 258; makefile: 137; sql: 85
file content (197 lines) | stat: -rw-r--r-- 4,256 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
<?php

/**
* 
* Base rendering class for parsed and tokenized text.
* 
* @category Text
* 
* @package Text_Wiki
* 
* @author Paul M. Jones <pmjones@php.net>
* 
* @license LGPL
* 
* @version $Id: Render.php,v 1.5 2005/02/23 17:38:29 pmjones Exp $
* 
*/

/**
* 
* Base rendering class for parsed and tokenized text.
* 
* @category Text
* 
* @package Text_Wiki
* 
* @author Paul M. Jones <pmjones@php.net>
* 
* @license LGPL
* 
*/

class Text_Wiki_Render {
    
    
    /**
    * 
    * Configuration options for this render rule.
    * 
    * @access public
    * 
    * @var string
    * 
    */
    
    var $conf = array();
    
    
    /**
    * 
    * The name of this rule's format.
    * 
    * @access public
    * 
    * @var string
    * 
    */
    
    var $format = null;
    
    
    /**
    * 
    * The name of this rule's token array elements.
    * 
    * @access public
    * 
    * @var string
    * 
    */
    
    var $rule = null;
    
    
    /**
    * 
    * A reference to the calling Text_Wiki object.
    * 
    * This is needed so that each rule has access to the same source
    * text, token set, URLs, interwiki maps, page names, etc.
    * 
    * @access public
    * 
    * @var object
    */
    
    var $wiki = null;
    
    
    /**
    * 
    * Constructor for this render format or rule.
    * 
    * @access public
    * 
    * @param object &$obj The calling "parent" Text_Wiki object.
    * 
    */
    
    function Text_Wiki_Render(&$obj)
    {
        // keep a reference to the calling Text_Wiki object
        $this->wiki =& $obj;
        
        // get the config-key-name for this object,
        // strip the Text_Wiki_Render_ part
        //           01234567890123456
        $tmp = get_class($this);
        $tmp = substr($tmp, 17);
        
        // split into pieces at the _ mark.
        // first part is format, second part is rule.
        $part   = explode('_', $tmp);
        $this->format = isset($part[0]) ? ucwords(strtolower($part[0])) : null;
        $this->rule   = isset($part[1]) ? ucwords(strtolower($part[1])) : null;
        
        // is there a format but no rule?
        // then this is the "main" render object, with
        // pre() and post() methods.
        if ($this->format && ! $this->rule &&
            isset($this->wiki->formatConf[$this->format]) &&
            is_array($this->wiki->formatConf[$this->format])) {
            
            // this is a format render object
            $this->conf = array_merge(
                $this->conf,
                $this->wiki->formatConf[$this->format]
            );
        
        }
        
        // is there a format and a rule?
        if ($this->format && $this->rule &&
            isset($this->wiki->renderConf[$this->format][$this->rule]) &&
            is_array($this->wiki->renderConf[$this->format][$this->rule])) {
            
            // this is a rule render object
            $this->conf = array_merge(
                $this->conf,
                $this->wiki->renderConf[$this->format][$this->rule]
            );
        }
    }
    
    
    /**
    * 
    * Simple method to safely get configuration key values.
    * 
    * @access public
    * 
    * @param string $key The configuration key.
    * 
    * @param mixed $default If the key does not exist, return this value
    * instead.
    * 
    * @return mixed The configuration key value (if it exists) or the
    * default value (if not).
    * 
    */
    
    function getConf($key, $default = null)
    {
        if (isset($this->conf[$key])) {
            return $this->conf[$key];
        } else {
            return $default;
        }
    }
    
    
    /**
    * 
    * Simple method to wrap a configuration in an sprintf() format.
    * 
    * @access public
    * 
    * @param string $key The configuration key.
    * 
    * @param string $format The sprintf() format string.
    * 
    * @return mixed The formatted configuration key value (if it exists) 
    * or null (if it does not).
    * 
    */
    
    function formatConf($format, $key)
    {
        if (isset($this->conf[$key])) {
            return sprintf($format, $this->conf[$key]);
        } else {
            return null;
        }
    }
    
}
?>