examples/characterData.php
examples/guildData.php
examples/item-by-id.php
examples/item-by-name.php
@@ -2,18 +2,26 @@
## Summary
-phpArmory is a PHP class library that can easily fetch and unserialize World of Warcraft Armory XML data into structured associative arrays.
+phpArmory is a PHP class library that can easily fetch and unserialize World
+of Warcraft Armory XML data into structured associative arrays.
-This class library requires the PHP extensions for CURL, and XML installed. Please make sure that these extensions are installed on your server.
+This class library requires the PHP extensions for CURL, and XML installed.
+Please make sure that these extensions are installed on your server.
## Usage
-Include phpArmory.class.php4 as the base class in your project, and inherit new classes from the phpArmory class.
+Include phpArmory.class.php as the base class in your project, and inherit
+new classes from the `phpArmory5` class.
-If you need caching of the retrieved XML results, include the caching class from phpArmoryCache.class.php4 in your project, and inherit new classes from the phpArmoryCache class.
+If you need caching of the retrieved XML results, include the caching class
+from phpArmoryCache.class.php in your project, and inherit new classes from
+the `phpArmory5Cache` class.
## Notes
-If you use PHP5, please use the phpArmory.class.php5 file for normal data retrieval, and the phpArmoryCache.class.php5 for database / file cache data retrieval.
+* With the release of phpArmory 0.4.0 support for running the classes with
+ PHP4 has been dropped, due to PHP4 not being supported by the developers
+ anymore. Thus we recommend to upgrade your PHP installation to PHP5 now.
-The PHP4 and PHP5 versions of phpArmory are not API compatible. The PHP4 versions are not supported anymore, as PHP 4 is deprecated, and everyone is recommended to use PHP5.
+* The phpArmory API has changed with phpArmory 0.4.0 and is not backwards
+ compatible.
\ No newline at end of file
README
@@ -20,7 +20,7 @@
</ul>
<p class="notes" id="credit">
- Documentation generated on Wed, 19 Nov 2008 17:25:12 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+ 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>
</p>
</body>
</html>
\ No newline at end of file
doc/classtrees_phpArmory.html
@@ -257,6 +257,20 @@
<div class="index-item-details"><a href="phpArmory/classes/phpArmory5.html#var$timeOut">phpArmory5::$timeOut</a> in phpArmory.class.php</div>
<div class="index-item-description">The amount of time in seconds after which to consider a connection timed out if no data has been yet retrieved.</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/phpArmory5.html#methodtriggerError">phpArmory5::triggerError()</a> in phpArmory.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/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>
</dl>
<a name="u"></a>
<div class="index-letter-section">
doc/elementindex.html
@@ -291,6 +291,20 @@
<div class="index-item-details"><a href="phpArmory/classes/phpArmory5.html#var$timeOut">phpArmory5::$timeOut</a> in phpArmory.class.php</div>
<div class="index-item-description">The amount of time in seconds after which to consider a connection timed out if no data has been yet retrieved.</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/phpArmory5.html#methodtriggerError">phpArmory5::triggerError()</a> in phpArmory.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/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>
</dl>
<a name="u"></a>
<div class="index-letter-section">
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 17:25:12 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+ 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>
</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>
- <!-- Generated by phpDocumentor on Wed, 19 Nov 2008 17:25:12 +0100 -->
+ <!-- Generated by phpDocumentor on Wed, 19 Nov 2008 21:55:01 +0100 -->
<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 17:25:12 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+ 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>
</p>
</div></body>
</html>
\ No newline at end of file
doc/phpArmory/_phpArmory.class.php.html
@@ -91,7 +91,7 @@
<p class="notes" id="credit">
- Documentation generated on Wed, 19 Nov 2008 17:25:12 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+ 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>
</p>
</div></body>
</html>
\ No newline at end of file
doc/phpArmory/_phpArmoryCache.class.php.html
@@ -132,7 +132,7 @@
</div>
<div class="info-box-body">
<div class="method-summary">
-
+
<div class="method-definition">
<span class="method-result">mixed</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
@@ -213,6 +213,16 @@
<a href="#setLocale" title="details" class="method-name">setLocale</a>
(<span class="var-type">string</span> <span class="var-name">$localeName</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="#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>
</div>
</div>
@@ -617,7 +627,7 @@
<div class="evenrow">
<div class="method-header">
- <span class="method-title">getArenaTeamData</span> (line <span class="line-number">497</span>)
+ <span class="method-title">getArenaTeamData</span> (line <span class="line-number">522</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@@ -654,7 +664,7 @@
<div class="oddrow">
<div class="method-header">
- <span class="method-title">getCharacterData</span> (line <span class="line-number">514</span>)
+ <span class="method-title">getCharacterData</span> (line <span class="line-number">543</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@@ -687,7 +697,7 @@
<div class="evenrow">
<div class="method-header">
- <span class="method-title">getCharacterIconURL</span> (line <span class="line-number">565</span>)
+ <span class="method-title">getCharacterIconURL</span> (line <span class="line-number">596</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@@ -717,7 +727,7 @@
<div class="oddrow">
<div class="method-header">
- <span class="method-title">getGuildData</span> (line <span class="line-number">584</span>)
+ <span class="method-title">getGuildData</span> (line <span class="line-number">615</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@@ -750,7 +760,7 @@
<div class="evenrow">
<div class="method-header">
- <span class="method-title">getItemData</span> (line <span class="line-number">615</span>)
+ <span class="method-title">getItemData</span> (line <span class="line-number">646</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@@ -780,7 +790,7 @@
<div class="oddrow">
<div class="method-header">
- <span class="method-title">getItemDataByName</span> (line <span class="line-number">641</span>)
+ <span class="method-title">getItemDataByName</span> (line <span class="line-number">672</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@@ -841,7 +851,7 @@
<div class="oddrow">
<div class="method-header">
- <span class="method-title">getPatchLevel</span> (line <span class="line-number">436</span>)
+ <span class="method-title">getPatchLevel</span> (line <span class="line-number">461</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@@ -866,7 +876,7 @@
<div class="evenrow">
<div class="method-header">
- <span class="method-title">getTalentData</span> (line <span class="line-number">467</span>)
+ <span class="method-title">getTalentData</span> (line <span class="line-number">492</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
@@ -985,13 +995,71 @@
</div>
+<a name="methodtriggerError" id="triggerError"><!-- --></a>
+<div class="evenrow">
+
+ <div class="method-header">
+ <span class="method-title">triggerError</span> (line <span class="line-number">436</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<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>
+
+
+ </div>
+<a name="methodtriggerNotice" id="triggerNotice"><!-- --></a>
+<div class="oddrow">
+
+ <div class="method-header">
+ <span class="method-title">triggerNotice</span> (line <span class="line-number">447</span>)
+ </div>
+
+ <!-- ========== Info from phpDoc block ========= -->
+<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>
+
+
+ </div>
</div>
</div>
<p class="notes" id="credit">
- Documentation generated on Wed, 19 Nov 2008 17:25:12 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+ 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>
</p>
</div></body>
</html>
\ No newline at end of file
doc/phpArmory/classes/phpArmory5.html
@@ -206,6 +206,8 @@
<span class="method-name"><a href="../../phpArmory/classes/phpArmory5.html#methodgetXmlData">phpArmory5::getXmlData()</a></span><br>
<span class="method-name"><a href="../../phpArmory/classes/phpArmory5.html#methodsetArea">phpArmory5::setArea()</a></span><br>
<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>
</blockquote>
@@ -214,7 +216,7 @@
<p class="notes" id="credit">
- Documentation generated on Wed, 19 Nov 2008 17:25:12 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+ 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>
</p>
</div></body>
</html>
\ No newline at end of file
doc/phpArmory/classes/phpArmory5Cache.html
@@ -23,7 +23,7 @@
<li>IMPLEMENTATION MISSING.</li>
</ul>
<p class="notes" id="credit">
- Documentation generated on Wed, 19 Nov 2008 17:25:12 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+ 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>
</p>
</body>
</html>
\ No newline at end of file
doc/todolist.html
@@ -135,7 +135,7 @@ class phpArmory5 {
public function __construct($areaName = NULL, $downloadRetries = NULL) {
if (!extension_loaded('curl') && !extension_loaded('xml')) {
- trigger_error("phpArmory " . $this->version . " - " . $this->version_state . ": The PHP extensions \"curl\" and \"xml\" are required to use this class.", E_USER_ERROR);
+ self::triggerError("The PHP extensions \"curl\" and \"xml\" are required to use this class.");
} else {
// If an area is provided, we will configure armory site, wow site, and language appropriately.
@@ -195,9 +195,9 @@ class phpArmory5 {
break;
}
- trigger_error("phpArmory " . $this->version . " - " . $this->version_state . ": Area now is [" . $this->areaName . "].", E_USER_NOTICE);
- trigger_error("phpArmory " . $this->version . " - " . $this->version_state . ": Armory now is [" . $this->armory . "].", E_USER_NOTICE);
- trigger_error("phpArmory " . $this->version . " - " . $this->version_state . ": Wow site now is [" . $this->wow . "].", E_USER_NOTICE);
+ self::triggerNotice("Area now is [" . $this->areaName . "].");
+ self::triggerNotice("Armory now is [" . $this->armory . "].");
+ self::triggerNotice("Wow site now is [" . $this->wow . "].");
return TRUE;
}
@@ -235,7 +235,7 @@ class phpArmory5 {
$this->localeName = 'en';
}
- trigger_error("phpArmory " . $this->version . " - " . $this->version_state . ": Locale now is [" . $this->localeName . "].", E_USER_NOTICE);
+ self::triggerNotice("Locale now is [" . $this->localeName . "].");
return TRUE;
}
@@ -270,12 +270,12 @@ class phpArmory5 {
if (time() < $this->lastDownload+1) {
$delay = rand (1,2);
- trigger_error("phpArmory " . $this->version . " - " . $this->version_state . ": Inserting fetch delay of " . $delay . " seconds.", E_USER_NOTICE);
+ self::triggerNotice("Inserting fetch delay of " . $delay . " seconds.");
sleep($delay); //random delay
} // if
- trigger_error("phpArmory " . $this->version . " - " . $this->version_state . ": Fetching [" . $url . "] (tries: #" . $i . ").", E_USER_NOTICE);
+ self::triggerNotice("Fetching [" . $url . "] (tries: #" . $i . ").");
$ch = curl_init();
$timeout = $this->timeOut;
@@ -315,7 +315,7 @@ class phpArmory5 {
}
- trigger_error("phpArmory " . $this->version . " - " . $this->version_state . ": Fetched [" . $url . "] in " . $i . " tries.", E_USER_NOTICE);
+ self::triggerNotice("Fetched [" . $url . "] in " . $i . " tries.");
return array ( 'result' => TRUE, 'XmlData' => $f);
}
@@ -429,6 +429,31 @@ class phpArmory5 {
}
/**
+ * 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("phpArmory " . $this->version . " - " . $this->version_state . ": " . $userError, E_USER_ERROR);
+ }
+ }
+
+ /**
+ * 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("phpArmory " . $this->version . " - " . $this->version_state . ": " . $userNotice, E_USER_NOTICE);
+ }
+ }
+ }
+
+ /**
* Provides information on the current patch level of World of Warcraft.
* @access public
* @return string $patchLevel Returns a string with int $patchLevelMajor, int $patchLevelMinor, and int $patchLevelFix.
@@ -628,7 +653,7 @@ class phpArmory5 {
$itemArray = $this->convertXmlToArray($itemXML['XmlData']);
- trigger_error("phpArmory " . $this->version . " - " . $this->version_state . ": Fetched item by ID [" . $itemID . "].", E_USER_NOTICE);
+ self::triggerNotice("Fetched item by ID [" . $itemID . "].");
return $itemArray;
} else {
phpArmory.class.php
examples/characterData.php4
examples/guildData.php4
examples/item-by-id.php4
examples/item-by-name.php4
93b75bfb52c811b7b38f291452e36948396ce436
Daniel S. Reichenbach
shiendra@marenkay.com
http://github.com/marenkay/phparmory/commit/59e8f6f02e5c94b66a9b41f6940c312235b16584
59e8f6f02e5c94b66a9b41f6940c312235b16584
2008-11-19T12:55:51-08:00
2008-11-19T12:55:51-08:00
Updated examples for the new PHP5 class, all working. Enjoy!
a79b846aee4fe04e77914ac9dba26084587d282c
Daniel S. Reichenbach
shiendra@marenkay.com