cache/README examples/test-db-cache.php5 examples/test-file-cache.php5 @@ -20,7 +20,7 @@ </ul> <p class="notes" id="credit"> - Documentation generated on Wed, 19 Nov 2008 21:55:01 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a> + Documentation generated on Thu, 20 Nov 2008 13:43:46 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a> </p> </body> </html> \ No newline at end of file doc/classtrees_phpArmory.html @@ -21,6 +21,7 @@ <a class="index-letter" href="elementindex.html#d">d</a> <a class="index-letter" href="elementindex.html#g">g</a> <a class="index-letter" href="elementindex.html#l">l</a> + <a class="index-letter" href="elementindex.html#m">m</a> <a class="index-letter" href="elementindex.html#"></a> <a class="index-letter" href="elementindex.html#s">s</a> <a class="index-letter" href="elementindex.html#t">t</a> @@ -74,6 +75,20 @@ </div> <dl> <dt class="field"> + <span class="var-title">$dataPath</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#var$dataPath">phpArmory5Cache::$dataPath</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">The path to the cache directory (must chmod 777 to make it writeable).</div> + </dd> + <dt class="field"> + <span class="var-title">$dataStore</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#var$dataStore">phpArmory5Cache::$dataStore</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Selected data storage for the class. Can be "file" or "mysql".</div> + </dd> + <dt class="field"> <span class="var-title">$downloadRetries</span> </dt> <dd class="index-item-body"> @@ -99,10 +114,24 @@ <span class="method-title">getArenaTeamData</span> </dt> <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#methodgetArenaTeamData">phpArmory5Cache::getArenaTeamData()</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Provides information on a specific arena team.</div> + </dd> + <dt class="field"> + <span class="method-title">getArenaTeamData</span> + </dt> + <dd class="index-item-body"> <div class="index-item-details"><a href="phpArmory/classes/phpArmory5.html#methodgetArenaTeamData">phpArmory5::getArenaTeamData()</a> in phpArmory.class.php</div> <div class="index-item-description">Provides information on a specific arena team.</div> </dd> <dt class="field"> + <span class="method-title">getCachedData</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#methodgetCachedData">phpArmory5Cache::getCachedData()</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Retrieve cached data.</div> + </dd> + <dt class="field"> <span class="method-title">getCharacterData</span> </dt> <dd class="index-item-body"> @@ -110,6 +139,13 @@ <div class="index-item-description">Provides information on a specific character.</div> </dd> <dt class="field"> + <span class="method-title">getCharacterData</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#methodgetCharacterData">phpArmory5Cache::getCharacterData()</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Provides information on a specific character.</div> + </dd> + <dt class="field"> <span class="method-title">getCharacterIconURL</span> </dt> <dd class="index-item-body"> @@ -124,6 +160,20 @@ <div class="index-item-description">Provides information on a specific guild.</div> </dd> <dt class="field"> + <span class="method-title">getGuildData</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#methodgetGuildData">phpArmory5Cache::getGuildData()</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Provides information on a specific guild.</div> + </dd> + <dt class="field"> + <span class="method-title">getItemData</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#methodgetItemData">phpArmory5Cache::getItemData()</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Provides information on a specific item by querying its' ID.</div> + </dd> + <dt class="field"> <span class="method-title">getItemData</span> </dt> <dd class="index-item-body"> @@ -138,6 +188,13 @@ <div class="index-item-description">Provides information on a specific item by querying its' name.</div> </dd> <dt class="field"> + <span class="method-title">getItemDataByName</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#methodgetItemDataByName">phpArmory5Cache::getItemDataByName()</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Provides information on a specific item by querying its' name.</div> + </dd> + <dt class="field"> <span class="method-title">getLocale</span> </dt> <dd class="index-item-body"> @@ -187,6 +244,28 @@ <div class="index-item-description">The locale used to send requests.</div> </dd> </dl> + <a name="m"></a> + <div class="index-letter-section"> + <div style="float: left" class="index-letter-title">m</div> + <div style="float: right"><a href="#top">top</a></div> + <div style="clear: both"></div> + </div> + <dl> + <dt class="field"> + <span class="var-title">$mysqlString</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#var$mysqlString">phpArmory5Cache::$mysqlString</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">MySQL connection string.</div> + </dd> + <dt class="field"> + <span class="var-title">$mysqlTable</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#var$mysqlTable">phpArmory5Cache::$mysqlTable</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">MySQL cache table.</div> + </dd> + </dl> <a name="p"></a> <div class="index-letter-section"> <div style="float: left" class="index-letter-title">p</div> @@ -236,6 +315,13 @@ <div class="index-item-description">Configure the area in which phpArmory should operate.</div> </dd> <dt class="field"> + <span class="method-title">setCachedData</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#methodsetCachedData">phpArmory5Cache::setCachedData()</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Saved retrieved data to cache.</div> + </dd> + <dt class="field"> <span class="method-title">setLocale</span> </dt> <dd class="index-item-body"> @@ -265,12 +351,40 @@ <div class="index-item-description">Raise a PHP error.</div> </dd> <dt class="field"> + <span class="method-title">triggerError</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#methodtriggerError">phpArmory5Cache::triggerError()</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Raise a PHP error.</div> + </dd> + <dt class="field"> + <span class="method-title">triggerNotice</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#methodtriggerNotice">phpArmory5Cache::triggerNotice()</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Raise a PHP notice if the class is used from the command line.</div> + </dd> + <dt class="field"> <span class="method-title">triggerNotice</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="phpArmory/classes/phpArmory5.html#methodtriggerNotice">phpArmory5::triggerNotice()</a> in phpArmory.class.php</div> <div class="index-item-description">Raise a PHP notice if the class is used from the command line.</div> </dd> + <dt class="field"> + <span class="method-title">triggerWarning</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#methodtriggerWarning">phpArmory5Cache::triggerWarning()</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Raise a PHP warning if the class is used from the command line.</div> + </dd> + <dt class="field"> + <span class="method-title">triggerWarning</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5.html#methodtriggerWarning">phpArmory5::triggerWarning()</a> in phpArmory.class.php</div> + <div class="index-item-description">Raise a PHP warning if the class is used from the command line.</div> + </dd> </dl> <a name="u"></a> <div class="index-letter-section"> @@ -280,6 +394,13 @@ </div> <dl> <dt class="field"> + <span class="var-title">$updateInterval</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#var$updateInterval">phpArmory5Cache::$updateInterval</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">The time between cache updates in seconds</div> + </dd> + <dt class="field"> <span class="var-title">$userAgent</span> </dt> <dd class="index-item-body"> @@ -298,6 +419,13 @@ <span class="var-title">$version</span> </dt> <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#var$version">phpArmory5Cache::$version</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Current version of the phpArmory5Cache class.</div> + </dd> + <dt class="field"> + <span class="var-title">$version</span> + </dt> + <dd class="index-item-body"> <div class="index-item-details"><a href="phpArmory/classes/phpArmory5.html#var$version">phpArmory5::$version</a> in phpArmory.class.php</div> <div class="index-item-description">Current version of the phpArmory5 class.</div> </dd> @@ -305,6 +433,13 @@ <span class="var-title">$version_state</span> </dt> <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#var$version_state">phpArmory5Cache::$version_state</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Current state of the phpArmory5Cache class. Allowed values are alpha, beta, and release.</div> + </dd> + <dt class="field"> + <span class="var-title">$version_state</span> + </dt> + <dd class="index-item-body"> <div class="index-item-details"><a href="phpArmory/classes/phpArmory5.html#var$version_state">phpArmory5::$version_state</a> in phpArmory.class.php</div> <div class="index-item-description">Current state of the phpArmory5 class. Allowed values are alpha, beta, and release.</div> </dd> @@ -345,20 +480,6 @@ <div class="index-item-details"><a href="phpArmory/classes/phpArmory5.html#method__construct">phpArmory5::__construct()</a> in phpArmory.class.php</div> <div class="index-item-description">phpArmory5 class constructor.</div> </dd> - <dt class="field"> - <span class="method-title">__destruct</span> - </dt> - <dd class="index-item-body"> - <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#method__destruct">phpArmory5Cache::__destruct()</a> in phpArmoryCache.class.php</div> - <div class="index-item-description">phpArmory5Cache destructor.</div> - </dd> - <dt class="field"> - <span class="method-title">__destruct</span> - </dt> - <dd class="index-item-body"> - <div class="index-item-details"><a href="phpArmory/classes/phpArmory5.html#method__destruct">phpArmory5::__destruct()</a> in phpArmory.class.php</div> - <div class="index-item-description">phpArmory5 destructor.</div> - </dd> </dl> <div class="index-letter-menu"> @@ -367,6 +488,7 @@ <a class="index-letter" href="elementindex.html#d">d</a> <a class="index-letter" href="elementindex.html#g">g</a> <a class="index-letter" href="elementindex.html#l">l</a> + <a class="index-letter" href="elementindex.html#m">m</a> <a class="index-letter" href="elementindex.html#"></a> <a class="index-letter" href="elementindex.html#s">s</a> <a class="index-letter" href="elementindex.html#t">t</a> doc/elementindex.html @@ -18,6 +18,7 @@ <a class="index-letter" href="elementindex_phpArmory.html#d">d</a> <a class="index-letter" href="elementindex_phpArmory.html#g">g</a> <a class="index-letter" href="elementindex_phpArmory.html#l">l</a> + <a class="index-letter" href="elementindex_phpArmory.html#m">m</a> <a class="index-letter" href="elementindex_phpArmory.html#p">p</a> <a class="index-letter" href="elementindex_phpArmory.html#s">s</a> <a class="index-letter" href="elementindex_phpArmory.html#t">t</a> @@ -48,20 +49,6 @@ <div class="index-item-details"><a href="phpArmory/classes/phpArmory5.html#method__construct">phpArmory5::__construct()</a> in phpArmory.class.php</div> <div class="index-item-description">phpArmory5 class constructor.</div> </dd> - <dt class="field"> - <span class="method-title">__destruct</span> - </dt> - <dd class="index-item-body"> - <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#method__destruct">phpArmory5Cache::__destruct()</a> in phpArmoryCache.class.php</div> - <div class="index-item-description">phpArmory5Cache destructor.</div> - </dd> - <dt class="field"> - <span class="method-title">__destruct</span> - </dt> - <dd class="index-item-body"> - <div class="index-item-details"><a href="phpArmory/classes/phpArmory5.html#method__destruct">phpArmory5::__destruct()</a> in phpArmory.class.php</div> - <div class="index-item-description">phpArmory5 destructor.</div> - </dd> </dl> <a name="a"></a> <div class="index-letter-section"> @@ -108,6 +95,20 @@ </div> <dl> <dt class="field"> + <span class="var-title">$dataPath</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#var$dataPath">phpArmory5Cache::$dataPath</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">The path to the cache directory (must chmod 777 to make it writeable).</div> + </dd> + <dt class="field"> + <span class="var-title">$dataStore</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#var$dataStore">phpArmory5Cache::$dataStore</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Selected data storage for the class. Can be "file" or "mysql".</div> + </dd> + <dt class="field"> <span class="var-title">$downloadRetries</span> </dt> <dd class="index-item-body"> @@ -133,10 +134,24 @@ <span class="method-title">getArenaTeamData</span> </dt> <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#methodgetArenaTeamData">phpArmory5Cache::getArenaTeamData()</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Provides information on a specific arena team.</div> + </dd> + <dt class="field"> + <span class="method-title">getArenaTeamData</span> + </dt> + <dd class="index-item-body"> <div class="index-item-details"><a href="phpArmory/classes/phpArmory5.html#methodgetArenaTeamData">phpArmory5::getArenaTeamData()</a> in phpArmory.class.php</div> <div class="index-item-description">Provides information on a specific arena team.</div> </dd> <dt class="field"> + <span class="method-title">getCachedData</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#methodgetCachedData">phpArmory5Cache::getCachedData()</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Retrieve cached data.</div> + </dd> + <dt class="field"> <span class="method-title">getCharacterData</span> </dt> <dd class="index-item-body"> @@ -144,6 +159,13 @@ <div class="index-item-description">Provides information on a specific character.</div> </dd> <dt class="field"> + <span class="method-title">getCharacterData</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#methodgetCharacterData">phpArmory5Cache::getCharacterData()</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Provides information on a specific character.</div> + </dd> + <dt class="field"> <span class="method-title">getCharacterIconURL</span> </dt> <dd class="index-item-body"> @@ -158,6 +180,20 @@ <div class="index-item-description">Provides information on a specific guild.</div> </dd> <dt class="field"> + <span class="method-title">getGuildData</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#methodgetGuildData">phpArmory5Cache::getGuildData()</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Provides information on a specific guild.</div> + </dd> + <dt class="field"> + <span class="method-title">getItemData</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#methodgetItemData">phpArmory5Cache::getItemData()</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Provides information on a specific item by querying its' ID.</div> + </dd> + <dt class="field"> <span class="method-title">getItemData</span> </dt> <dd class="index-item-body"> @@ -172,6 +208,13 @@ <div class="index-item-description">Provides information on a specific item by querying its' name.</div> </dd> <dt class="field"> + <span class="method-title">getItemDataByName</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#methodgetItemDataByName">phpArmory5Cache::getItemDataByName()</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Provides information on a specific item by querying its' name.</div> + </dd> + <dt class="field"> <span class="method-title">getLocale</span> </dt> <dd class="index-item-body"> @@ -221,6 +264,28 @@ <div class="index-item-description">The locale used to send requests.</div> </dd> </dl> + <a name="m"></a> + <div class="index-letter-section"> + <div style="float: left" class="index-letter-title">m</div> + <div style="float: right"><a href="#top">top</a></div> + <div style="clear: both"></div> + </div> + <dl> + <dt class="field"> + <span class="var-title">$mysqlString</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#var$mysqlString">phpArmory5Cache::$mysqlString</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">MySQL connection string.</div> + </dd> + <dt class="field"> + <span class="var-title">$mysqlTable</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#var$mysqlTable">phpArmory5Cache::$mysqlTable</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">MySQL cache table.</div> + </dd> + </dl> <a name="p"></a> <div class="index-letter-section"> <div style="float: left" class="index-letter-title">p</div> @@ -270,6 +335,13 @@ <div class="index-item-description">Configure the area in which phpArmory should operate.</div> </dd> <dt class="field"> + <span class="method-title">setCachedData</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#methodsetCachedData">phpArmory5Cache::setCachedData()</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Saved retrieved data to cache.</div> + </dd> + <dt class="field"> <span class="method-title">setLocale</span> </dt> <dd class="index-item-body"> @@ -299,12 +371,40 @@ <div class="index-item-description">Raise a PHP error.</div> </dd> <dt class="field"> + <span class="method-title">triggerError</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#methodtriggerError">phpArmory5Cache::triggerError()</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Raise a PHP error.</div> + </dd> + <dt class="field"> + <span class="method-title">triggerNotice</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#methodtriggerNotice">phpArmory5Cache::triggerNotice()</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Raise a PHP notice if the class is used from the command line.</div> + </dd> + <dt class="field"> <span class="method-title">triggerNotice</span> </dt> <dd class="index-item-body"> <div class="index-item-details"><a href="phpArmory/classes/phpArmory5.html#methodtriggerNotice">phpArmory5::triggerNotice()</a> in phpArmory.class.php</div> <div class="index-item-description">Raise a PHP notice if the class is used from the command line.</div> </dd> + <dt class="field"> + <span class="method-title">triggerWarning</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#methodtriggerWarning">phpArmory5Cache::triggerWarning()</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Raise a PHP warning if the class is used from the command line.</div> + </dd> + <dt class="field"> + <span class="method-title">triggerWarning</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5.html#methodtriggerWarning">phpArmory5::triggerWarning()</a> in phpArmory.class.php</div> + <div class="index-item-description">Raise a PHP warning if the class is used from the command line.</div> + </dd> </dl> <a name="u"></a> <div class="index-letter-section"> @@ -314,6 +414,13 @@ </div> <dl> <dt class="field"> + <span class="var-title">$updateInterval</span> + </dt> + <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#var$updateInterval">phpArmory5Cache::$updateInterval</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">The time between cache updates in seconds</div> + </dd> + <dt class="field"> <span class="var-title">$userAgent</span> </dt> <dd class="index-item-body"> @@ -332,6 +439,13 @@ <span class="var-title">$version</span> </dt> <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#var$version">phpArmory5Cache::$version</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Current version of the phpArmory5Cache class.</div> + </dd> + <dt class="field"> + <span class="var-title">$version</span> + </dt> + <dd class="index-item-body"> <div class="index-item-details"><a href="phpArmory/classes/phpArmory5.html#var$version">phpArmory5::$version</a> in phpArmory.class.php</div> <div class="index-item-description">Current version of the phpArmory5 class.</div> </dd> @@ -339,6 +453,13 @@ <span class="var-title">$version_state</span> </dt> <dd class="index-item-body"> + <div class="index-item-details"><a href="phpArmory/classes/phpArmory5Cache.html#var$version_state">phpArmory5Cache::$version_state</a> in phpArmoryCache.class.php</div> + <div class="index-item-description">Current state of the phpArmory5Cache class. Allowed values are alpha, beta, and release.</div> + </dd> + <dt class="field"> + <span class="var-title">$version_state</span> + </dt> + <dd class="index-item-body"> <div class="index-item-details"><a href="phpArmory/classes/phpArmory5.html#var$version_state">phpArmory5::$version_state</a> in phpArmory.class.php</div> <div class="index-item-description">Current state of the phpArmory5 class. Allowed values are alpha, beta, and release.</div> </dd> @@ -365,6 +486,7 @@ <a class="index-letter" href="elementindex_phpArmory.html#d">d</a> <a class="index-letter" href="elementindex_phpArmory.html#g">g</a> <a class="index-letter" href="elementindex_phpArmory.html#l">l</a> + <a class="index-letter" href="elementindex_phpArmory.html#m">m</a> <a class="index-letter" href="elementindex_phpArmory.html#p">p</a> <a class="index-letter" href="elementindex_phpArmory.html#s">s</a> <a class="index-letter" href="elementindex_phpArmory.html#t">t</a> doc/elementindex_phpArmory.html @@ -10,7 +10,7 @@ <body> <a href="#Post-parsing">Post-parsing</a><br> <p class="notes" id="credit"> - Documentation generated on Wed, 19 Nov 2008 21:55:02 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a> + Documentation generated on Thu, 20 Nov 2008 13:43:46 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a> </p> </body> </html> \ No newline at end of file doc/errors.html @@ -4,7 +4,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> -  +  <title>Generated Documentation</title> <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/> </head> doc/index.html @@ -63,7 +63,7 @@ <p class="notes" id="credit"> - Documentation generated on Wed, 19 Nov 2008 21:55:01 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a> + Documentation generated on Thu, 20 Nov 2008 13:43:46 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a> </p> </div></body> </html> \ No newline at end of file doc/phpArmory/_phpArmory.class.php.html @@ -69,13 +69,13 @@ | <span class="disabled">Includes</span> </div> <div class="info-box-body"> - <a name="_phpArmory5_class_php"></a> + <a name="_phpArmory_class_php"></a> <div class="evenrow"> <div> <span class="include-title"> <span class="include-type">require_once</span> - (<span class="include-name">'phpArmory5.class.php'</span>) + (<span class="include-name"><a href="../phpArmory/_phpArmory.class.php.html">'phpArmory.class.php'</a></span>) (line <span class="line-number">19</span>) </span> </div> @@ -91,7 +91,7 @@ <p class="notes" id="credit"> - Documentation generated on Wed, 19 Nov 2008 21:55:02 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a> + Documentation generated on Thu, 20 Nov 2008 13:43:46 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a> </p> </div></body> </html> \ No newline at end of file doc/phpArmory/_phpArmoryCache.class.php.html @@ -139,11 +139,6 @@ ([<span class="var-type">string</span> <span class="var-name">$areaName</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span> <span class="var-name">$downloadRetries</span> = <span class="var-default">NULL</span>]) </div> <div class="method-definition"> - <span class="method-result">void</span> - <a href="#__destruct" title="details" class="method-name">__destruct</a> - () - </div> - <div class="method-definition"> <span class="method-result">array</span> <a href="#convertXmlToArray" title="details" class="method-name">&convertXmlToArray</a> (<span class="var-type">string</span> <span class="var-name">$xmlData</span>, [<span class="var-type">bool</span> <span class="var-name">$includeTopTag</span> = <span class="var-default">FALSE</span>], [<span class="var-type">bool</span> <span class="var-name">$lowerCaseTags</span> = <span class="var-default">TRUE</span>]) @@ -223,6 +218,11 @@ <a href="#triggerNotice" title="details" class="method-name">triggerNotice</a> ([<span class="var-type">string</span> <span class="var-name">$userNotice</span> = <span class="var-default">NULL</span>]) </div> + <div class="method-definition"> + <span class="method-result">void</span> + <a href="#triggerWarning" title="details" class="method-name">triggerWarning</a> + ([<span class="var-type">string</span> <span class="var-name">$userWarning</span> = <span class="var-default">NULL</span>]) + </div> </div> </div> </div> @@ -423,6 +423,14 @@ + <hr class="separator" /> + <div class="notes">Redefined in descendants as:</div> + <ul class="redefinitions"> + <li> + <a href="../../phpArmory/classes/phpArmory5Cache.html#var$version">phpArmory5Cache::$version</a> + : Current version of the phpArmory5Cache class. + </li> + </ul> </div> @@ -433,7 +441,7 @@ <span class="var-title"> <span class="var-type">string</span> <span class="var-name">$version_state</span> - = <span class="var-default"> "rc-1"</span> (line <span class="line-number">39</span>) + = <span class="var-default"> "release"</span> (line <span class="line-number">39</span>) </span> </div> @@ -446,6 +454,14 @@ + <hr class="separator" /> + <div class="notes">Redefined in descendants as:</div> + <ul class="redefinitions"> + <li> + <a href="../../phpArmory/classes/phpArmory5Cache.html#var$version_state">phpArmory5Cache::$version_state</a> + : Current state of the phpArmory5Cache class. Allowed values are alpha, beta, and release. + </li> + </ul> </div> @@ -530,43 +546,11 @@ </li> </ul> </div> -<a name="method__destruct" id="__destruct"></a> -<div class="oddrow"> - - <div class="method-header"> - <span class="method-title">Destructor __destruct</span> (line <span class="line-number">160</span>) - </div> - -  -<p class="short-description">phpArmory5 destructor.</p> - <ul class="tags"> - <li><span class="field">access:</span> public</li> - </ul> - - <div class="method-signature"> - <span class="method-result">void</span> - <span class="method-name"> - __destruct - </span> - () - </div> - - - - <hr class="separator" /> - <div class="notes">Redefined in descendants as:</div> - <ul class="redefinitions"> - <li> - <a href="../../phpArmory/classes/phpArmory5Cache.html#method__destruct">phpArmory5Cache::__destruct()</a> - : phpArmory5Cache destructor. - </li> - </ul> - </div> <a name="methodconvertXmlToArray" id="convertXmlToArray"></a> -<div class="evenrow"> +<div class="oddrow"> <div class="method-header"> - <span class="method-title">convertXmlToArray</span> (line <span class="line-number">331</span>) + <span class="method-title">convertXmlToArray</span> (line <span class="line-number">323</span>) </div>  @@ -599,10 +583,10 @@ </div> <a name="methodgetArea" id="getArea"></a> -<div class="oddrow"> +<div class="evenrow"> <div class="method-header"> - <span class="method-title">getArea</span> (line <span class="line-number">169</span>) + <span class="method-title">getArea</span> (line <span class="line-number">161</span>) </div>  @@ -624,10 +608,10 @@ </div> <a name="methodgetArenaTeamData" id="getArenaTeamData"></a> -<div class="evenrow"> +<div class="oddrow"> <div class="method-header"> - <span class="method-title">getArenaTeamData</span> (line <span class="line-number">522</span>) + <span class="method-title">getArenaTeamData</span> (line <span class="line-number">528</span>) </div>  @@ -659,12 +643,20 @@ </ul> + <hr class="separator" /> + <div class="notes">Redefined in descendants as:</div> + <ul class="redefinitions"> + <li> + <a href="../../phpArmory/classes/phpArmory5Cache.html#methodgetArenaTeamData">phpArmory5Cache::getArenaTeamData()</a> + : Provides information on a specific arena team. + </li> + </ul> </div> <a name="methodgetCharacterData" id="getCharacterData"></a> -<div class="oddrow"> +<div class="evenrow"> <div class="method-header"> - <span class="method-title">getCharacterData</span> (line <span class="line-number">543</span>) + <span class="method-title">getCharacterData</span> (line <span class="line-number">549</span>) </div>  @@ -692,12 +684,20 @@ </ul> + <hr class="separator" /> + <div class="notes">Redefined in descendants as:</div> + <ul class="redefinitions"> + <li> + <a href="../../phpArmory/classes/phpArmory5Cache.html#methodgetCharacterData">phpArmory5Cache::getCharacterData()</a> + : Provides information on a specific character. + </li> + </ul> </div> <a name="methodgetCharacterIconURL" id="getCharacterIconURL"></a> -<div class="evenrow"> +<div class="oddrow"> <div class="method-header"> - <span class="method-title">getCharacterIconURL</span> (line <span class="line-number">596</span>) + <span class="method-title">getCharacterIconURL</span> (line <span class="line-number">602</span>) </div>  @@ -724,10 +724,10 @@ </div> <a name="methodgetGuildData" id="getGuildData"></a> -<div class="oddrow"> +<div class="evenrow"> <div class="method-header"> - <span class="method-title">getGuildData</span> (line <span class="line-number">615</span>) + <span class="method-title">getGuildData</span> (line <span class="line-number">621</span>) </div>  @@ -755,12 +755,20 @@ </ul> + <hr class="separator" /> + <div class="notes">Redefined in descendants as:</div> + <ul class="redefinitions"> + <li> + <a href="../../phpArmory/classes/phpArmory5Cache.html#methodgetGuildData">phpArmory5Cache::getGuildData()</a> + : Provides information on a specific guild. + </li> + </ul> </div> <a name="methodgetItemData" id="getItemData"></a> -<div class="evenrow"> +<div class="oddrow"> <div class="method-header"> - <span class="method-title">getItemData</span> (line <span class="line-number">646</span>) + <span class="method-title">getItemData</span> (line <span class="line-number">652</span>) </div>  @@ -785,12 +793,20 @@ </ul> + <hr class="separator" /> + <div class="notes">Redefined in descendants as:</div> + <ul class="redefinitions"> + <li> + <a href="../../phpArmory/classes/phpArmory5Cache.html#methodgetItemData">phpArmory5Cache::getItemData()</a> + : Provides information on a specific item by querying its' ID. + </li> + </ul> </div> <a name="methodgetItemDataByName" id="getItemDataByName"></a> -<div class="oddrow"> +<div class="evenrow"> <div class="method-header"> - <span class="method-title">getItemDataByName</span> (line <span class="line-number">672</span>) + <span class="method-title">getItemDataByName</span> (line <span class="line-number">681</span>) </div>  @@ -821,12 +837,20 @@ </ul> + <hr class="separator" /> + <div class="notes">Redefined in descendants as:</div> + <ul class="redefinitions"> + <li> + <a href="../../phpArmory/classes/phpArmory5Cache.html#methodgetItemDataByName">phpArmory5Cache::getItemDataByName()</a> + : Provides information on a specific item by querying its' name. + </li> + </ul> </div> <a name="methodgetLocale" id="getLocale"></a> -<div class="evenrow"> +<div class="oddrow"> <div class="method-header"> - <span class="method-title">getLocale</span> (line <span class="line-number">210</span>) + <span class="method-title">getLocale</span> (line <span class="line-number">202</span>) </div>  @@ -848,10 +872,10 @@ </div> <a name="methodgetPatchLevel" id="getPatchLevel"></a> -<div class="oddrow"> +<div class="evenrow"> <div class="method-header"> - <span class="method-title">getPatchLevel</span> (line <span class="line-number">461</span>) + <span class="method-title">getPatchLevel</span> (line <span class="line-number">467</span>) </div>  @@ -873,10 +897,10 @@ </div> <a name="methodgetTalentData" id="getTalentData"></a> -<div class="evenrow"> +<div class="oddrow"> <div class="method-header"> - <span class="method-title">getTalentData</span> (line <span class="line-number">492</span>) + <span class="method-title">getTalentData</span> (line <span class="line-number">498</span>) </div>  @@ -898,10 +922,10 @@ </div> <a name="methodgetXmlData" id="getXmlData"></a> -<div class="oddrow"> +<div class="evenrow"> <div class="method-header"> - <span class="method-title">getXmlData</span> (line <span class="line-number">251</span>) + <span class="method-title">getXmlData</span> (line <span class="line-number">243</span>) </div>  @@ -936,10 +960,10 @@ </div> <a name="methodsetArea" id="setArea"></a> -<div class="evenrow"> +<div class="oddrow"> <div class="method-header"> - <span class="method-title">setArea</span> (line <span class="line-number">179</span>) + <span class="method-title">setArea</span> (line <span class="line-number">171</span>) </div>  @@ -966,10 +990,10 @@ </div> <a name="methodsetLocale" id="setLocale"></a> -<div class="oddrow"> +<div class="evenrow"> <div class="method-header"> - <span class="method-title">setLocale</span> (line <span class="line-number">220</span>) + <span class="method-title">setLocale</span> (line <span class="line-number">212</span>) </div>  @@ -996,10 +1020,10 @@ </div> <a name="methodtriggerError" id="triggerError"></a> -<div class="evenrow"> +<div class="oddrow"> <div class="method-header"> - <span class="method-title">triggerError</span> (line <span class="line-number">436</span>) + <span class="method-title">triggerError</span> (line <span class="line-number">428</span>) </div>  @@ -1023,12 +1047,20 @@ </ul> + <hr class="separator" /> + <div class="notes">Redefined in descendants as:</div> + <ul class="redefinitions"> + <li> + <a href="../../phpArmory/classes/phpArmory5Cache.html#methodtriggerError">phpArmory5Cache::triggerError()</a> + : Raise a PHP error. + </li> + </ul> </div> <a name="methodtriggerNotice" id="triggerNotice"></a> -<div class="oddrow"> +<div class="evenrow"> <div class="method-header"> - <span class="method-title">triggerNotice</span> (line <span class="line-number">447</span>) + <span class="method-title">triggerNotice</span> (line <span class="line-number">453</span>) </div>  @@ -1052,6 +1084,51 @@ </ul> + <hr class="separator" /> + <div class="notes">Redefined in descendants as:</div> + <ul class="redefinitions"> + <li> + <a href="../../phpArmory/classes/phpArmory5Cache.html#methodtriggerNotice">phpArmory5Cache::triggerNotice()</a> + : Raise a PHP notice if the class is used from the command line. + </li> + </ul> + </div> +<a name="methodtriggerWarning" id="triggerWarning"></a> +<div class="oddrow"> + + <div class="method-header"> + <span class="method-title">triggerWarning</span> (line <span class="line-number">439</span>) + </div> + +  +<p class="short-description">Raise a PHP warning if the class is used from the command line.</p> + <ul class="tags"> + <li><span class="field">access:</span> protected</li> + </ul> + + <div class="method-signature"> + <span class="method-result">void</span> + <span class="method-name"> + triggerWarning + </span> + ([<span class="var-type">string</span> <span class="var-name">$userWarning</span> = <span class="var-default">NULL</span>]) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">string</span> + <span class="var-name">$userWarning</span><span class="var-description">: The warning string to output.</span> </li> + </ul> + + + <hr class="separator" /> + <div class="notes">Redefined in descendants as:</div> + <ul class="redefinitions"> + <li> + <a href="../../phpArmory/classes/phpArmory5Cache.html#methodtriggerWarning">phpArmory5Cache::triggerWarning()</a> + : Raise a PHP warning if the class is used from the command line. + </li> + </ul> </div> </div> @@ -1059,7 +1136,7 @@ <p class="notes" id="credit"> - Documentation generated on Wed, 19 Nov 2008 21:55:01 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a> + Documentation generated on Thu, 20 Nov 2008 13:43:46 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a> </p> </div></body> </html> \ No newline at end of file doc/phpArmory/classes/phpArmory5.html @@ -16,7 +16,7 @@ <div class="info-box-title">Description</div> <div class="nav-bar"> <span class="disabled">Description</span> | - <a href="#sec-vars">Vars</a> + <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) | <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) </div> @@ -38,29 +38,117 @@ + <a name="sec-var-summary"></a> + <div class="info-box"> + <div class="info-box-title">Variable Summary</span></div> + <div class="nav-bar"> + <a href="#sec-description">Description</a> | + <span class="disabled">Vars</span> (<a href="#sec-vars">details</a>) + | + <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>) + + </div> + <div class="info-box-body"> + <div class="var-summary"> + <div class="var-title"> + <span class="var-type">string</span> + <a href="#$dataPath" title="details" class="var-name">$dataPath</a> + </div> + <div class="var-title"> + <span class="var-type">string</span> + <a href="#$dataStore" title="details" class="var-name">$dataStore</a> + </div> + <div class="var-title"> + <span class="var-type">string</span> + <a href="#$mysqlString" title="details" class="var-name">$mysqlString</a> + </div> + <div class="var-title"> + <span class="var-type">string</span> + <a href="#$mysqlTable" title="details" class="var-name">$mysqlTable</a> + </div> + <div class="var-title"> + <span class="var-type">integer</span> + <a href="#$updateInterval" title="details" class="var-name">$updateInterval</a> + </div> + <div class="var-title"> + <span class="var-type">string</span> + <a href="#$version" title="details" class="var-name">$version</a> + </div> + <div class="var-title"> + <span class="var-type">string</span> + <a href="#$version_state" title="details" class="var-name">$version_state</a> + </div> + </div> + </div> + </div> <a name="sec-method-summary"></a> <div class="info-box"> <div class="info-box-title">Method Summary</span></div> <div class="nav-bar"> <a href="#sec-description">Description</a> | - <a href="#sec-vars">Vars</a> + <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) | <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>) </div> <div class="info-box-body"> <div class="method-summary"> - + <div class="method-definition"> - <span class="method-result">phpArmory5Cache</span> + <span class="method-result">mixed</span> <a href="#__construct" title="details" class="method-name">__construct</a> - () + ([<span class="var-type">string</span> <span class="var-name">$areaName</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$dataStore</span> = <span class="var-default">NULL</span>], [<span class="var-type"></span> <span class="var-name">$dataPath</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$mysqlString</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span> <span class="var-name">$downloadRetries</span> = <span class="var-default">NULL</span>], <span class="var-type">string</span> <span class="var-name">$mysqlTable</span>) + </div> + <div class="method-definition"> + <span class="method-result">array</span> + <a href="#getArenaTeamData" title="details" class="method-name">getArenaTeamData</a> + ([<span class="var-type"></span> <span class="var-name">$arenaTeamName</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$realmName</span> = <span class="var-default">NULL</span>], <span class="var-type">string</span> <span class="var-name">$arenaName</span>) + </div> + <div class="method-definition"> + <span class="method-result">mixed</span> + <a href="#getCachedData" title="details" class="method-name">getCachedData</a> + (<span class="var-type">string</span> <span class="var-name">$cacheID</span>) + </div> + <div class="method-definition"> + <span class="method-result">array</span> + <a href="#getCharacterData" title="details" class="method-name">getCharacterData</a> + ([<span class="var-type">string</span> <span class="var-name">$characterName</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$realmName</span> = <span class="var-default">NULL</span>]) + </div> + <div class="method-definition"> + <span class="method-result">array</span> + <a href="#getGuildData" title="details" class="method-name">getGuildData</a> + ([<span class="var-type">string</span> <span class="var-name">$guildName</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$realmName</span> = <span class="var-default">NULL</span>]) + </div> + <div class="method-definition"> + <span class="method-result">array</span> + <a href="#getItemData" title="details" class="method-name">getItemData</a> + (<span class="var-type">int</span> <span class="var-name">$itemID</span>) + </div> + <div class="method-definition"> + <span class="method-result">mixed</span> + <a href="#getItemDataByName" title="details" class="method-name">getItemDataByName</a> + (<span class="var-type">string</span> <span class="var-name">$itemName</span>, [<span class="var-type"></span> <span class="var-name">$filter</span> = <span class="var-default">NULL</span>], <span class="var-type">string</span> <span class="var-name">$itemFilter</span>) + </div> + <div class="method-definition"> + <span class="method-result">bool</span> + <a href="#setCachedData" title="details" class="method-name">setCachedData</a> + (<span class="var-type">string</span> <span class="var-name">$cacheID</span>, <span class="var-type">string</span> <span class="var-name">$xml</span>) + </div> + <div class="method-definition"> + <span class="method-result">void</span> + <a href="#triggerError" title="details" class="method-name">triggerError</a> + ([<span class="var-type">string</span> <span class="var-name">$userError</span> = <span class="var-default">NULL</span>]) </div> <div class="method-definition"> <span class="method-result">void</span> - <a href="#__destruct" title="details" class="method-name">__destruct</a> - () + <a href="#triggerNotice" title="details" class="method-name">triggerNotice</a> + ([<span class="var-type">string</span> <span class="var-name">$userNotice</span> = <span class="var-default">NULL</span>]) + </div> + <div class="method-definition"> + <span class="method-result">void</span> + <a href="#triggerWarning" title="details" class="method-name">triggerWarning</a> + ([<span class="var-type">string</span> <span class="var-name">$userWarning</span> = <span class="var-default">NULL</span>]) </div> </div> </div> @@ -79,7 +167,180 @@ </div> <div class="info-box-body"> - <h4>Inherited Variables</h4> + <a name="var$dataPath" id="$dataPath"></A> +<div class="evenrow"> + + <div class="var-header"> + <span class="var-title"> + <span class="var-type">string</span> + <span class="var-name">$dataPath</span> + = <span class="var-default"> "./cache"</span> (line <span class="line-number">58</span>) + </span> + </div> + +  +<p class="short-description">The path to the cache directory (must chmod 777 to make it writeable).</p> + <ul class="tags"> + <li><span class="field">var:</span> Contains the path where to store cache files.</li> + <li><span class="field">access:</span> protected</li> + </ul> + + + + + +</div> +<a name="var$dataStore" id="$dataStore"></A> +<div class="oddrow"> + + <div class="var-header"> + <span class="var-title"> + <span class="var-type">string</span> + <span class="var-name">$dataStore</span> + = <span class="var-default"> "file"</span> (line <span class="line-number">51</span>) + </span> + </div> + +  +<p class="short-description">Selected data storage for the class. Can be "file" or "mysql".</p> + <ul class="tags"> + <li><span class="field">var:</span> Contains the selected data storage.</li> + <li><span class="field">access:</span> protected</li> + </ul> + + + + + +</div> +<a name="var$mysqlString" id="$mysqlString"></A> +<div class="evenrow"> + + <div class="var-header"> + <span class="var-title"> + <span class="var-type">string</span> + <span class="var-name">$mysqlString</span> + = <span class="var-default"> "mysql://username:password@localhost/databasename"</span> (line <span class="line-number">65</span>) + </span> + </div> + +  +<p class="short-description">MySQL connection string.</p> + <ul class="tags"> + <li><span class="field">var:</span> Contains the MySQL connection string.</li> + <li><span class="field">access:</span> protected</li> + </ul> + + + + + +</div> +<a name="var$mysqlTable" id="$mysqlTable"></A> +<div class="oddrow"> + + <div class="var-header"> + <span class="var-title"> + <span class="var-type">string</span> + <span class="var-name">$mysqlTable</span> + = <span class="var-default"> "armory_cache"</span> (line <span class="line-number">72</span>) + </span> + </div> + +  +<p class="short-description">MySQL cache table.</p> + <ul class="tags"> + <li><span class="field">var:</span> Contains the MySQL cache table.</li> + <li><span class="field">access:</span> protected</li> + </ul> + + + + + +</div> +<a name="var$updateInterval" id="$updateInterval"></A> +<div class="evenrow"> + + <div class="var-header"> + <span class="var-title"> + <span class="var-type">integer</span> + <span class="var-name">$updateInterval</span> + = <span class="var-default"> 14400</span> (line <span class="line-number">79</span>) + </span> + </div> + +  +<p class="short-description">The time between cache updates in seconds</p> + <ul class="tags"> + <li><span class="field">var:</span> Contains the time delay between updates in seconds. Default is 4 hours.</li> + <li><span class="field">access:</span> protected</li> + </ul> + + + + + +</div> +<a name="var$version" id="$version"></A> +<div class="oddrow"> + + <div class="var-header"> + <span class="var-title"> + <span class="var-type">string</span> + <span class="var-name">$version</span> + = <span class="var-default"> "0.4.0"</span> (line <span class="line-number">36</span>) + </span> + </div> + +  +<p class="short-description">Current version of the phpArmory5Cache class.</p> + <ul class="tags"> + <li><span class="field">var:</span> Contains the current class version.</li> + <li><span class="field">access:</span> protected</li> + </ul> + + + <hr class="separator" /> + <div class="notes">Redefinition of:</div> + <dl> + <dt><a href="../../phpArmory/classes/phpArmory5.html#var$version">phpArmory5::$version</a></dt> + <dd>Current version of the phpArmory5 class.</dd> + </dl> + + + +</div> +<a name="var$version_state" id="$version_state"></A> +<div class="evenrow"> + + <div class="var-header"> + <span class="var-title"> + <span class="var-type">string</span> + <span class="var-name">$version_state</span> + = <span class="var-default"> "rc-2"</span> (line <span class="line-number">44</span>) + </span> + </div> + +  +<p class="short-description">Current state of the phpArmory5Cache class. Allowed values are alpha, beta, and release.</p> + <ul class="tags"> + <li><span class="field">var:</span> Contains the current versions' state.</li> + <li><span class="field">access:</span> protected</li> + </ul> + + + <hr class="separator" /> + <div class="notes">Redefinition of:</div> + <dl> + <dt><a href="../../phpArmory/classes/phpArmory5.html#var$version_state">phpArmory5::$version_state</a></dt> + <dd>Current state of the phpArmory5 class. Allowed values are alpha, beta, and release.</dd> + </dl> + + + +</div> + <h4>Inherited Variables</h4> <A NAME='inherited_vars'></A> <p>Inherited from <span class="classname"><a href="../../phpArmory/classes/phpArmory5.html">phpArmory5</a></span></p> <blockquote> @@ -117,7 +378,7 @@ <div class="info-box-title">Methods</div> <div class="nav-bar"> <a href="#sec-description">Description</a> | - <a href="#sec-vars">Vars</a> + <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>) <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>) </div> @@ -125,27 +386,47 @@ <A NAME='method_detail'></A> <a name="method__construct" id="__construct"></a> -<div class="evenrow"> +<div class="oddrow"> <div class="method-header"> - <span class="method-title">Constructor __construct</span> (line <span class="line-number">64</span>) + <span class="method-title">Constructor __construct</span> (line <span class="line-number">91</span>) </div>  <p class="short-description">phpArmory5Cache class constructor.</p> <ul class="tags"> - <li><span class="field">todo:</span> IMPLEMENTATION MISSING.</li> + <li><span class="field">return:</span> Returns TRUE if the class could be instantiated properly. Returns FALSE and an error string, if the class could not be instantiated.</li> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> - <span class="method-result">phpArmory5Cache</span> + <span class="method-result">mixed</span> <span class="method-name"> __construct </span> - () + ([<span class="var-type">string</span> <span class="var-name">$areaName</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$dataStore</span> = <span class="var-default">NULL</span>], [<span class="var-type"></span> <span class="var-name">$dataPath</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$mysqlString</span> = <span class="var-default">NULL</span>], [<span class="var-type">int</span> <span class="var-name">$downloadRetries</span> = <span class="var-default">NULL</span>], <span class="var-type">string</span> <span class="var-name">$mysqlTable</span>) </div> + <ul class="parameters"> + <li> + <span class="var-type">string</span> + <span class="var-name">$areaName</span> </li> + <li> + <span class="var-type">string</span> + <span class="var-name">$dataStore</span> </li> + <li> + <span class="var-type">string</span> + <span class="var-name">$mysqlString</span> </li> + <li> + <span class="var-type">string</span> + <span class="var-name">$mysqlTable</span> </li> + <li> + <span class="var-type">int</span> + <span class="var-name">$downloadRetries</span> </li> + <li> + <span class="var-type"></span> + <span class="var-name">$dataPath</span> </li> + </ul> <hr class="separator" /> <div class="notes">Redefinition of:</div> @@ -155,34 +436,369 @@ </dl> </div> -<a name="method__destruct" id="__destruct"></a> +<a name="methodgetArenaTeamData" id="getArenaTeamData"></a> +<div class="evenrow"> + + <div class="method-header"> + <span class="method-title">getArenaTeamData</span> (line <span class="line-number">274</span>) + </div> + +  +<p class="short-description">Provides information on a specific arena team.</p> + <ul class="tags"> + <li><span class="field">return:</span> Returns an array containing arenaTeamData if $arenaTeamName and $realmName are valid, otherwise FALSE.</li> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + <span class="method-result">array</span> + <span class="method-name"> + getArenaTeamData + </span> + ([<span class="var-type"></span> <span class="var-name">$arenaTeamName</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$realmName</span> = <span class="var-default">NULL</span>], <span class="var-type">string</span> <span class="var-name">$arenaName</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">string</span> + <span class="var-name">$arenaName</span><span class="var-description">: The arena teams' name.</span> </li> + <li> + <span class="var-type">string</span> + <span class="var-name">$realmName</span><span class="var-description">: The arena teams' realm name.</span> </li> + <li> + <span class="var-type"></span> + <span class="var-name">$arenaTeamName</span> </li> + </ul> + + <hr class="separator" /> + <div class="notes">Redefinition of:</div> + <dl> + <dt><a href="../../phpArmory/classes/phpArmory5.html#methodgetArenaTeamData">phpArmory5::getArenaTeamData()</a></dt> + <dd>Provides information on a specific arena team.</dd> + </dl> + + </div> +<a name="methodgetCachedData" id="getCachedData"></a> +<div class="oddrow"> + + <div class="method-header"> + <span class="method-title">getCachedData</span> (line <span class="line-number">197</span>) + </div> + +  +<p class="short-description">Retrieve cached data.</p> + <ul class="tags"> + <li><span class="field">return:</span> Returns a string containg the cached XML data, or FALSE if there is no cached data.</li> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + <span class="method-result">mixed</span> + <span class="method-name"> + getCachedData + </span> + (<span class="var-type">string</span> <span class="var-name">$cacheID</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">string</span> + <span class="var-name">$cacheID</span><span class="var-description">: The unique ID of the retrieved data.</span> </li> + </ul> + + + </div> +<a name="methodgetCharacterData" id="getCharacterData"></a> +<div class="evenrow"> + + <div class="method-header"> + <span class="method-title">getCharacterData</span> (line <span class="line-number">305</span>) + </div> + +  +<p class="short-description">Provides information on a specific character.</p> + <ul class="tags"> + <li><span class="field">return:</span> Returns an array containing characterData if $characterName and $realmName are valid, otherwise FALSE.</li> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + <span class="method-result">array</span> + <span class="method-name"> + getCharacterData + </span> + ([<span class="var-type">string</span> <span class="var-name">$characterName</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$realmName</span> = <span class="var-default">NULL</span>]) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">string</span> + <span class="var-name">$characterName</span><span class="var-description">: The characters' name.</span> </li> + <li> + <span class="var-type">string</span> + <span class="var-name">$realmName</span><span class="var-description">: The characters' realm name.</span> </li> + </ul> + + <hr class="separator" /> + <div class="notes">Redefinition of:</div> + <dl> + <dt><a href="../../phpArmory/classes/phpArmory5.html#methodgetCharacterData">phpArmory5::getCharacterData()</a></dt> + <dd>Provides information on a specific character.</dd> + </dl> + + </div> +<a name="methodgetGuildData" id="getGuildData"></a> +<div class="oddrow"> + + <div class="method-header"> + <span class="method-title">getGuildData</span> (line <span class="line-number">336</span>) + </div> + +  +<p class="short-description">Provides information on a specific guild.</p> + <ul class="tags"> + <li><span class="field">return:</span> Returns an array containing guildData if $guildName and $realmName are valid, otherwise FALSE.</li> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + <span class="method-result">array</span> + <span class="method-name"> + getGuildData + </span> + ([<span class="var-type">string</span> <span class="var-name">$guildName</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span> <span class="var-name">$realmName</span> = <span class="var-default">NULL</span>]) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">string</span> + <span class="var-name">$guildName</span><span class="var-description">: The guilds' name.</span> </li> + <li> + <span class="var-type">string</span> + <span class="var-name">$realmName</span><span class="var-description">: The guilds' realm name.</span> </li> + </ul> + + <hr class="separator" /> + <div class="notes">Redefinition of:</div> + <dl> + <dt><a href="../../phpArmory/classes/phpArmory5.html#methodgetGuildData">phpArmory5::getGuildData()</a></dt> + <dd>Provides information on a specific guild.</dd> + </dl> + + </div> +<a name="methodgetItemData" id="getItemData"></a> +<div class="evenrow"> + + <div class="method-header"> + <span class="method-title">getItemData</span> (line <span class="line-number">364</span>) + </div> + +  +<p class="short-description">Provides information on a specific item by querying its' ID.</p> + <ul class="tags"> + <li><span class="field">return:</span> Returns an array containing itemData if $itemID is valid, otherwise FALSE.</li> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + <span class="method-result">array</span> + <span class="method-name"> + getItemData + </span> + (<span class="var-type">int</span> <span class="var-name">$itemID</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">int</span> + <span class="var-name">$itemID</span><span class="var-description">: The items' ID.</span> </li> + </ul> + + <hr class="separator" /> + <div class="notes">Redefinition of:</div> + <dl> + <dt><a href="../../phpArmory/classes/phpArmory5.html#methodgetItemData">phpArmory5::getItemData()</a></dt> + <dd>Provides information on a specific item by querying its' ID.</dd> + </dl> + + </div> +<a name="methodgetItemDataByName" id="getItemDataByName"></a> <div class="oddrow"> <div class="method-header"> - <span class="method-title">Destructor __destruct</span> (line <span class="line-number">72</span>) + <span class="method-title">getItemDataByName</span> (line <span class="line-number">394</span>) </div>  -<p class="short-description">phpArmory5Cache destructor.</p> +<p class="short-description">Provides information on a specific item by querying its' name.</p> <ul class="tags"> - <li><span class="field">todo:</span> IMPLEMENTATION MISSING.</li> + <li><span class="field">return:</span> Returns an array containing itemData if $itemName is valid, otherwise FALSE.</li> <li><span class="field">access:</span> public</li> </ul> <div class="method-signature"> + <span class="method-result">mixed</span> + <span class="method-name"> + getItemDataByName + </span> + (<span class="var-type">string</span> <span class="var-name">$itemName</span>, [<span class="var-type"></span> <span class="var-name">$filter</span> = <span class="var-default">NULL</span>], <span class="var-type">string</span> <span class="var-name">$itemFilter</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">string</span> + <span class="var-name">$itemName</span><span class="var-description">: The items' name.</span> </li> + <li> + <span class="var-type">string</span> + <span class="var-name">$itemFilter</span><span class="var-description">: An associative array of search paramters.</span> </li> + <li> + <span class="var-type"></span> + <span class="var-name">$filter</span> </li> + </ul> + + <hr class="separator" /> + <div class="notes">Redefinition of:</div> + <dl> + <dt><a href="../../phpArmory/classes/phpArmory5.html#methodgetItemDataByName">phpArmory5::getItemDataByName()</a></dt> + <dd>Provides information on a specific item by querying its' name.</dd> + </dl> + + </div> +<a name="methodsetCachedData" id="setCachedData"></a> +<div class="evenrow"> + + <div class="method-header"> + <span class="method-title">setCachedData</span> (line <span class="line-number">243</span>) + </div> + +  +<p class="short-description">Saved retrieved data to cache.</p> + <ul class="tags"> + <li><span class="field">return:</span> Returns TRUE if $xml could be cached, and FALSE if it failed to be saved.</li> + <li><span class="field">access:</span> public</li> + </ul> + + <div class="method-signature"> + <span class="method-result">bool</span> + <span class="method-name"> + setCachedData + </span> + (<span class="var-type">string</span> <span class="var-name">$cacheID</span>, <span class="var-type">string</span> <span class="var-name">$xml</span>) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">string</span> + <span class="var-name">$cacheID</span><span class="var-description">: The unique ID of the retrieved data.</span> </li> + <li> + <span class="var-type">string</span> + <span class="var-name">$xml</span><span class="var-description">: The retrieved XML data to store.</span> </li> + </ul> + + + </div> +<a name="methodtriggerError" id="triggerError"></a> +<div class="oddrow"> + + <div class="method-header"> + <span class="method-title">triggerError</span> (line <span class="line-number">157</span>) + </div> + +  +<p class="short-description">Raise a PHP error.</p> + <ul class="tags"> + <li><span class="field">access:</span> protected</li> + </ul> + + <div class="method-signature"> + <span class="method-result">void</span> + <span class="method-name"> + triggerError + </span> + ([<span class="var-type">string</span> <span class="var-name">$userError</span> = <span class="var-default">NULL</span>]) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">string</span> + <span class="var-name">$userError</span><span class="var-description">: The error string to output.</span> </li> + </ul> + + <hr class="separator" /> + <div class="notes">Redefinition of:</div> + <dl> + <dt><a href="../../phpArmory/classes/phpArmory5.html#methodtriggerError">phpArmory5::triggerError()</a></dt> + <dd>Raise a PHP error.</dd> + </dl> + + </div> +<a name="methodtriggerNotice" id="triggerNotice"></a> +<div class="evenrow"> + + <div class="method-header"> + <span class="method-title">triggerNotice</span> (line <span class="line-number">182</span>) + </div> + +  +<p class="short-description">Raise a PHP notice if the class is used from the command line.</p> + <ul class="tags"> + <li><span class="field">access:</span> protected</li> + </ul> + + <div class="method-signature"> + <span class="method-result">void</span> + <span class="method-name"> + triggerNotice + </span> + ([<span class="var-type">string</span> <span class="var-name">$userNotice</span> = <span class="var-default">NULL</span>]) + </div> + + <ul class="parameters"> + <li> + <span class="var-type">string</span> + <span class="var-name">$userNotice</span><span class="var-description">: The notice string to output.</span> </li> + </ul> + + <hr class="separator" /> + <div class="notes">Redefinition of:</div> + <dl> + <dt><a href="../../phpArmory/classes/phpArmory5.html#methodtriggerNotice">phpArmory5::triggerNotice()</a></dt> + <dd>Raise a PHP notice if the class is used from the command line.</dd> + </dl> + + </div> +<a name="methodtriggerWarning" id="triggerWarning"></a> +<div class="oddrow"> + + <div class="method-header"> + <span class="method-title">triggerWarning</span> (line <span class="line-number">168</span>) + </div> + +  +<p class="short-description">Raise a PHP warning if the class is used from the command line.</p> + <ul class="tags"> + <li><span class="field">access:</span> protected</li> + </ul> + + <div class="method-signature"> <span class="method-result">void</span> <span class="method-name"> - __destruct + triggerWarning </span> - () + ([<span class="var-type">string</span> <span class="var-name">$userWarning</span> = <span class="var-default">NULL</span>]) </div> + <ul class="parameters"> + <li> + <span class="var-type">string</span> + <span class="var-name">$userWarning</span><span class="var-description">: The warning string to output.</span> </li> + </ul> <hr class="separator" /> <div class="notes">Redefinition of:</div> <dl> - <dt><a href="../../phpArmory/classes/phpArmory5.html#method__destruct">phpArmory5::__destruct()</a></dt> - <dd>phpArmory5 destructor.</dd> + <dt><a href="../../phpArmory/classes/phpArmory5.html#methodtriggerWarning">phpArmory5::triggerWarning()</a></dt> + <dd>Raise a PHP warning if the class is used from the command line.</dd> </dl> </div> @@ -208,7 +824,7 @@ <span class="method-name"><a href="../../phpArmory/classes/phpArmory5.html#methodsetLocale">phpArmory5::setLocale()</a></span><br> <span class="method-name"><a href="../../phpArmory/classes/phpArmory5.html#methodtriggerError">phpArmory5::triggerError()</a></span><br> <span class="method-name"><a href="../../phpArmory/classes/phpArmory5.html#methodtriggerNotice">phpArmory5::triggerNotice()</a></span><br> - <span class="method-name"><a href="../../phpArmory/classes/phpArmory5.html#method__destruct">phpArmory5::__destruct()</a></span><br> + <span class="method-name"><a href="../../phpArmory/classes/phpArmory5.html#methodtriggerWarning">phpArmory5::triggerWarning()</a></span><br> </blockquote> </div> @@ -216,7 +832,7 @@ <p class="notes" id="credit"> - Documentation generated on Wed, 19 Nov 2008 21:55:02 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a> + Documentation generated on Thu, 20 Nov 2008 13:43:46 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a> </p> </div></body> </html> \ No newline at end of file doc/phpArmory/classes/phpArmory5Cache.html @@ -14,16 +14,8 @@ <ul> <li>IMPLEMENTATION MISSING.</li> </ul> -<h3><a href="phpArmory/classes/phpArmory5Cache.html#method__construct">phpArmory5Cache::__construct()</a></h3> -<ul> - <li>IMPLEMENTATION MISSING.</li> -</ul> -<h3><a href="phpArmory/classes/phpArmory5Cache.html#method__destruct">phpArmory5Cache::__destruct()</a></h3> -<ul> - <li>IMPLEMENTATION MISSING.</li> -</ul> <p class="notes" id="credit"> - Documentation generated on Wed, 19 Nov 2008 21:55:02 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a> + Documentation generated on Thu, 20 Nov 2008 13:43:46 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a> </p> </body> </html> \ No newline at end of file doc/todolist.html @@ -48,8 +48,6 @@ if ( $armory = new phpArmory5($areaName = $usArea) ) { $characterIcon = $armory->getCharacterIconURL($characterData['characterinfo']['character']); - var_dump($characterIcon); - $guildData = $armory->getGuildData($guildName, $guildRealmName); } } else { examples/test.php5 @@ -154,14 +154,6 @@ class phpArmory5 { } /** - * phpArmory5 destructor. - * @access public - */ - public function __destruct() { - - } - - /** * Provides information on the current area configuration of phpArmory. * @access public * @return array $areaSettings Returns an array with $this->areaName, $this->armory, and $this->wow. phpArmory.class.php @@ -16,7 +16,7 @@ /** * phpArmory5Cache extends phpArmory5, thus we require the base class file. */ -require_once('phpArmory5.class.php'); +require_once('phpArmory.class.php'); /** * phpArmory5Cache class @@ -30,46 +30,392 @@ class phpArmory5Cache extends phpArmory5 { /** * Current version of the phpArmory5Cache class. - * @access private + * @access protected * @var string Contains the current class version. */ - private static $version = '0.4.0'; + protected $version = "0.4.0"; /** * Current state of the phpArmory5Cache class. Allowed values are alpha, beta, * and release. - * @access private + * @access protected * @var string Contains the current versions' state. */ - private static $version_state = 'alpha'; + protected $version_state = "rc-2"; /** - * - * @access private - * @var string + * Selected data storage for the class. Can be "file" or "mysql". + * @access protected + * @var string Contains the selected data storage. */ - private $ = ""; + protected $dataStore = "file"; /** - * - * @access private - * @var integer + * The path to the cache directory (must chmod 777 to make it writeable). + * @access protected + * @var string Contains the path where to store cache files. */ - private $ = 0; + protected $dataPath = "./cache"; + + /** + * MySQL connection string. + * @access protected + * @var string Contains the MySQL connection string. + */ + protected $mysqlString = "mysql://username:password@localhost/databasename"; + + /** + * MySQL cache table. + * @access protected + * @var string Contains the MySQL cache table. + */ + protected $mysqlTable = "armory_cache"; + + /** + * The time between cache updates in seconds + * @access protected + * @var integer Contains the time delay between updates in seconds. Default is 4 hours. + */ + protected $updateInterval = 14400; /** * phpArmory5Cache class constructor. - * @todo IMPLEMENTATION MISSING. + * @access public + * @param string $areaName + * @param string $dataStore + * @param string $mysqlString + * @param string $mysqlTable + * @param int $downloadRetries + * @return mixed $result Returns TRUE if the class could be instantiated properly. Returns FALSE and an error string, if the class could not be instantiated. + */ + public function __construct($areaName = NULL, $dataStore = NULL, $dataPath = NULL, $mysqlString = NULL, $downloadRetries = NULL) { + + parent::__construct($areaName, $downloadRetries); + + if(($dataStore==NULL)&&($this->dataStore)){ + $dataStore = $this->dataStore; + } else { + $this->dataStore = $dataStore; + } + + if(($mysqlString==NULL)&&($this->mysqlString)){ + $mysqlString = $this->mysqlString; + } else { + $this->mysqlString = $mysqlString; + } + + if(($mysqlTable==NULL)&&($this->mysqlTable)){ + $mysqlTable = $this->mysqlTable; + } else { + $this->mysqlTable = $mysqlTable; + } + + switch($this->dataStore) { + + case 'file': + if(($dataPath==NULL)&&($this->dataPath)){ + $dataPath = $this->dataPath; + } else { + $this->dataPath = $dataPath; + } + break; + case 'mysql': + if (!extension_loaded('mysql') || !extension_loaded('mysqli')) { + self::triggerError("Either PHP extension \"mysql\" or \"mysqli\" extension is required to use this class."); + } else { + if(($dataPath==NULL)&&($this->mysqlTable)){ + $dataPath = $this->mysqlTable; + } else { + $this->mysqlTable = $dataPath; + } + $conn = @parse_url($this->mysqlString); + $this->mysqlString = mysql_connect($conn['host'], $conn['user'], $conn['pass']) or die("Failed to connect to database"); + mysql_select_db(str_replace('/', '', $conn['path']), $this->mysqlString) or die("Unable to select database table"); + $query = "CREATE TABLE IF NOT EXISTS `".$this->mysqlTable."` ( + `cache_id` VARCHAR(100) NOT NULL DEFAULT '', + `cache_time` TIMESTAMP NULL DEFAULT CURRENT_TIMESTAMP, + `cache_xml` TEXT, + PRIMARY KEY `cache_id` (`cache_id`))"; + mysql_query($query, $this->mysqlString) or self::triggerError("Unable to create the cache table"); + } + break; + default: + die("Invalid dataStore defined."); + break; + + } + + parent::setArea($areaName); + + } + + /** + * Raise a PHP error. + * @access protected + * @param string $userError The error string to output. + */ + protected function triggerError ($userError = NULL) { + if (is_string($userError)) { + trigger_error("phpArmoryCache " . $this->version . " - " . $this->version_state . ": " . $userError, E_USER_ERROR); + } + } + + /** + * Raise a PHP warning if the class is used from the command line. + * @access protected + * @param string $userWarning The warning string to output. + */ + protected function triggerWarning ($userWarning = NULL) { + if (is_string($userWarning)) { + $sapi_type = substr(php_sapi_name(), 0, 3); + if ($sapi_type == 'cli') { + trigger_error("phpArmoryCache " . $this->version . " - " . $this->version_state . ": " . $userWarning, E_USER_WARNING); + } + } + } + + /** + * Raise a PHP notice if the class is used from the command line. + * @access protected + * @param string $userNotice The notice string to output. + */ + protected function triggerNotice ($userNotice = NULL) { + if (is_string($userNotice)) { + $sapi_type = substr(php_sapi_name(), 0, 3); + if ($sapi_type == 'cli') { + trigger_error("phpArmoryCache " . $this->version . " - " . $this->version_state . ": " . $userNotice, E_USER_NOTICE); + } + } + } + + /** + * Retrieve cached data. + * @access public + * @param string $cacheID The unique ID of the retrieved data. + * @return mixed $result Returns a string containg the cached XML data, or FALSE if there is no cached data. + */ + public function getCachedData($cacheID) { + + switch($this->dataStore) { + + case "file": + $filename = $this->dataPath."/".$cacheID; + if (file_exists($filename)) { + if (time()-filemtime($filename) > $this->updateInterval) { + // Cache is out of date, remove the old file + self::triggerNotice("Cached file data for " . $cacheID . " is outdated."); + @unlink($filename); + } else { + // Return the cached XML as an array + $array = unserialize(file_get_contents($filename)); + self::triggerNotice("Cached file data for " . $cacheID . " is valid."); + return $array; + } + } + break; + case "mysql": + $query = "SELECT cache_xml, UNIX_TIMESTAMP(cache_time) AS cache_time FROM `".$this->mysqlTable."` WHERE cache_id = '".$cacheID."'"; + $result = mysql_query($query, $this->mysqlString) or self::triggerError("Unable to select cache from database"); + if ($result && mysql_num_rows($result)) { + if (time()-mysql_result($result, 0, 'cache_time') > $this->updateInterval) { + $query = "DELETE FROM `".$this->mysqlTable."` WHERE cache_id = '".$cacheID."'"; + mysql_query($query, $this->mysqlString); + self::triggerNotice("Cached mysql data for " . $cacheID . " is outdated."); + } else { + // Return the cached XML as an array + self::triggerNotice("Cached mysql data for " . $cacheID . " is valid."); + return parent::convertXmlToArray(mysql_result($result, 0, 'cache_xml')); + } + } + break; + + } + + } + + /** + * Saved retrieved data to cache. + * @access public + * @param string $cacheID The unique ID of the retrieved data. + * @param string $xml The retrieved XML data to store. + * @return bool $result Returns TRUE if $xml could be cached, and FALSE if it failed to be saved. + */ + public function setCachedData($cacheID, $xml) { + + switch($this->dataStore){ + + case "file": + $filename = $this->dataPath."/".$cacheID; + $handle = fopen($filename, 'w') or self::triggerError("Can not open file (" . $filename . ")"); + fwrite($handle, $xml) or self::triggerError("Can not write to file (" . $filename . ")"); + self::triggerNotice("Successfully cached " . $cacheID . " in file mode."); + fclose($handle); + break; + + case "mysql": + if (get_magic_quotes_gpc()) $xml = stripslashes($xml); + $xml = mysql_escape_string($xml); + $query = "REPLACE INTO `".$this->mysqlTable."` (cache_id, cache_xml) VALUES('".$cacheID."','".$xml."')"; + mysql_query($query, $this->mysqlString) or self::triggerError("Unable to save to database " . mysql_error()); + self::triggerNotice("Successfully cached " . $cacheID . " in mysql mode."); + break; + + } + + } + + /** + * Provides information on a specific arena team. + * @access public + * @param string $arenaName The arena teams' name. + * @param string $realmName The arena teams' realm name. + * @return array $result Returns an array containing arenaTeamData if $arenaTeamName and $realmName are valid, otherwise FALSE. */ - public function __construct() { + public function getArenaTeamData($arenaTeamName = NULL, $realmName = NULL) { + + $this->cacheID = "a".md5($arenaTeamName.$realmName); + $cached = $this->getCachedData($this->cacheID); + + if (!is_array($cached)) { + $cached = parent::getArenaTeamData($arenaTeamName, $realmName); + + if ( $this->cacheID ) { + + $scached = serialize($cached); + $this->setCachedData($this->cacheID, $scached); + unset($this->cacheID); + + } + + return $cached; + + } else { + return $cached; + } } /** - * phpArmory5Cache destructor. - * @todo IMPLEMENTATION MISSING. + * Provides information on a specific character. + * @access public + * @param string $characterName The characters' name. + * @param string $realmName The characters' realm name. + * @return array $result Returns an array containing characterData if $characterName and $realmName are valid, otherwise FALSE. */ - public function __destruct() { + public function getCharacterData($characterName = NULL, $realmName = NULL) { + + $this->cacheID = "c".md5($characterName.$realmName); + $cached = $this->getCachedData($this->cacheID); + + if (!is_array($cached)) { + $cached = parent::getCharacterData($characterName, $realmName); + + if ( $this->cacheID ) { + + $scached = serialize($cached); + $this->setCachedData($this->cacheID, $scached); + unset($this->cacheID); + + } + + return $cached; + + } else { + return $cached; + } + + } + + /** + * Provides information on a specific guild. + * @access public + * @param string $guildName The guilds' name. + * @param string $realmName The guilds' realm name. + * @return array $result Returns an array containing guildData if $guildName and $realmName are valid, otherwise FALSE. + */ + public function getGuildData($guildName = NULL, $realmName = NULL) { + + $this->cacheID = "g".md5($guildName.$realmName); + $cached = $this->getCachedData($this->cacheID); + + if (!is_array($cached)) { + $cached = parent::getGuildData($guildName, $realmName); + + if ( $this->cacheID ) { + + $scached = serialize($cached); + $this->setCachedData($this->cacheID, $scached); + unset($this->cacheID); + + } + + return $cached; + } else { + return $cached; + } + + } + /** + * Provides information on a specific item by querying its' ID. + * @access public + * @param int $itemID The items' ID. + * @return array $result Returns an array containing itemData if $itemID is valid, otherwise FALSE. + */ + public function getItemData($itemID) { + + $this->cacheID = "i".md5($itemID); + $cached = $this->getCachedData($this->cacheID); + + if (!is_array($cached)) { + $cached = parent::getItemData($itemID); + + if ( $this->cacheID ) { + + $scached = serialize($cached); + $this->setCachedData($this->cacheID, $scached); + unset($this->cacheID); + + } + + return $cached; + } else { + return $cached; + } + + } + + /** + * Provides information on a specific item by querying its' name. + * @access public + * @param string $itemName The items' name. + * @param string $itemFilter An associative array of search paramters. + * @return mixed $result Returns an array containing itemData if $itemName is valid, otherwise FALSE. + */ + public function getItemDataByName($itemName, $filter = NULL) { + + if ($filter&&is_array($filter)) { + $this->cacheID = "s".md5($itemName.implode('', $filter)); + } else { + $this->cacheID = "s".md5($itemName); + } + + $cached = $this->getCachedData($this->cacheID); + + if (!is_array($cached)) { + $cached = parent::getItemDataByName($itemName, $filter); + + if ( $this->cacheID ) { + + $scached = serialize($cached); + $this->setCachedData($this->cacheID, $scached); + unset($this->cacheID); + + } + + return $cached; + } else { + return $cached; + } } phpArmoryCache.class.php 08a281e1458383e4b6e76a0e0f8fe8ca29e25592 Daniel S. Reichenbach shiendra@marenkay.com http://github.com/marenkay/phparmory/commit/c371a02bf56e8c116094ef1b7f045040208bf83e c371a02bf56e8c116094ef1b7f045040208bf83e

2008-11-20T04:49:14-08:00

A few more changes to make file and mysql cache work. Release 0.4.0 = soon(tm). 8b2665f1225d406e9e9c9d1e3344b8c7f3124add Daniel S. Reichenbach shiendra@marenkay.com