<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>Recipe Fiddle: com\whitemagicsoftware\Xslt Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> </head> <body> <div id="top"><!-- do not remove this div! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">Recipe Fiddle </div> </td> </tr> </tbody> </table> </div> <!-- Generated by Doxygen 1.7.6.1 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li class="current"><a href="annotated.html"><span>Classes</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</span></a></li> <li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> <li><a href="functions.html"><span>Class Members</span></a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><b>com</b> </li> <li class="navelem"><b>whitemagicsoftware</b> </li> <li class="navelem"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Xslt.html">Xslt</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <div class="title">com\whitemagicsoftware\Xslt Class Reference</div> </div> </div><!--header--> <div class="contents"> <!-- doxytag: class="com::whitemagicsoftware::Xslt" --> <p>Transforms XML data (into HTML, LaTeX, and XML). <a href="classcom_1_1whitemagicsoftware_1_1Xslt.html#details">More...</a></p> <p><a href="classcom_1_1whitemagicsoftware_1_1Xslt-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Xslt.html#a2e09eb467cdbf15b70bff19c6542acf1">__construct</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Instantiates a new XSLTProcessor class. <a href="#a2e09eb467cdbf15b70bff19c6542acf1"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Xslt.html#a99ded728b638448ee9e3a4c6a5180dc9">transform</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Performs the XSL transformation and then returns the results. <a href="#a99ded728b638448ee9e3a4c6a5180dc9"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Xslt.html#a47c6c322077db1001497e4424d11f941">setXml</a> ($xmlData)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the XML DOM based on the given data. <a href="#a47c6c322077db1001497e4424d11f941"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Xslt.html#a738d4e66ec958a90e7ef264ca78034da">setXmlDom</a> ($xmlDom)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the XML DOM based on the given data. <a href="#a738d4e66ec958a90e7ef264ca78034da"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Xslt.html#aeb7319c27ceb2b181387983fe600c184">toXmlDom</a> ($data)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Converts the given XML data into a DOM object. <a href="#aeb7319c27ceb2b181387983fe600c184"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a44b345ad06f85e906e4a46be01059ad5"></a><!-- doxytag: member="com::whitemagicsoftware::Xslt::setStylesheet" ref="a44b345ad06f85e906e4a46be01059ad5" args="($stylesheet)" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Xslt.html#a44b345ad06f85e906e4a46be01059ad5">setStylesheet</a> ($stylesheet)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sets the XSL DOM. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1b20d81ac66775dc8a9423995ec3f0d6"></a><!-- doxytag: member="com::whitemagicsoftware::Xslt::setParameter" ref="a1b20d81ac66775dc8a9423995ec3f0d6" args="($k, $v)" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Xslt.html#a1b20d81ac66775dc8a9423995ec3f0d6">setParameter</a> ($k, $v)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Passes a parameter to the XSLT engine, in the default namespace. <br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Transforms XML data (into HTML, LaTeX, and XML). </p> </div><hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="a2e09eb467cdbf15b70bff19c6542acf1"></a><!-- doxytag: member="com::whitemagicsoftware::Xslt::__construct" ref="a2e09eb467cdbf15b70bff19c6542acf1" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Xslt.html#a2e09eb467cdbf15b70bff19c6542acf1">Xslt::__construct</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Instantiates a new XSLTProcessor class. </p> <dl class="todo"><dt><b><a class="el" href="todo.html#_todo000010">Todo:</a></b></dt><dd>Enforce XML and XSL data as arguments and make corresponding set methods private? </dd></dl> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a47c6c322077db1001497e4424d11f941"></a><!-- doxytag: member="com::whitemagicsoftware::Xslt::setXml" ref="a47c6c322077db1001497e4424d11f941" args="($xmlData)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Xslt.html#a47c6c322077db1001497e4424d11f941">Xslt::setXml</a> </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"><em>xmlData</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Sets the XML DOM based on the given data. </p> <p>This calls the toXmlDom method.</p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">$xmlData</td><td>An XML document as a string. </td></tr> </table> </dd> </dl> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classcom_1_1whitemagicsoftware_1_1Xslt.html#aeb7319c27ceb2b181387983fe600c184" title="Converts the given XML data into a DOM object.">toXmlDom</a> </dd> <dd> <a class="el" href="classcom_1_1whitemagicsoftware_1_1Xslt.html#a738d4e66ec958a90e7ef264ca78034da" title="Sets the XML DOM based on the given data.">setXmlDom</a> </dd></dl> </div> </div> <a class="anchor" id="a738d4e66ec958a90e7ef264ca78034da"></a><!-- doxytag: member="com::whitemagicsoftware::Xslt::setXmlDom" ref="a738d4e66ec958a90e7ef264ca78034da" args="($xmlDom)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Xslt.html#a738d4e66ec958a90e7ef264ca78034da">Xslt::setXmlDom</a> </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"><em>xmlDom</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Sets the XML DOM based on the given data. </p> <p>The data must have</p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">$xmlDom</td><td>A DOM object. </td></tr> </table> </dd> </dl> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classcom_1_1whitemagicsoftware_1_1Xslt.html#a47c6c322077db1001497e4424d11f941" title="Sets the XML DOM based on the given data.">setXml</a> </dd></dl> </div> </div> <a class="anchor" id="aeb7319c27ceb2b181387983fe600c184"></a><!-- doxytag: member="com::whitemagicsoftware::Xslt::toXmlDom" ref="aeb7319c27ceb2b181387983fe600c184" args="($data)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Xslt.html#aeb7319c27ceb2b181387983fe600c184">Xslt::toXmlDom</a> </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"><em>data</em></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Converts the given XML data into a DOM object. </p> <p>This does not update the internal DOM object.</p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">$data</td><td>An XML document as a string to convert to a DOM. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a99ded728b638448ee9e3a4c6a5180dc9"></a><!-- doxytag: member="com::whitemagicsoftware::Xslt::transform" ref="a99ded728b638448ee9e3a4c6a5180dc9" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Xslt.html#a99ded728b638448ee9e3a4c6a5180dc9">Xslt::transform</a> </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Performs the XSL transformation and then returns the results. </p> <p>The XML document must have been set using the setXml method.</p> <dl class="see"><dt><b>See also:</b></dt><dd><a class="el" href="classcom_1_1whitemagicsoftware_1_1Xslt.html#a47c6c322077db1001497e4424d11f941" title="Sets the XML DOM based on the given data.">setXml</a> </dd></dl> <dl class="return"><dt><b>Returns:</b></dt><dd>The results from transformToXML on the DOM using the internal XSLTProcessor instance. </dd></dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>class.Xslt.php</li> </ul> </div><!-- contents --> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Variables</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <hr class="footer"/><address class="footer"><small> Generated on Tue Jul 30 2013 22:06:29 for Recipe Fiddle by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.7.6.1 </small></address> </body> </html>