phpArmory 0.4.2 - "Fishing Extravaganza" released.

danielsreichenbach · Dec 17, 2008 · 6831c32 · 6831c32
1 parent f22a6f6
commit 6831c32
Show file tree

Hide file tree

Showing 19 changed files with 353 additions and 107 deletions.
diff --git a/.ditz/issue-b6d95ba063cceefd4e82a129257a95a88096bd09.yaml b/.ditz/issue-b6d95ba063cceefd4e82a129257a95a88096bd09.yaml
@@ -5,8 +5,8 @@ type: :feature
 component: phpArmory class
 release: phpArmory 0.4.2
 reporter: Daniel S. Reichenbach <shiendra@marenkay.com>
-status: :in_progress
-disposition: 
+status: :closed
+disposition: :fixed
 creation_time: 2008-11-30 20:01:35.666108 Z
 references: []
 
@@ -30,3 +30,7 @@ log_events:
     
     Note that searches for $searchType of 'all' will be returned paged, thus
     single queries for each data type have to be sent.
+- - 2008-12-17 14:55:17.316198 Z
+  - Daniel S. Reichenbach <shiendra@marenkay.com>
+  - closed with disposition fixed
+  - ""
diff --git a/.ditz/issue-fa08016d1f2aba78714b622817def202ae4f490a.yaml b/.ditz/issue-fa08016d1f2aba78714b622817def202ae4f490a.yaml
@@ -0,0 +1,28 @@
+--- !ditz.rubyforge.org,2008-03-06/issue 
+title: Broken URL in armory queries
+desc: |-
+  Due to calling str_replace the armory queries for some characters failed.
+  urlencode does the job already.
+type: :bugfix
+component: phpArmory class
+release: phpArmory 0.4.2
+reporter: Daniel S. Reichenbach <shiendra@marenkay.com>
+status: :closed
+disposition: :fixed
+creation_time: 2008-12-17 14:53:39.526601 Z
+references: []
+
+id: fa08016d1f2aba78714b622817def202ae4f490a
+log_events: 
+- - 2008-12-17 14:53:42.095319 Z
+  - Daniel S. Reichenbach <shiendra@marenkay.com>
+  - created
+  - ""
+- - 2008-12-17 14:54:20.144304 Z
+  - Daniel S. Reichenbach <shiendra@marenkay.com>
+  - changed status from unstarted to in_progress
+  - ""
+- - 2008-12-17 14:55:22.461005 Z
+  - Daniel S. Reichenbach <shiendra@marenkay.com>
+  - closed with disposition fixed
+  - ""
diff --git a/.ditz/project.yaml b/.ditz/project.yaml
@@ -70,11 +70,15 @@ releases:
     - ""
 - !ditz.rubyforge.org,2008-03-06/release 
   name: phpArmory 0.4.2
-  status: :unreleased
-  release_time: 
+  status: :released
+  release_time: 2008-12-17 14:55:50.448190 Z
   log_events: 
   - - 2008-11-30 19:53:17.008511 Z
     - Daniel S. Reichenbach <shiendra@marenkay.com>
     - created
     - "phpArmory 0.4.2 - \xE2\x80\x9CFishing Extravaganza\xE2\x80\x9D is a bug-fix release, and adds the\n\
       missing search feature back into the class API."
+  - - 2008-12-17 14:55:50.448218 Z
+    - Daniel S. Reichenbach <shiendra@marenkay.com>
+    - released
+    - phpArmory 0.4.2 - "Fishing Extravaganza" released on Dec 17th 2008
diff --git a/ChangeLog b/ChangeLog
@@ -1,4 +1,6 @@
-# 0.4.2 - "Fishing Extravaganza" - Dec ??, 2008
+# 0.4.2 - "Fishing Extravaganza" - Dec 17, 2008
+This release should fix issues with character that could not be retrieved
+from the armory due to special characters in realm or character names.
 
 ## Bugs squashed
 * phpArmory5Cache: the setCachedData(...) function was called without prior
@@ -14,6 +16,12 @@
   "guilds", "items". $filter needs to be an associative array of filter
   properties. For now, try out the armory item search page to see valid
   filter options.
+* phpArmory5: added a third parameter to getCharacterData for retrieving only
+  the basic character data. Defaults to false. Use the following to get basic
+  character data only:
+
+        !!php
+        $character = $phpArmory->getCharacterData($characterName = "Char", $realmName = "Realm", $onlyBasicData = true)
 
 # 0.4.1 - "Call to Arms" - Nov 26, 2008
 The [World of Warcraft armory](http://www.wowarmory.com/) has received quite a

diff --git a/doc/classtrees_phpArmory.html b/doc/classtrees_phpArmory.html
@@ -20,7 +20,7 @@ <h2>Root class phpArmory5</h2>
 </ul>
 
 	<p class="notes" id="credit">
-		Documentation generated on Mon, 01 Dec 2008 21:23:09 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+		Documentation generated on Wed, 17 Dec 2008 15:51:36 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
 	</p>
 	</body>
 </html>
diff --git a/doc/errors.html b/doc/errors.html
@@ -10,7 +10,7 @@
 		<body>
 						<a href="#Post-parsing">Post-parsing</a><br>
 	<p class="notes" id="credit">
-		Documentation generated on Mon, 01 Dec 2008 21:23:09 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+		Documentation generated on Wed, 17 Dec 2008 15:51:36 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
 	</p>
 	</body>
 </html>
diff --git a/doc/index.html b/doc/index.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 Mon, 01 Dec 2008 21:23:09 +0100  -->
+	<!-- Generated by phpDocumentor on Wed, 17 Dec 2008 15:51:36 +0100  -->
   <title>Generated Documentation</title>
   <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
 </head>

diff --git a/doc/phpArmory/_phpArmory.class.php.html b/doc/phpArmory/_phpArmory.class.php.html
@@ -63,7 +63,7 @@ <h2 class="file-name">/phpArmory.class.php</h2>
 
 
 	<p class="notes" id="credit">
-		Documentation generated on Mon, 01 Dec 2008 21:23:09 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+		Documentation generated on Wed, 17 Dec 2008 15:51:36 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
 	</p>
 	</div></body>
 </html>
diff --git a/doc/phpArmory/_phpArmoryCache.class.php.html b/doc/phpArmory/_phpArmoryCache.class.php.html
@@ -91,7 +91,7 @@ <h2 class="file-name">/phpArmoryCache.class.php</h2>
 
 
 	<p class="notes" id="credit">
-		Documentation generated on Mon, 01 Dec 2008 21:23:09 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+		Documentation generated on Wed, 17 Dec 2008 15:51:36 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
 	</p>
 	</div></body>
 </html>
diff --git a/doc/phpArmory/classes/phpArmory5.html b/doc/phpArmory/classes/phpArmory5.html
@@ -161,7 +161,7 @@ <h2 class="class-name">Class phpArmory5</h2>
 																<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>&nbsp;<span class="var-name">$characterName</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$realmName</span> = <span class="var-default">NULL</span>])
+											([<span class="var-type">string</span>&nbsp;<span class="var-name">$characterName</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$realmName</span> = <span class="var-default">NULL</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$onlyBasicData</span> = <span class="var-default">false</span>])
 									</div>
 																<div class="method-definition">
 											<span class="method-result">array</span>
@@ -446,7 +446,7 @@ <h2 class="class-name">Class phpArmory5</h2>
 		<span class="var-title">
 			<span class="var-type">string</span>
 			<span class="var-name">$version_state</span>
-			 = <span class="var-default"> &quot;alpha&quot;</span>			(line <span class="line-number">39</span>)
+			 = <span class="var-default"> &quot;release&quot;</span>			(line <span class="line-number">39</span>)
 		</span>
 	</div>
 
@@ -591,7 +591,7 @@ <h2 class="class-name">Class phpArmory5</h2>
 <div class="evenrow">
 
 	<div class="method-header">
-		<span class="method-title">getAnyData</span> (line <span class="line-number">741</span>)
+		<span class="method-title">getAnyData</span> (line <span class="line-number">737</span>)
 	</div> 
 
 	<!-- ========== Info from phpDoc block ========= -->
@@ -697,7 +697,7 @@ <h2 class="class-name">Class phpArmory5</h2>
 <div class="oddrow">
 
 	<div class="method-header">
-		<span class="method-title">getCharacterData</span> (line <span class="line-number">549</span>)
+		<span class="method-title">getCharacterData</span> (line <span class="line-number">548</span>)
 	</div> 
 
 	<!-- ========== Info from phpDoc block ========= -->
@@ -712,7 +712,7 @@ <h2 class="class-name">Class phpArmory5</h2>
 		<span class="method-name">
 			getCharacterData
 		</span>
-					([<span class="var-type">string</span>&nbsp;<span class="var-name">$characterName</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$realmName</span> = <span class="var-default">NULL</span>])
+					([<span class="var-type">string</span>&nbsp;<span class="var-name">$characterName</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$realmName</span> = <span class="var-default">NULL</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$onlyBasicData</span> = <span class="var-default">false</span>])
 			</div>
 
 			<ul class="parameters">
@@ -722,6 +722,9 @@ <h2 class="class-name">Class phpArmory5</h2>
 					<li>
 				<span class="var-type">string</span>
 				<span class="var-name">$realmName</span><span class="var-description">: The characters' realm name.</span>			</li>
+					<li>
+				<span class="var-type">bool</span>
+				<span class="var-name">$onlyBasicData</span><span class="var-description">: If true, only the basic character data will be fetched.</span>			</li>
 				</ul>
 
 
@@ -738,7 +741,7 @@ <h2 class="class-name">Class phpArmory5</h2>
 <div class="evenrow">
 
 	<div class="method-header">
-		<span class="method-title">getCharacterIconURL</span> (line <span class="line-number">611</span>)
+		<span class="method-title">getCharacterIconURL</span> (line <span class="line-number">610</span>)
 	</div> 
 
 	<!-- ========== Info from phpDoc block ========= -->
@@ -768,7 +771,7 @@ <h2 class="class-name">Class phpArmory5</h2>
 <div class="oddrow">
 
 	<div class="method-header">
-		<span class="method-title">getGuildData</span> (line <span class="line-number">630</span>)
+		<span class="method-title">getGuildData</span> (line <span class="line-number">629</span>)
 	</div> 
 
 	<!-- ========== Info from phpDoc block ========= -->
@@ -809,7 +812,7 @@ <h2 class="class-name">Class phpArmory5</h2>
 <div class="evenrow">
 
 	<div class="method-header">
-		<span class="method-title">getItemData</span> (line <span class="line-number">661</span>)
+		<span class="method-title">getItemData</span> (line <span class="line-number">657</span>)
 	</div> 
 
 	<!-- ========== Info from phpDoc block ========= -->
@@ -847,7 +850,7 @@ <h2 class="class-name">Class phpArmory5</h2>
 <div class="oddrow">
 
 	<div class="method-header">
-		<span class="method-title">getItemDataByName</span> (line <span class="line-number">690</span>)
+		<span class="method-title">getItemDataByName</span> (line <span class="line-number">686</span>)
 	</div> 
 
 	<!-- ========== Info from phpDoc block ========= -->
@@ -1174,7 +1177,7 @@ <h2 class="class-name">Class phpArmory5</h2>
 
 
 	<p class="notes" id="credit">
-		Documentation generated on Mon, 01 Dec 2008 21:23:09 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+		Documentation generated on Wed, 17 Dec 2008 15:51:36 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
 	</p>
 	</div></body>
 </html>
diff --git a/doc/phpArmory/classes/phpArmory5Cache.html b/doc/phpArmory/classes/phpArmory5Cache.html
@@ -117,7 +117,7 @@ <h2 class="class-name">Class phpArmory5Cache</h2>
 																<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>&nbsp;<span class="var-name">$characterName</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$realmName</span> = <span class="var-default">NULL</span>])
+											([<span class="var-type">string</span>&nbsp;<span class="var-name">$characterName</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$realmName</span> = <span class="var-default">NULL</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$onlyBasicData</span> = <span class="var-default">false</span>])
 									</div>
 																<div class="method-definition">
 											<span class="method-result">array</span>
@@ -345,7 +345,7 @@ <h2 class="class-name">Class phpArmory5Cache</h2>
 		<span class="var-title">
 			<span class="var-type">string</span>
 			<span class="var-name">$version_state</span>
-			 = <span class="var-default"> &quot;alpha&quot;</span>			(line <span class="line-number">44</span>)
+			 = <span class="var-default"> &quot;release&quot;</span>			(line <span class="line-number">44</span>)
 		</span>
 	</div>
 
@@ -539,7 +539,7 @@ <h4>Inherited Variables</h4>
 <div class="evenrow">
 
 	<div class="method-header">
-		<span class="method-title">getCharacterData</span> (line <span class="line-number">314</span>)
+		<span class="method-title">getCharacterData</span> (line <span class="line-number">315</span>)
 	</div> 
 
 	<!-- ========== Info from phpDoc block ========= -->
@@ -554,7 +554,7 @@ <h4>Inherited Variables</h4>
 		<span class="method-name">
 			getCharacterData
 		</span>
-					([<span class="var-type">string</span>&nbsp;<span class="var-name">$characterName</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$realmName</span> = <span class="var-default">NULL</span>])
+					([<span class="var-type">string</span>&nbsp;<span class="var-name">$characterName</span> = <span class="var-default">NULL</span>], [<span class="var-type">string</span>&nbsp;<span class="var-name">$realmName</span> = <span class="var-default">NULL</span>], [<span class="var-type">bool</span>&nbsp;<span class="var-name">$onlyBasicData</span> = <span class="var-default">false</span>])
 			</div>
 
 			<ul class="parameters">
@@ -564,6 +564,9 @@ <h4>Inherited Variables</h4>
 					<li>
 				<span class="var-type">string</span>
 				<span class="var-name">$realmName</span><span class="var-description">: The characters' realm name.</span>			</li>
+					<li>
+				<span class="var-type">bool</span>
+				<span class="var-name">$onlyBasicData</span><span class="var-description">: If true, only the basic character data will be fetched.</span>			</li>
 				</ul>
 
 			<hr class="separator" />
@@ -578,7 +581,7 @@ <h4>Inherited Variables</h4>
 <div class="oddrow">
 
 	<div class="method-header">
-		<span class="method-title">getGuildData</span> (line <span class="line-number">347</span>)
+		<span class="method-title">getGuildData</span> (line <span class="line-number">348</span>)
 	</div> 
 
 	<!-- ========== Info from phpDoc block ========= -->
@@ -617,7 +620,7 @@ <h4>Inherited Variables</h4>
 <div class="evenrow">
 
 	<div class="method-header">
-		<span class="method-title">getItemData</span> (line <span class="line-number">377</span>)
+		<span class="method-title">getItemData</span> (line <span class="line-number">378</span>)
 	</div> 
 
 	<!-- ========== Info from phpDoc block ========= -->
@@ -653,7 +656,7 @@ <h4>Inherited Variables</h4>
 <div class="oddrow">
 
 	<div class="method-header">
-		<span class="method-title">getItemDataByName</span> (line <span class="line-number">409</span>)
+		<span class="method-title">getItemDataByName</span> (line <span class="line-number">410</span>)
 	</div> 
 
 	<!-- ========== Info from phpDoc block ========= -->
@@ -857,7 +860,7 @@ <h4>Inherited Methods</h4>
 
 
 	<p class="notes" id="credit">
-		Documentation generated on Mon, 01 Dec 2008 21:23:09 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+		Documentation generated on Wed, 17 Dec 2008 15:51:36 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
 	</p>
 	</div></body>
 </html>
diff --git a/doc/todolist.html b/doc/todolist.html
@@ -15,7 +15,7 @@ <h3><a href="phpArmory/classes/phpArmory5.html#methodgetArenaTeamData">phpArmory
     <li>IMPLEMENTATION MISSING.</li>
 </ul>
 	<p class="notes" id="credit">
-		Documentation generated on Mon, 01 Dec 2008 21:23:09 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
+		Documentation generated on Wed, 17 Dec 2008 15:51:36 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.2</a>
 	</p>
 	</body>
 </html>