| blob | 887884e1a48c562666bd72ca463d71d9392fd6a6 |
8 <head>
23 };
24 </script>
33 </head>
34 <body>
37 <ul>
49 </ul>
50 </div>
58 <span id="id1"></span><h1>Transformations<a class="headerlink" href="#transformations" title="Permalink to this headline">¶</a></h1>
60 <span id="transformationsintro"></span><h2>Introduction<a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
61 <p>To enable transformations, you have to setup the <tt class="docutils literal"><span class="pre">column_info</span></tt>
62 table and the proper directives. Please see the <a class="reference internal" href="config.html#config"><em>Configuration</em></a> on how to do so.</p>
63 <p>You can apply different transformations to the contents of each
64 column. The transformation will take the content of each column and
65 transform it with certain rules defined in the selected
66 transformation.</p>
68 you would see in phpMyAdmin only this filename. Using transformations
69 you can transform that filename into a HTML link, so you can click
70 inside of the phpMyAdmin structure on the column’s link and will see
71 the file displayed in a new browser window. Using transformation
72 options you can also specify strings to append/prepend to a string or
73 the format you want the output stored in.</p>
74 <p>For a general overview of all available transformations and their
77 <p>For a tutorial on how to effectively use transformations, see our
78 <a class="reference external" href="http://www.phpmyadmin.net/home_page/docs.php">Link section</a> on the
79 official phpMyAdmin homepage.</p>
80 </div>
82 <span id="transformationshowto"></span><h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
85 icon) and there you will see three new fields at the end of the line.
90 corresponds to the column’s contents. Please note that transformations
91 are inactive as long as no MIME-type is selected.</li>
93 choose from a hopefully growing amount of pre-defined transformations.
94 See below for information on how to build your own transformation.
95 There are global transformations and mimetype-bound transformations.
96 Global transformations can be used for any mimetype. They will take
97 the mimetype, if necessary, into regard. Mimetype-bound
98 transformations usually only operate on a certain mimetype. There are
100 which will most likely take the subtype into regard, and those who
102 transformations on mimetypes for which the function was not defined
103 for. There is no security check for you selected the right
104 transformation, so take care of what the output will be like.</li>
106 to enter transform-function specific options here. Usually the
107 transforms can operate with default options, but it is generally a
108 good idea to look up the overview to see which options are necessary.
109 Much like the ENUM/SET-Fields, you have to split up several options
110 using the format ‘a’,’b’,’c’,...(NOTE THE MISSING BLANKS). This is
111 because internally the options will be parsed as an array, leaving the
112 first value the first element in the array, and so forth. If you want
113 to specify a MIME character set you can define it in the
114 transformation_options. You have to put that outside of the pre-
115 defined options of the specific mime-transform, as the last value of
117 which you can specify 2 options and you want to append a character
118 set, enter “‘first parameter’,’second parameter’,’charset=us-ascii’”.
119 You can, however use the defaults for the parameters: “’‘,’‘,’charset
121 </ul>
122 </div>
124 <span id="transformationsfiles"></span><h2>File structure<a class="headerlink" href="#file-structure" title="Permalink to this headline">¶</a></h2>
125 <p>All specific transformations for mimetypes are defined through class
127 them extends a certain transformation abstract class declared in
128 libraries/plugins/transformations/abstract.</p>
129 <p>They are stored in files to ease up customization and easy adding of
130 new transformations.</p>
131 <p>Because the user cannot enter own mimetypes, it is kept sure that
132 transformations always work. It makes no sense to apply a
133 transformation to a mimetype the transform-function doesn’t know to
134 handle.</p>
136 basic functions which can be included by any other transform function.</p>
137 <p>The file name convention is <tt class="docutils literal"><span class="pre">[Mimetype]_[Subtype]_[Transformation</span>
139 name <tt class="docutils literal"><span class="pre">[Transformation</span> <span class="pre">Name]TransformationsPlugin</span></tt>. All of the
140 methods that have to be implemented by a transformations plug-in are:</p>
143 <li>getName(), getInfo() and applyTransformation() in the abstract class
144 it extends.</li>
145 </ol>
146 <p>The getMIMEType(), getMIMESubtype() and getName() methods return the
147 name of the MIME type, MIME Subtype and transformation accordingly.
148 getInfo() returns the transformation’s description and possible
149 options it may receive and applyTransformation() is the method that
150 does the actual work of the transformation plug-in.</p>
151 <p>Please see the libraries/plugins/transformations/TEMPLATE and
152 libraries/plugins/transformations/TEMPLATE_ABSTRACT files for adding
153 your own transformation plug-in. You can also generate a new
154 transformation plug-in (with or without the abstract transformation
155 class), by using
156 <tt class="file docutils literal"><span class="pre">libraries/plugins/transformations/generator_plugin.sh</span></tt> or
157 <tt class="file docutils literal"><span class="pre">libraries/plugins/transformations/generator_main_class.sh</span></tt>.</p>
161 text, you want to transform.</li>
163 function as an array.</li>
165 data is drawn from the output of the <a class="reference external" href="http://www.php.net/mysql_fetch_field">mysql_fetch_field()</a> function. This means, all
166 object properties described on the <a class="reference external" href="http://www.php.net/mysql_fetch_field">manual page</a> are available in this
167 variable and can be used to transform a column accordingly to
168 unsigned/zerofill/not_null/... properties. The $meta->mimetype
169 variable contains the original MIME-type of the column (i.e.
171 </ol>
172 </div>
173 </div>
176 </div>
177 </div>
178 </div>
182 <ul>
187 </ul>
188 </li>
189 </ul>
201 </ul>
209 </form>
211 Enter search terms or a module, class or function name.
212 </p>
213 </div>
215 </div>
216 </div>
218 </div>
221 <ul>
233 </ul>
234 </div>
238 </div>
239 </body>
240 </html>