<!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\Obj 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_1Obj.html">Obj</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> </div> <div class="headertitle"> <div class="title">com\whitemagicsoftware\Obj Class Reference</div> </div> </div><!--header--> <div class="contents"> <!-- doxytag: class="com::whitemagicsoftware::Obj" --> <p>Superclass that abstracts the common functionality. <a href="classcom_1_1whitemagicsoftware_1_1Obj.html#details">More...</a></p> <div class="dynheader"> Inheritance diagram for com\whitemagicsoftware\Obj:</div> <div class="dyncontent"> <div class="center"> <img src="classcom_1_1whitemagicsoftware_1_1Obj.png" usemap="#com\whitemagicsoftware\Obj_map" alt=""/> <map id="com\whitemagicsoftware\Obj_map" name="com\whitemagicsoftware\Obj_map"> <area href="classcom_1_1whitemagicsoftware_1_1BaseController.html" title="Used by all subclasses that interact with the end user." alt="com\whitemagicsoftware\BaseController" shape="rect" coords="0,56,266,80"/> <area href="classcom_1_1whitemagicsoftware_1_1Cookie.html" title="Responsible for setting and retrieving the value of the cookie for a given IP address." alt="com\whitemagicsoftware\Cookie" shape="rect" coords="276,56,542,80"/> <area href="classcom_1_1whitemagicsoftware_1_1Database.html" title="Used for interacting with the database." alt="com\whitemagicsoftware\Database" shape="rect" coords="552,56,818,80"/> <area href="classcom_1_1whitemagicsoftware_1_1Photograph.html" title="Handles storage and retrieval of photographs." alt="com\whitemagicsoftware\Photograph" shape="rect" coords="828,56,1094,80"/> <area href="classcom_1_1whitemagicsoftware_1_1SecureImageUpload.html" title="Handles image uploads, securely, into the /tmp/recipefiddle/uploads directory." alt="com\whitemagicsoftware\SecureImageUpload" shape="rect" coords="1104,56,1370,80"/> <area href="classcom_1_1whitemagicsoftware_1_1Account.html" title="Lists all the recipes associated with an account." alt="com\whitemagicsoftware\Account" shape="rect" coords="276,112,542,136"/> <area href="classcom_1_1whitemagicsoftware_1_1Admin.html" title="Runs the ingredient category and name administration editor." alt="com\whitemagicsoftware\Admin" shape="rect" coords="276,168,542,192"/> <area href="classcom_1_1whitemagicsoftware_1_1Ajax.html" title="Superclass for all Ajax request handlers." alt="com\whitemagicsoftware\Ajax" shape="rect" coords="276,224,542,248"/> <area href="classcom_1_1whitemagicsoftware_1_1Book.html" title="Displays the book editing page and generates a PDF book." alt="com\whitemagicsoftware\Book" shape="rect" coords="276,280,542,304"/> <area href="classcom_1_1whitemagicsoftware_1_1Diet.html" title="Allows the user to set their dietary preferences." alt="com\whitemagicsoftware\Diet" shape="rect" coords="276,336,542,360"/> <area href="classcom_1_1whitemagicsoftware_1_1GroceryList.html" title="Allows the user to create a grocery list from recipes." alt="com\whitemagicsoftware\GroceryList" shape="rect" coords="276,392,542,416"/> <area href="classcom_1_1whitemagicsoftware_1_1Potluck.html" title="Allows the user to either organize or add themselves to a potluck." alt="com\whitemagicsoftware\Potluck" shape="rect" coords="276,448,542,472"/> <area href="classcom_1_1whitemagicsoftware_1_1Recipe.html" title="Provides recipe editing and viewing functionality." alt="com\whitemagicsoftware\Recipe" shape="rect" coords="276,504,542,528"/> <area href="classcom_1_1whitemagicsoftware_1_1Search.html" title="Allows the user to search for recipes, taking into consideration a variety of aspects, including: potluck attendees, dietary preferences, etc." alt="com\whitemagicsoftware\Search" shape="rect" coords="276,560,542,584"/> </map> </div></div> <p><a href="classcom_1_1whitemagicsoftware_1_1Obj-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"><a class="anchor" id="aef48e5fcaa93aed7673b8af572daf843"></a><!-- doxytag: member="com::whitemagicsoftware::Obj::__construct" ref="aef48e5fcaa93aed7673b8af572daf843" args="()" -->  </td><td class="memItemRight" valign="bottom"><a class="el" href="classcom_1_1whitemagicsoftware_1_1Obj.html#aef48e5fcaa93aed7673b8af572daf843">__construct</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Default (empty) constructor. <br/></td></tr> <tr><td colspan="2"><h2><a name="pro-methods"></a> Protected 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_1Obj.html#ad62864bffc3424e6a736e290874856f8">log</a> ($message)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Writes a message to the error log. <a href="#ad62864bffc3424e6a736e290874856f8"></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_1Obj.html#a64328b286cf45d2f3426d943ce99044f">notify</a> ($message, $errline, $errfile)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Sends an e-mail notification to the system-configured e-mail address. <a href="#a64328b286cf45d2f3426d943ce99044f"></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_1Obj.html#ac4b0471624ef08e867f82ee4932e0ed7">startsWith</a> ($haystack, $needle)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true iff $haystack starts with $needle. <a href="#ac4b0471624ef08e867f82ee4932e0ed7"></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_1Obj.html#ae2f447ef3aef00a5b54d48ccd3528240">endsWith</a> ($haystack, $needle)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true iff $haystack ends with $needle. <a href="#ae2f447ef3aef00a5b54d48ccd3528240"></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_1Obj.html#ab6bfd2e123875d4b99bed1dc7e3aa350">createDirectory</a> ($path)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Attempts to create the given path, provided it does not already exist. <a href="#ab6bfd2e123875d4b99bed1dc7e3aa350"></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_1Obj.html#aff2066a8917c9d37704b5f87e91b8533">getTemporaryDirectory</a> ($subdir)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a safe path to store uploaded files. <a href="#aff2066a8917c9d37704b5f87e91b8533"></a><br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>Superclass that abstracts the common functionality. </p> </div><hr/><h2>Member Function Documentation</h2> <a class="anchor" id="ab6bfd2e123875d4b99bed1dc7e3aa350"></a><!-- doxytag: member="com::whitemagicsoftware::Obj::createDirectory" ref="ab6bfd2e123875d4b99bed1dc7e3aa350" args="($path)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Obj.html#ab6bfd2e123875d4b99bed1dc7e3aa350">Obj::createDirectory</a> </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"><em>path</em></td><td>)</td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Attempts to create the given path, provided it does not already exist. </p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">$path</td><td>The directory path to create. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ae2f447ef3aef00a5b54d48ccd3528240"></a><!-- doxytag: member="com::whitemagicsoftware::Obj::endsWith" ref="ae2f447ef3aef00a5b54d48ccd3528240" args="($haystack, $needle)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Obj.html#ae2f447ef3aef00a5b54d48ccd3528240">Obj::endsWith</a> </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"><em>haystack</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"><em>needle</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns true iff $haystack ends with $needle. </p> <ul> <li>wms_ends_with( 'asdf asdf', 'as' ) === false</li> <li>wms_ends_with( 'asdf asdf', 'df' ) === true</li> </ul> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">$haystack</td><td>The string that might end with $needle. </td></tr> <tr><td class="paramname">$needle</td><td>The string that might be found at the end of $haystack. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="aff2066a8917c9d37704b5f87e91b8533"></a><!-- doxytag: member="com::whitemagicsoftware::Obj::getTemporaryDirectory" ref="aff2066a8917c9d37704b5f87e91b8533" args="($subdir)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Obj.html#aff2066a8917c9d37704b5f87e91b8533">Obj::getTemporaryDirectory</a> </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"><em>subdir</em></td><td>)</td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns a safe path to store uploaded files. </p> <p>This will return the path with a trailing slash. This uses $DEFAULT_APP_TITLE (without spaces and in lowercase).</p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">$subdir</td><td>A directory below the system temporary directory; do not include slashes. </td></tr> </table> </dd> </dl> <dl class="return"><dt><b>Returns:</b></dt><dd>Typically a string of the form: /tmp/$appdir/$subdir/ </dd></dl> </div> </div> <a class="anchor" id="ad62864bffc3424e6a736e290874856f8"></a><!-- doxytag: member="com::whitemagicsoftware::Obj::log" ref="ad62864bffc3424e6a736e290874856f8" args="($message)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Obj.html#ad62864bffc3424e6a736e290874856f8">Obj::log</a> </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"><em>message</em></td><td>)</td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Writes a message to the error log. </p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">$message</td><td>The message to write. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="a64328b286cf45d2f3426d943ce99044f"></a><!-- doxytag: member="com::whitemagicsoftware::Obj::notify" ref="a64328b286cf45d2f3426d943ce99044f" args="($message, $errline, $errfile)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Obj.html#a64328b286cf45d2f3426d943ce99044f">Obj::notify</a> </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"><em>message</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"><em>errline</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"><em>errfile</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Sends an e-mail notification to the system-configured e-mail address. </p> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">$message</td><td>The message to send. </td></tr> <tr><td class="paramname">$errline</td><td>The line in the file that had an error. </td></tr> <tr><td class="paramname">$errfile</td><td>The path to the file wherein the error occurred. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="ac4b0471624ef08e867f82ee4932e0ed7"></a><!-- doxytag: member="com::whitemagicsoftware::Obj::startsWith" ref="ac4b0471624ef08e867f82ee4932e0ed7" args="($haystack, $needle)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">com\whitemagicsoftware\<a class="el" href="classcom_1_1whitemagicsoftware_1_1Obj.html#ac4b0471624ef08e867f82ee4932e0ed7">Obj::startsWith</a> </td> <td>(</td> <td class="paramtype">$ </td> <td class="paramname"><em>haystack</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">$ </td> <td class="paramname"><em>needle</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Returns true iff $haystack starts with $needle. </p> <ul> <li>wms_starts_with( 'asdf asdf', 'as' ) === true</li> <li>wms_starts_with( 'asdf asdf', 'df' ) === false</li> </ul> <dl class="params"><dt><b>Parameters:</b></dt><dd> <table class="params"> <tr><td class="paramname">$haystack</td><td>The string that might begin with $needle. </td></tr> <tr><td class="paramname">$needle</td><td>The string that might be found at the start of $haystack. </td></tr> </table> </dd> </dl> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>class.Obj.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>