pma12111211/doc/doctrees/transformations.doctree

€cdocutils.nodes
document
q)�q}q(U	nametypesq}q(Xmanual pageqˆXtransformationsqˆXintroductionqNXfile structureq	NXmysql_fetch_field()q
ˆXlink sectionqˆXtransformationshowtoqˆXusageq
NXtransformationsintroqˆXtransformationsfilesqˆuUsubstitution_defsq}qUparse_messagesq]qcdocutils.nodes
system_message
q)�q}q(U	rawsourceqUUparentqcdocutils.nodes
section
q)�q}q(hUU
referencedqKhhUsourceqcdocutils.nodes
reprunicode
qXX/usr/local/apache2/htdocs/phpmyadmin/release/phpMyAdmin-4.1.14.8/doc/transformations.rstq…�q }q!bUexpect_referenced_by_nameq"}q#hcdocutils.nodes
target
q$)�q%}q&(hX.. _transformations:q'hhhh Utagnameq(Utargetq)U
attributesq*}q+(Uidsq,]q-Ubackrefsq.]q/Udupnamesq0]q1Uclassesq2]q3Unamesq4]q5Urefidq6Utransformationsq7uUlineq8KUdocumentq9hUchildrenq:]q;ubsh(Usectionq<h*}q=(h0]q>Xtransformationsq?ah2]q@h.]qAh,]qB(h7Uid1qCeh4]qDhauh8Kh9hUexpect_referenced_by_idqE}qFh7h%sh:]qG(cdocutils.nodes
title
qH)�qI}qJ(hXTransformationsqKhhhh h(UtitleqLh*}qM(h0]qNh2]qOh.]qPh,]qQh4]qRuh8Kh9hh:]qScdocutils.nodes
Text
qTXTransformationsqU…�qV}qW(hhKhhIubaubh$)�qX}qY(hX.. _transformationsintro:qZhhhh h(h)h*}q[(h,]q\h.]q]h0]q^h2]q_h4]q`h6Utransformationsintroqauh8Kh9hh:]qbubh)�qc}qd(hUhhhh h"}qehhXsh(h<h*}qf(h0]qgh2]qhh.]qih,]qj(Uintroductionqkhaeh4]ql(hheuh8K	h9hhE}qmhahXsh:]qn(hH)�qo}qp(hXIntroductionqqhhchh h(hLh*}qr(h0]qsh2]qth.]quh,]qvh4]qwuh8K	h9hh:]qxhTXIntroductionqy…�qz}q{(hhqhhoubaubcdocutils.nodes
paragraph
q|)�q}}q~(hX�To enable transformations, you have to setup the ``column_info``
table and the proper directives. Please see the :ref:`config` on how to do so.qhhchh h(U	paragraphq€h*}q�(h0]q‚h2]qƒh.]q„h,]q…h4]q†uh8Kh9hh:]q‡(hTX1To enable transformations, you have to setup the qˆ…�q‰}qŠ(hX1To enable transformations, you have to setup the q‹hh}ubcdocutils.nodes
literal
qŒ)�q�}qŽ(hX``column_info``q�h*}q�(h0]q‘h2]q’h.]q“h,]q”h4]q•uhh}h:]q–hTXcolumn_infoq—…�q˜}q™(hUhh�ubah(UliteralqšubhTX1
table and the proper directives. Please see the q›…�qœ}q�(hX1
table and the proper directives. Please see the qžhh}ubcsphinx.addnodes
pending_xref
qŸ)�q }q¡(hX
:ref:`config`q¢hh}hh h(Upending_xrefq£h*}q¤(Ureftypeq¥Xrefq¦Urefwarnq§ˆU	reftargetq¨Xconfigq©U	refdomainqªXstdq«h,]q¬h.]qUrefexplicitq®‰h0]q¯h2]q°h4]q±Urefdocq²Utransformationsq³uh8Kh:]q´cdocutils.nodes
emphasis
qµ)�q¶}q·(hh¢h*}q¸(h0]q¹h2]qº(Uxrefq»h«Xstd-refq¼eh.]q½h,]q¾h4]q¿uhh h:]qÀhTXconfigqÁ…�qÂ}qÃ(hUhh¶ubah(UemphasisqÄubaubhTX on how to do so.qÅ…�qÆ}qÇ(hX on how to do so.qÈhh}ubeubh|)�qÉ}qÊ(hXËYou can apply different transformations to the contents of each
column. The transformation will take the content of each column and
transform it with certain rules defined in the selected
transformation.qËhhchh h(h€h*}qÌ(h0]qÍh2]qÎh.]qÏh,]qÐh4]qÑuh8Kh9hh:]qÒhTXËYou can apply different transformations to the contents of each
column. The transformation will take the content of each column and
transform it with certain rules defined in the selected
transformation.qÓ…�qÔ}qÕ(hhËhhÉubaubh|)�qÖ}q×(hXÃSay you have a column 'filename' which contains a filename. Normally
you would see in phpMyAdmin only this filename. Using transformations
you can transform that filename into a HTML link, so you can click
inside of the phpMyAdmin structure on the column's link and will see
the file displayed in a new browser window. Using transformation
options you can also specify strings to append/prepend to a string or
the format you want the output stored in.qØhhchh h(h€h*}qÙ(h0]qÚh2]qÛh.]qÜh,]qÝh4]qÞuh8Kh9hh:]qßhTXÃSay you have a column 'filename' which contains a filename. Normally
you would see in phpMyAdmin only this filename. Using transformations
you can transform that filename into a HTML link, so you can click
inside of the phpMyAdmin structure on the column's link and will see
the file displayed in a new browser window. Using transformation
options you can also specify strings to append/prepend to a string or
the format you want the output stored in.qà…�qá}qâ(hhØhhÖubaubh|)�qã}qä(hX´For a general overview of all available transformations and their
options, you can consult your *<www.your-host.com>/<your-install-
dir>/transformation\_overview.php* installation.qåhhchh h(h€h*}qæ(h0]qçh2]qèh.]qéh,]qêh4]qëuh8Kh9hh:]qì(hTX`For a general overview of all available transformations and their
options, you can consult your qí…�qî}qï(hX`For a general overview of all available transformations and their
options, you can consult your qðhhãubhµ)�qñ}qò(hXF*<www.your-host.com>/<your-install-
dir>/transformation\_overview.php*qóh*}qô(h0]qõh2]qöh.]q÷h,]qøh4]qùuhhãh:]qúhTXC<www.your-host.com>/<your-install-
dir>/transformation_overview.phpqû…�qü}qý(hUhhñubah(hÄubhTX installation.qþ…�qÿ}r(hX installation.rhhãubeubh|)�r}r(hX¥For a tutorial on how to effectively use transformations, see our
`Link section <http://www.phpmyadmin.net/home_page/docs.php>`_ on the
official phpMyAdmin homepage.rhhchh h(h€h*}r(h0]rh2]rh.]rh,]r	h4]r
uh8Kh9hh:]r(hTXBFor a tutorial on how to effectively use transformations, see our
r…�r
}r(hXBFor a tutorial on how to effectively use transformations, see our
rhjubcdocutils.nodes
reference
r)�r}r(hX>`Link section <http://www.phpmyadmin.net/home_page/docs.php>`_rh*}r(UnamerXLink sectionrUrefurirX,http://www.phpmyadmin.net/home_page/docs.phprh,]rh.]rh0]rh2]rh4]ruhjh:]rhTXLink sectionr…�r }r!(hUhjubah(U	referencer"ubh$)�r#}r$(hX/ <http://www.phpmyadmin.net/home_page/docs.php>r%hKhjh(h)h*}r&(Urefurir'jh,]r(Ulink-sectionr)ah.]r*h0]r+h2]r,h4]r-hauh:]r.ubhTX% on the
official phpMyAdmin homepage.r/…�r0}r1(hX% on the
official phpMyAdmin homepage.r2hjubeubh$)�r3}r4(hX.. _transformationshowto:r5hhchh h(h)h*}r6(h,]r7h.]r8h0]r9h2]r:h4]r;h6Utransformationshowtor<uh8K#h9hh:]r=ubeubh)�r>}r?(hUhhhh h"}r@hj3sh(h<h*}rA(h0]rBh2]rCh.]rDh,]rE(UusagerFj<eh4]rG(h
heuh8K&h9hhE}rHj<j3sh:]rI(hH)�rJ}rK(hXUsagerLhj>hh h(hLh*}rM(h0]rNh2]rOh.]rPh,]rQh4]rRuh8K&h9hh:]rShTXUsagerT…�rU}rV(hjLhjJubaubh|)�rW}rX(hX&Go to your *tbl\_structure.php* page (i.e. reached through clicking on
the 'Structure' link for a table). There click on "Change" (or change
icon) and there you will see three new fields at the end of the line.
They are called 'MIME-type', 'Browser transformation' and
'Transformation options'.rYhj>hh h(h€h*}rZ(h0]r[h2]r\h.]r]h,]r^h4]r_uh8K(h9hh:]r`(hTXGo to your ra…�rb}rc(hXGo to your rdhjWubhµ)�re}rf(hX*tbl\_structure.php*rgh*}rh(h0]rih2]rjh.]rkh,]rlh4]rmuhjWh:]rnhTXtbl_structure.phpro…�rp}rq(hUhjeubah(hÄubhTX page (i.e. reached through clicking on
the 'Structure' link for a table). There click on "Change" (or change
icon) and there you will see three new fields at the end of the line.
They are called 'MIME-type', 'Browser transformation' and
'Transformation options'.rr…�rs}rt(hX page (i.e. reached through clicking on
the 'Structure' link for a table). There click on "Change" (or change
icon) and there you will see three new fields at the end of the line.
They are called 'MIME-type', 'Browser transformation' and
'Transformation options'.ruhjWubeubcdocutils.nodes
bullet_list
rv)�rw}rx(hUhj>hh h(Ubullet_listryh*}rz(Ubulletr{X*h,]r|h.]r}h0]r~h2]rh4]r€uh8K.h9hh:]r�(cdocutils.nodes
list_item
r‚)�rƒ}r„(hX¾The field 'MIME-type' is a drop-down field. Select the MIME-type that
corresponds to the column's contents. Please note that transformations
are inactive as long as no MIME-type is selected.r…hjwhh h(U	list_itemr†h*}r‡(h0]rˆh2]r‰h.]rŠh,]r‹h4]rŒuh8Nh9hh:]r�h|)�rŽ}r�(hX¾The field 'MIME-type' is a drop-down field. Select the MIME-type that
corresponds to the column's contents. Please note that transformations
are inactive as long as no MIME-type is selected.r�hjƒhh h(h€h*}r‘(h0]r’h2]r“h.]r”h,]r•h4]r–uh8K.h:]r—hTX¾The field 'MIME-type' is a drop-down field. Select the MIME-type that
corresponds to the column's contents. Please note that transformations
are inactive as long as no MIME-type is selected.r˜…�r™}rš(hj�hjŽubaubaubj‚)�r›}rœ(hXXThe field 'Browser transformation' is a drop-down field. You can
choose from a hopefully growing amount of pre-defined transformations.
See below for information on how to build your own transformation.
There are global transformations and mimetype-bound transformations.
Global transformations can be used for any mimetype. They will take
the mimetype, if necessary, into regard. Mimetype-bound
transformations usually only operate on a certain mimetype. There are
transformations which operate on the main mimetype (like 'image'),
which will most likely take the subtype into regard, and those who
only operate on a specific subtype (like 'image/jpeg'). You can use
transformations on mimetypes for which the function was not defined
for. There is no security check for you selected the right
transformation, so take care of what the output will be like.r�hjwhh h(j†h*}rž(h0]rŸh2]r h.]r¡h,]r¢h4]r£uh8Nh9hh:]r¤h|)�r¥}r¦(hXXThe field 'Browser transformation' is a drop-down field. You can
choose from a hopefully growing amount of pre-defined transformations.
See below for information on how to build your own transformation.
There are global transformations and mimetype-bound transformations.
Global transformations can be used for any mimetype. They will take
the mimetype, if necessary, into regard. Mimetype-bound
transformations usually only operate on a certain mimetype. There are
transformations which operate on the main mimetype (like 'image'),
which will most likely take the subtype into regard, and those who
only operate on a specific subtype (like 'image/jpeg'). You can use
transformations on mimetypes for which the function was not defined
for. There is no security check for you selected the right
transformation, so take care of what the output will be like.r§hj›hh h(h€h*}r¨(h0]r©h2]rªh.]r«h,]r¬h4]ruh8K1h:]r®hTXXThe field 'Browser transformation' is a drop-down field. You can
choose from a hopefully growing amount of pre-defined transformations.
See below for information on how to build your own transformation.
There are global transformations and mimetype-bound transformations.
Global transformations can be used for any mimetype. They will take
the mimetype, if necessary, into regard. Mimetype-bound
transformations usually only operate on a certain mimetype. There are
transformations which operate on the main mimetype (like 'image'),
which will most likely take the subtype into regard, and those who
only operate on a specific subtype (like 'image/jpeg'). You can use
transformations on mimetypes for which the function was not defined
for. There is no security check for you selected the right
transformation, so take care of what the output will be like.r¯…�r°}r±(hj§hj¥ubaubaubj‚)�r²}r³(hXThe field 'Transformation options' is a free-type textfield. You have
to enter transform-function specific options here. Usually the
transforms can operate with default options, but it is generally a
good idea to look up the overview to see which options are necessary.
Much like the ENUM/SET-Fields, you have to split up several options
using the format 'a','b','c',...(NOTE THE MISSING BLANKS). This is
because internally the options will be parsed as an array, leaving the
first value the first element in the array, and so forth. If you want
to specify a MIME character set you can define it in the
transformation\_options. You have to put that outside of the pre-
defined options of the specific mime-transform, as the last value of
the set. Use the format "'; charset=XXX'". If you use a transform, for
which you can specify 2 options and you want to append a character
set, enter "'first parameter','second parameter','charset=us-ascii'".
You can, however use the defaults for the parameters: "'','','charset
=us-ascii'".
r´hjwhh h(j†h*}rµ(h0]r¶h2]r·h.]r¸h,]r¹h4]rºuh8Nh9hh:]r»h|)�r¼}r½(hXThe field 'Transformation options' is a free-type textfield. You have
to enter transform-function specific options here. Usually the
transforms can operate with default options, but it is generally a
good idea to look up the overview to see which options are necessary.
Much like the ENUM/SET-Fields, you have to split up several options
using the format 'a','b','c',...(NOTE THE MISSING BLANKS). This is
because internally the options will be parsed as an array, leaving the
first value the first element in the array, and so forth. If you want
to specify a MIME character set you can define it in the
transformation\_options. You have to put that outside of the pre-
defined options of the specific mime-transform, as the last value of
the set. Use the format "'; charset=XXX'". If you use a transform, for
which you can specify 2 options and you want to append a character
set, enter "'first parameter','second parameter','charset=us-ascii'".
You can, however use the defaults for the parameters: "'','','charset
=us-ascii'".r¾hj²hh h(h€h*}r¿(h0]rÀh2]rÁh.]rÂh,]rÃh4]rÄuh8K>h:]rÅhTXThe field 'Transformation options' is a free-type textfield. You have
to enter transform-function specific options here. Usually the
transforms can operate with default options, but it is generally a
good idea to look up the overview to see which options are necessary.
Much like the ENUM/SET-Fields, you have to split up several options
using the format 'a','b','c',...(NOTE THE MISSING BLANKS). This is
because internally the options will be parsed as an array, leaving the
first value the first element in the array, and so forth. If you want
to specify a MIME character set you can define it in the
transformation_options. You have to put that outside of the pre-
defined options of the specific mime-transform, as the last value of
the set. Use the format "'; charset=XXX'". If you use a transform, for
which you can specify 2 options and you want to append a character
set, enter "'first parameter','second parameter','charset=us-ascii'".
You can, however use the defaults for the parameters: "'','','charset
=us-ascii'".rÆ…�rÇ}rÈ(hXThe field 'Transformation options' is a free-type textfield. You have
to enter transform-function specific options here. Usually the
transforms can operate with default options, but it is generally a
good idea to look up the overview to see which options are necessary.
Much like the ENUM/SET-Fields, you have to split up several options
using the format 'a','b','c',...(NOTE THE MISSING BLANKS). This is
because internally the options will be parsed as an array, leaving the
first value the first element in the array, and so forth. If you want
to specify a MIME character set you can define it in the
transformation\_options. You have to put that outside of the pre-
defined options of the specific mime-transform, as the last value of
the set. Use the format "'; charset=XXX'". If you use a transform, for
which you can specify 2 options and you want to append a character
set, enter "'first parameter','second parameter','charset=us-ascii'".
You can, however use the defaults for the parameters: "'','','charset
=us-ascii'".rÉhj¼ubaubaubeubh$)�rÊ}rË(hX.. _transformationsfiles:rÌhj>hh h(h)h*}rÍ(h,]rÎh.]rÏh0]rÐh2]rÑh4]rÒh6UtransformationsfilesrÓuh8KOh9hh:]rÔubeubh)�rÕ}rÖ(hUhhhh h"}r×hjÊsh(h<h*}rØ(h0]rÙh2]rÚh.]rÛh,]rÜ(Ufile-structurerÝjÓeh4]rÞ(h	heuh8KRh9hhE}rßjÓjÊsh:]rà(hH)�rá}râ(hXFile structurerãhjÕhh h(hLh*}rä(h0]råh2]ræh.]rçh,]rèh4]réuh8KRh9hh:]rêhTXFile structurerë…�rì}rí(hjãhjáubaubh|)�rî}rï(hXöAll specific transformations for mimetypes are defined through class
files in the directory 'libraries/plugins/transformations/'. Each of
them extends a certain transformation abstract class declared in
libraries/plugins/transformations/abstract.rðhjÕhh h(h€h*}rñ(h0]ròh2]róh.]rôh,]rõh4]röuh8KTh9hh:]r÷hTXöAll specific transformations for mimetypes are defined through class
files in the directory 'libraries/plugins/transformations/'. Each of
them extends a certain transformation abstract class declared in
libraries/plugins/transformations/abstract.rø…�rù}rú(hjðhjîubaubh|)�rû}rü(hXYThey are stored in files to ease up customization and easy adding of
new transformations.rýhjÕhh h(h€h*}rþ(h0]rÿh2]rh.]rh,]rh4]ruh8KYh9hh:]rhTXYThey are stored in files to ease up customization and easy adding of
new transformations.r…�r}r(hjýhjûubaubh|)�r}r	(hXÇBecause the user cannot enter own mimetypes, it is kept sure that
transformations always work. It makes no sense to apply a
transformation to a mimetype the transform-function doesn't know to
handle.r
hjÕhh h(h€h*}r(h0]rh2]r
h.]rh,]rh4]ruh8K\h9hh:]rhTXÇBecause the user cannot enter own mimetypes, it is kept sure that
transformations always work. It makes no sense to apply a
transformation to a mimetype the transform-function doesn't know to
handle.r…�r}r(hj
hjubaubh|)�r}r(hXŒThere is a file called '*transformations.lib.php*' that provides some
basic functions which can be included by any other transform function.rhjÕhh h(h€h*}r(h0]rh2]rh.]rh,]rh4]ruh8Kah9hh:]r(hTXThere is a file called 'r…�r }r!(hXThere is a file called 'r"hjubhµ)�r#}r$(hX*transformations.lib.php*r%h*}r&(h0]r'h2]r(h.]r)h,]r*h4]r+uhjh:]r,hTXtransformations.lib.phpr-…�r.}r/(hUhj#ubah(hÄubhTX[' that provides some
basic functions which can be included by any other transform function.r0…�r1}r2(hX[' that provides some
basic functions which can be included by any other transform function.r3hjubeubh|)�r4}r5(hXThe file name convention is ``[Mimetype]_[Subtype]_[Transformation
Name].class.php``, while the abtract class that it extends has the
name ``[Transformation Name]TransformationsPlugin``. All of the
methods that have to be implemented by a transformations plug-in are:r6hjÕhh h(h€h*}r7(h0]r8h2]r9h.]r:h,]r;h4]r<uh8Kdh9hh:]r=(hTXThe file name convention is r>…�r?}r@(hXThe file name convention is rAhj4ubhŒ)�rB}rC(hX8``[Mimetype]_[Subtype]_[Transformation
Name].class.php``rDh*}rE(h0]rFh2]rGh.]rHh,]rIh4]rJuhj4h:]rKhTX4[Mimetype]_[Subtype]_[Transformation
Name].class.phprL…�rM}rN(hUhjBubah(hšubhTX7, while the abtract class that it extends has the
name rO…�rP}rQ(hX7, while the abtract class that it extends has the
name rRhj4ubhŒ)�rS}rT(hX.``[Transformation Name]TransformationsPlugin``rUh*}rV(h0]rWh2]rXh.]rYh,]rZh4]r[uhj4h:]r\hTX*[Transformation Name]TransformationsPluginr]…�r^}r_(hUhjSubah(hšubhTXR. All of the
methods that have to be implemented by a transformations plug-in are:r`…�ra}rb(hXR. All of the
methods that have to be implemented by a transformations plug-in are:rchj4ubeubcdocutils.nodes
enumerated_list
rd)�re}rf(hUhjÕhh h(Uenumerated_listrgh*}rh(UsuffixriU.h,]rjh.]rkh0]rlUprefixrmUh2]rnh4]roUenumtyperpUarabicrquh8Kih9hh:]rr(j‚)�rs}rt(hX5getMIMEType() and getMIMESubtype() in the main class;ruhjehh h(j†h*}rv(h0]rwh2]rxh.]ryh,]rzh4]r{uh8Nh9hh:]r|h|)�r}}r~(hjuhjshh h(h€h*}r(h0]r€h2]r�h.]r‚h,]rƒh4]r„uh8Kih:]r…hTX5getMIMEType() and getMIMESubtype() in the main class;r†…�r‡}rˆ(hjuhj}ubaubaubj‚)�r‰}rŠ(hXQgetName(), getInfo() and applyTransformation() in the abstract class
it extends.
r‹hjehh h(j†h*}rŒ(h0]r�h2]rŽh.]r�h,]r�h4]r‘uh8Nh9hh:]r’h|)�r“}r”(hXPgetName(), getInfo() and applyTransformation() in the abstract class
it extends.r•hj‰hh h(h€h*}r–(h0]r—h2]r˜h.]r™h,]ršh4]r›uh8Kjh:]rœhTXPgetName(), getInfo() and applyTransformation() in the abstract class
it extends.r�…�rž}rŸ(hj•hj“ubaubaubeubh|)�r }r¡(hX@The getMIMEType(), getMIMESubtype() and getName() methods return the
name of the MIME type, MIME Subtype and transformation accordingly.
getInfo() returns the transformation's description and possible
options it may receive and applyTransformation() is the method that
does the actual work of the transformation plug-in.r¢hjÕhh h(h€h*}r£(h0]r¤h2]r¥h.]r¦h,]r§h4]r¨uh8Kmh9hh:]r©hTX@The getMIMEType(), getMIMESubtype() and getName() methods return the
name of the MIME type, MIME Subtype and transformation accordingly.
getInfo() returns the transformation's description and possible
options it may receive and applyTransformation() is the method that
does the actual work of the transformation plug-in.rª…�r«}r¬(hj¢hj ubaubh|)�r}r®(hX™Please see the libraries/plugins/transformations/TEMPLATE and
libraries/plugins/transformations/TEMPLATE\_ABSTRACT files for adding
your own transformation plug-in. You can also generate a new
transformation plug-in (with or without the abstract transformation
class), by using
:file:`libraries/plugins/transformations/generator_plugin.sh` or
:file:`libraries/plugins/transformations/generator_main_class.sh`.r¯hjÕhh h(h€h*}r°(h0]r±h2]r²h.]r³h,]r´h4]rµuh8Ksh9hh:]r¶(hTXPlease see the libraries/plugins/transformations/TEMPLATE and
libraries/plugins/transformations/TEMPLATE_ABSTRACT files for adding
your own transformation plug-in. You can also generate a new
transformation plug-in (with or without the abstract transformation
class), by using
r·…�r¸}r¹(hXPlease see the libraries/plugins/transformations/TEMPLATE and
libraries/plugins/transformations/TEMPLATE\_ABSTRACT files for adding
your own transformation plug-in. You can also generate a new
transformation plug-in (with or without the abstract transformation
class), by using
rºhjubhŒ)�r»}r¼(hUh*}r½(h,]r¾h.]r¿h0]rÀh2]rÁXfilerÂaUrolerÃjÂh4]rÄuhjh:]rÅhTX5libraries/plugins/transformations/generator_plugin.shrÆ…�rÇ}rÈ(hX5libraries/plugins/transformations/generator_plugin.shrÉhj»ubah(hšubhTX or
rÊ…�rË}rÌ(hX or
rÍhjubhŒ)�rÎ}rÏ(hUh*}rÐ(h,]rÑh.]rÒh0]rÓh2]rÔXfilerÕaUrolerÖjÕh4]r×uhjh:]rØhTX9libraries/plugins/transformations/generator_main_class.shrÙ…�rÚ}rÛ(hX9libraries/plugins/transformations/generator_main_class.shrÜhjÎubah(hšubhTX.…�rÝ}rÞ(hX.hjubeubh|)�rß}rà(hXDThe applyTransformation() method always gets passed three variables:ráhjÕhh h(h€h*}râ(h0]rãh2]räh.]råh,]ræh4]rçuh8K{h9hh:]rèhTXDThe applyTransformation() method always gets passed three variables:ré…�rê}rë(hjáhjßubaubjd)�rì}rí(hUhjÕhh h(jgh*}rî(jiU.h,]rïh.]rðh0]rñjmUh2]ròh4]rójpjquh8K}h9hh:]rô(j‚)�rõ}rö(hX^**$buffer** - Contains the text inside of the column. This is the
text, you want to transform.r÷hjìhh h(j†h*}rø(h0]rùh2]rúh.]rûh,]rüh4]rýuh8Nh9hh:]rþh|)�rÿ}r(hX^**$buffer** - Contains the text inside of the column. This is the
text, you want to transform.rhjõhh h(h€h*}r(h0]rh2]rh.]rh,]rh4]ruh8K}h:]r(cdocutils.nodes
strong
r	)�r
}r(hX**$buffer**rh*}r
(h0]rh2]rh.]rh,]rh4]ruhjÿh:]rhTX$bufferr…�r}r(hUhj
ubah(UstrongrubhTXS - Contains the text inside of the column. This is the
text, you want to transform.r…�r}r(hXS - Contains the text inside of the column. This is the
text, you want to transform.rhjÿubeubaubj‚)�r}r(hXT**$options** - Contains any user-passed options to a transform
function as an array.rhjìhh h(j†h*}r(h0]r h2]r!h.]r"h,]r#h4]r$uh8Nh9hh:]r%h|)�r&}r'(hXT**$options** - Contains any user-passed options to a transform
function as an array.r(hjhh h(h€h*}r)(h0]r*h2]r+h.]r,h,]r-h4]r.uh8Kh:]r/(j	)�r0}r1(hX**$options**r2h*}r3(h0]r4h2]r5h.]r6h,]r7h4]r8uhj&h:]r9hTX$optionsr:…�r;}r<(hUhj0ubah(jubhTXH - Contains any user-passed options to a transform
function as an array.r=…�r>}r?(hXH - Contains any user-passed options to a transform
function as an array.r@hj&ubeubaubj‚)�rA}rB(hX**$meta** - Contains an object with information about your column. The
data is drawn from the output of the `mysql\_fetch\_field()
<http://www.php.net/mysql_fetch_field>`_ function. This means, all
object properties described on the `manual page
<http://www.php.net/mysql_fetch_field>`_ are available in this
variable and can be used to transform a column accordingly to
unsigned/zerofill/not\_null/... properties. The $meta->mimetype
variable contains the original MIME-type of the column (i.e.
'text/plain', 'image/jpeg' etc.)
rChjìhh h(j†h*}rD(h0]rEh2]rFh.]rGh,]rHh4]rIuh8Nh9hh:]rJh|)�rK}rL(hX**$meta** - Contains an object with information about your column. The
data is drawn from the output of the `mysql\_fetch\_field()
<http://www.php.net/mysql_fetch_field>`_ function. This means, all
object properties described on the `manual page
<http://www.php.net/mysql_fetch_field>`_ are available in this
variable and can be used to transform a column accordingly to
unsigned/zerofill/not\_null/... properties. The $meta->mimetype
variable contains the original MIME-type of the column (i.e.
'text/plain', 'image/jpeg' etc.)rMhjAhh h(h€h*}rN(h0]rOh2]rPh.]rQh,]rRh4]rSuh8K�h:]rT(j	)�rU}rV(hX	**$meta**rWh*}rX(h0]rYh2]rZh.]r[h,]r\h4]r]uhjKh:]r^hTX$metar_…�r`}ra(hUhjUubah(jubhTXc - Contains an object with information about your column. The
data is drawn from the output of the rb…�rc}rd(hXc - Contains an object with information about your column. The
data is drawn from the output of the rehjKubj)�rf}rg(hX?`mysql\_fetch\_field()
<http://www.php.net/mysql_fetch_field>`_rhh*}ri(UnamerjXmysql_fetch_field()rkjX$http://www.php.net/mysql_fetch_fieldrlh,]rmh.]rnh0]roh2]rph4]rquhjKh:]rrhTXmysql_fetch_field()rs…�rt}ru(hUhjfubah(j"ubh$)�rv}rw(hX'
<http://www.php.net/mysql_fetch_field>rxhKhjKh(h)h*}ry(Urefurirzjlh,]r{Umysql-fetch-fieldr|ah.]r}h0]r~h2]rh4]r€h
auh:]r�ubhTX> function. This means, all
object properties described on the r‚…�rƒ}r„(hX> function. This means, all
object properties described on the r…hjKubj)�r†}r‡(hX5`manual page
<http://www.php.net/mysql_fetch_field>`_rˆh*}r‰(UnamerŠXmanual pager‹jX$http://www.php.net/mysql_fetch_fieldrŒh,]r�h.]rŽh0]r�h2]r�h4]r‘uhjKh:]r’hTXmanual pager“…�r”}r•(hUhj†ubah(j"ubh$)�r–}r—(hX'
<http://www.php.net/mysql_fetch_field>r˜hKhjKh(h)h*}r™(UrefuriršjŒh,]r›Umanual-pagerœah.]r�h0]ržh2]rŸh4]r hauh:]r¡ubhTXñ are available in this
variable and can be used to transform a column accordingly to
unsigned/zerofill/not_null/... properties. The $meta->mimetype
variable contains the original MIME-type of the column (i.e.
'text/plain', 'image/jpeg' etc.)r¢…�r£}r¤(hXò are available in this
variable and can be used to transform a column accordingly to
unsigned/zerofill/not\_null/... properties. The $meta->mimetype
variable contains the original MIME-type of the column (i.e.
'text/plain', 'image/jpeg' etc.)r¥hjKubeubaubeubeubeubhh h(Usystem_messager¦h*}r§(h0]r¨Ulevelr©Kh,]rªh.]r«hCaUsourcer¬h h2]rh4]r®Uliner¯KUtyper°UINFOr±uh8Kh9hh:]r²h|)�r³}r´(hUh*}rµ(h0]r¶h2]r·h.]r¸h,]r¹h4]rºuhhh:]r»hTX2Duplicate implicit target name: "transformations".r¼…�r½}r¾(hUhj³ubah(h€ubaubaUcurrent_sourcer¿NU
decorationrÀNUautofootnote_startrÁKUnameidsrÂ}rÃ(hjœhh7hhkh	jÝh