phparmory @@ -58,21 +58,14 @@ if (!class_exists("WordPressArmoryCache")) { */ var $cacheID = 0; - /**#@-*/ /** - * The Constructor - * - * This function is called when the object is created. It has - * three optional parameters. The first sets the base url of - * the Armory website that will be used to fetch the serialized - * XML data. The second sets whether data will be stored in - * flat files or a mysql database. The third indicates how - * long a cached XML query should be kept before updating. - * - * @param string $armoryArea URL of the Armory website - * @param integer $retries Time (in seconds) between cache updates - */ - function __construct($areaName = NULL, $downloadRetries = NULL) { + * WordPressArmoryCache class constructor. + * @access public + * @param string $areaName + * @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, $downloadRetries = NULL) { global $wpdb; @@ -109,18 +102,17 @@ if (!class_exists("WordPressArmoryCache")) { * @return string[] An associative array * @param string $character The name of the character * @param string $realm The character's realm - * @author Claire Matthews <poeticdragon@stormblaze.net> */ - function getCharacterData($characterName = NULL, $realmName = NULL) { + public function getCharacterData($characterName = NULL, $realmName = NULL) { - if(($character==NULL)&&($this->character)) $character = $this->character; - if(($realm==NULL)&&($this->realm)) $realm = $this->realm; + if(($characterName==NULL)&&($this->characterName)) $characterName = $this->characterName; + if(($realmName==NULL)&&($this->realmName)) $realmName = $this->realmName; - $this->cacheID = "c".md5($character.$realm); + $this->cacheID = "c".md5($characterName.$realmName); $cached = $this->cacheFetch($this->cacheID); if (!is_array($cached)) { - $cached = parent::getCharacterData($character, $realm); + $cached = parent::getCharacterData($characterName, $realmName); if ( $this->cacheID ) { $scached = serialize($cached); @@ -144,18 +136,17 @@ if (!class_exists("WordPressArmoryCache")) { * @return string[] An associative array * @param string $guild The name of the guild * @param string $realm The guild's realm - * @author Claire Matthews <poeticdragon@stormblaze.net> */ - function getGuildData($guildName = NULL, $realmName = NULL) { + public function getGuildData($guildName = NULL, $realmName = NULL) { - if(($guild==NULL)&&($this->guild)) $guild = $this->guild; - if(($realm==NULL)&&($this->realm)) $realm = $this->realm; + if(($guildName==NULL)&&($this->guildName)) $guildName = $this->guildName; + if(($realmName==NULL)&&($this->realmName)) $realm = $this->realmName; - $this->cacheID = "g".md5($guild.$realm); + $this->cacheID = "g".md5($guildName.$realmName); $cached = $this->cacheFetch($this->cacheID); if (!is_array($cached)) { - $cached = parent::getGuildData($guild, $realm); + $cached = parent::getGuildData($guildName, $realmName); if ( $this->cacheID ) { $scached = serialize($cached); @@ -178,9 +169,8 @@ if (!class_exists("WordPressArmoryCache")) { * * @return string[] An associative array * @param integer $itemID The ID of the item - * @author Claire Matthews <poeticdragon@stormblaze.net> */ - function getItemData($itemID) { + public function getItemData($itemID) { $this->cacheID = "i".md5($itemID); $cached = $this->cacheFetch($this->cacheID); @@ -210,19 +200,18 @@ if (!class_exists("WordPressArmoryCache")) { * @return string[] An associative array * @param string $item The name of the item * @param string[] $filter Associative array of search parameters - * @author Claire Matthews <poeticdragon@stormblaze.net> */ - function getItemDataByName($itemName, $filter = NULL) { + public function getItemDataByName($itemName, $filter = NULL) { if ($filter&&is_array($filter)) { - $this->cacheID = "s".md5($item.implode('', $filter)); + $this->cacheID = "s".md5($itemName.implode('', $filter)); } else { - $this->cacheID = "s".md5($item); + $this->cacheID = "s".md5($itemName); } $cached = $this->cacheFetch($this->cacheID); if (!is_array($cached)) { - $cached = parent::getItemDataByName($item, $filter); + $cached = parent::getItemDataByName($itemName, $filter); if ( $this->cacheID ) { $scached = serialize($cached); @@ -238,33 +227,6 @@ if (!class_exists("WordPressArmoryCache")) { } /** - * xmlFetch - * - * This fetches the XML data as normal by calling - * the parent function. If a cache id is set, it will - * save the XML data to the cache and then unset the id. - * - * @param string $url URL of the page to fetch data from - * @param string $userAgent The user agent making the GET request - * @param integer $timeout The connection timeout in seconds - * @author Claire Matthews <poeticdragon@stormblaze.net> - */ - function getXmlData($url, $userAgent = NULL, $timeOut = NULL) { - - $xml = parent::getXmlData($url, $userAgent, $timeOut); - - /* disabled. - * if ( $this->cacheID ) { - * $this->cacheSave($this->cacheID, $xml); - * unset($this->cacheID); - * } - */ - - return $xml['XmlData']; - - } - - /** * cacheFetch * * This function returns the unserialized XML data @@ -274,9 +236,8 @@ if (!class_exists("WordPressArmoryCache")) { * * @return string[] An associative array * @param string $cacheID The ID of the cached thing - * @author Claire Matthews <poeticdragon@stormblaze.net> */ - function cacheFetch($cacheID) { + public function cacheFetch($cacheID) { global $wpdb; @@ -291,7 +252,7 @@ if (!class_exists("WordPressArmoryCache")) { $results = $wpdb->query( $query ); } else { // Return the cached XML as an array - return $this->xmlToArray(mysql_result($result, 0, 'cache_xml')); + return $this->convertXmlToArray(mysql_result($result, 0, 'cache_xml')); } } } @@ -304,9 +265,8 @@ if (!class_exists("WordPressArmoryCache")) { * * @param string $cacheID The ID of the cached thing * @param string $xml The XML info to be saved - * @author Claire Matthews <poeticdragon@stormblaze.net> */ - function cacheSave($cacheID, $xml) { + public function cacheSave($cacheID, $xml) { global $wpdb; wow-armory.php phparmory/.ditz-config phparmory/.ditz/issue-02d02b8c02cd9025d66c182a12eaef9d5fba2825.yaml phparmory/.ditz/issue-2e896012cdd59ce98128597491a79e2e0435b456.yaml phparmory/.ditz/issue-2ebcc6a19eab29e8f2c3d5de877f591033608ac5.yaml phparmory/.ditz/issue-47a7edc14a9e427035c5cd1a0f71d92b4b43d4bc.yaml phparmory/.ditz/project.yaml phparmory/.gitignore phparmory/ChangeLog phparmory/LICENSE phparmory/README phparmory/doc/blank.html phparmory/doc/classtrees_phpArmory.html phparmory/doc/elementindex.html phparmory/doc/elementindex_phpArmory.html phparmory/doc/errors.html phparmory/doc/index.html phparmory/doc/li_phpArmory.html phparmory/doc/media/banner.css phparmory/doc/media/stylesheet.css phparmory/doc/packages.html phparmory/doc/phpArmory/_phpArmory.class.php.html phparmory/doc/phpArmory/_phpArmoryCache.class.php.html phparmory/doc/phpArmory/classes/phpArmory5.html phparmory/doc/phpArmory/classes/phpArmory5Cache.html phparmory/doc/todolist.html phparmory/examples/characterData.php4 phparmory/examples/guildData.php4 phparmory/examples/item-by-id.php4 phparmory/examples/item-by-name.php4 phparmory/examples/test.php5 phparmory/phpArmory.class.php phparmory/phpArmoryCache.class.php phparmory/phpArmoryCache.class.php4 phparmory/status/blue-check.png phparmory/status/component-Documentation.html phparmory/status/component-Examples.html phparmory/status/component-phpArmory class.html phparmory/status/component-phpArmoryCache class.html phparmory/status/component-phparmory.html phparmory/status/green-bar.png phparmory/status/green-check.png phparmory/status/index.html phparmory/status/issue-02d02b8c02cd9025d66c182a12eaef9d5fba2825.html phparmory/status/issue-2e896012cdd59ce98128597491a79e2e0435b456.html phparmory/status/issue-2ebcc6a19eab29e8f2c3d5de877f591033608ac5.html phparmory/status/issue-47a7edc14a9e427035c5cd1a0f71d92b4b43d4bc.html phparmory/status/red-check.png phparmory/status/release-phpArmory 0.3.2.html phparmory/status/release-phpArmory 0.4.0.html phparmory/status/release-phpArmory 0.5.0.html phparmory/status/style.css phparmory/status/unassigned.html phparmory/status/yellow-bar.png a145f4dd4f5ddaefa13d78f6ccfb68895d9940a6 Daniel S. Reichenbach shiendra@marenkay.com http://github.com/marenkay/wow-armory/commit/de935392b9ffa91f0ef7e1398c1b4afb48b85e8f de935392b9ffa91f0ef7e1398c1b4afb48b85e8f 2008-11-19T11:42:25-08:00 2008-11-19T11:42:25-08:00 Now works with phpArmory 0.4.0-rc1. 5a9d213ee1f9ef0345bbc88a9f0e4720f2b13ae6 Daniel S. Reichenbach shiendra@marenkay.com