need help deconstructing class or function to handle extra data

schwim

Hi there everyone,

I'm using this class to get data from game servers for use locally. Recently, I've begun to notice that the functions I'm using doesn't provide all the data available(and that I would love to have). For instance, here's an example of what the function is providing and what's being provided by the game server.

from the function:

code used to get info:

$achievements = $guild->getAchievements('timestamp','desc');

print_r($achievements);

[0] => Array
        (
            [id] => 5782
            [timestamp] => 1341957333000
            [url] => http://www.wowhead.com/achievement=5782&who=A Clash of Kings&when=1341957333000
            [name] => A Difficult Challenge
        )

This is what's actually provided directly from the game server:

{"id":5782,"title":"A Difficult Challenge","points":10,"description":"Complete 100 guild challenges.","rewardItems":[],"icon":"inv_helm_robe_raidmage_i_01","criteria":[{"id":17006,"description":"Complete 100 guild challenges"}]}

So you can see there's a lot more available than what the function is providing. I would like to modify the classes to allow me access to this information.

The problem I have is that I'm not smart enough yet to figure out how to modify what's being returned in the array. I've searched all the files for "achievement":

The obvious:

class Achievements {

private $data;
private $datas;

function __construct($id_list,$type,$region) {
	$jsonConnect = new jsonConnect();
	$this->data = $jsonConnect->getAchievements($region,$id_list,$type);
	$count = count($this->data);
	for ($i=0; $i < $count; $i++){
		$this->datas[$this->data[$i]['id']] = $this->data[$i]; 
	}
	#print_r($this->datas);
}

public function getAchievement($id,$field){
	return $this->datas[$id][$field];
}
}

And it seems to reference the jsonConnect file quite a bit, so I looked in there:

   	public function getAchievements($region,$id_list,$type){
   		$url = 'http://'.$this->regions[$region].$this->databaseURL.$type.'/achievements';
   		$data = $this->getData($url, FALSE, $region,'Achievements',$id_list);
   		#print_r($data);
   		return $data;
   	}

(there's more files referenced but I don't want to clutter the thread just yet until I have a better idea of what might be needed )

So it seems I need to modify $data somehow. I just have no idea how.

Could someone help by guiding me at the beginning of my path of understanding to modifying what gets returned? I'd be greatly appreciative!

Weedpacket

It seems what needs changing is getData() so that it gets more data (or, more likely, so that it throws away less; a simple [man]json_decode[/man] would return an object/array with all of the JSON content as fields/elements).

schwim

Thanks very much for your help, weed!

If I look in the jsonConnect file, I see:

   	public function getAchievements($region,$id_list,$type){
   		$url = 'http://'.$this->regions[$region].$this->databaseURL.$type.'/achievements';
   		$data = $this->getData($url, FALSE, $region,'Achievements',$id_list);
   		#print_r($data);
   		return $data;
   	}

would I change where he's commented the print_r to: $data = var_dump(json_decode($data, true));? Would that get me what I need to find out what's in there?

johanafm

Without looking into what happens where, I'd guess Weedpacket is spot on when he says you need to modify the function getData, which is likely to be the part either not getting everything from the server or throwing things away after the response is retrieved. Thus, look in the function getData, print_r the json_decoded data as soon as it is returned (and if you wish, compare that to a print_r of the data getData() returns.

schwim

Well, I found this in Guild.class.php:

	public function getData() {
   		return $this->guildData;
   	}

which made me think that I needed to find a function called guildData, but searching "function guildData" across all files results in 0 matches, so I tried just guildData and got 19 hits all in one file. There's no function however, it's all singular line matches. Here's the lines returned:

  Z:\Personal\aclashofkings.org\public_html\includes\wowarmoryapi\Guild.class.php (19 hits)
	Line 8: 	private $guildData;
	Line 21: 		$this->guildData = $jsonConnect->getGuild($name, $realm, $region, implode(",",$this->fields));
	Line 23: 			$this->perks = new Perks($region,$this->guildData['level']);
	Line 26: 		#print_r($this->guildData);
	Line 30:    		$members = $this->guildData['members'];
	Line 32:    			$this->guildData['members'][$key]['character']['thumbnailURL'] = 'http://' .$this->region. '.battle.net/static-render/' .$this->region. '/' . $member['character']['thumbnail']; 
	Line 69:    		if (!$this->guildData){
	Line 80:    		return $this->guildData;
	Line 89:    		$achievements['achievementsCompleted'] = $this->guildData['achievements']['achievementsCompleted'];
	Line 90:    		$achievements['achievementsCompletedTimestamp'] = $this->guildData['achievements']['achievementsCompletedTimestamp'];
	Line 127:    		$members = $this->guildData['members'];
	Line 129: 			$members = $this->sort($this->guildData['members'], $sort, $sortFlag);
	Line 257: 	   		if ($this->guildData['side'] == 0){
	Line 265: 			$emblemURL = dirname(__FILE__)."/img/emblems/emblem_".sprintf("%02s",$this->guildData['emblem']['icon']).".png";
	Line 266: 			$borderURL = dirname(__FILE__)."/img/borders/border_".sprintf("%02s",$this->guildData['emblem']['border']).".png";
	Line 285: 			$emblemcolor = preg_replace('/^ff/i','',$this->guildData['emblem']['iconColor']);
	Line 295: 			$bordercolor = preg_replace('/^ff/i','',$this->guildData['emblem']['borderColor']);
	Line 306: 			$bgcolor = preg_replace('/^ff/i','',$this->guildData['emblem']['backgroundColor']);
	Line 333: 				$level = $this->guildData['level'];

I definitely don't understand what I'm seeing above, but are these lines deciding what gets saved from the server return? I'm assuming so, but I don't see where I would add to what gets saved(or subtract from what gets thrown away).

I've found what seems to be the main achievement function in Guild.class.php:

   	/**
   	 * Get a list of the completed achievements by the guild
   	 * @param String $sort Define what the list should be sorted by: timestamp|id|name
   	 * @param String $sortFlag Can be asc|desc
   	 */
   	public function getAchievements($sort=FALSE,$sortFlag='asc'){
   		$achievements['achievementsCompleted'] = $this->guildData['achievements']['achievementsCompleted'];
   		$achievements['achievementsCompletedTimestamp'] = $this->guildData['achievements']['achievementsCompletedTimestamp'];
   		$id_list = '';
   		for ($i = 0; $i < count($achievements['achievementsCompleted']); $i++){
   			// Build the new array to return
   			$achievement[$i]['id']=$achievements['achievementsCompleted'][$i];
   			$achievement[$i]['timestamp']=$achievements['achievementsCompletedTimestamp'][$i];
   			$achievement[$i]['url'] = $GLOBALS['wowarmory']['urls']['achievement']."=".$achievements['achievementsCompleted'][$i];

		// Get name of achievement
		#$achievement[$i]['name'] = $wowhead->getData($achievement[$i]['url'], 'name');
		$achievement[$i]['url'] .= "&who=".$this->name."&when=".$achievement[$i]['timestamp'];
		$id_list .= $achievement[$i]['id'].',';
	}
	$id_list = substr($id_list, 0,-1);
	$achievementdata = new Achievements($id_list,'guild',$this->region);
	$id_list = null;

	for ($i = 0; $i < count($achievements['achievementsCompleted']); $i++){
		$achievement[$i]['name'] = $achievementdata->getAchievement($achievement[$i]['id'],'title');
	}

	$achievements = null;
	$achievementdata = null;

	if ($sort){
		return $this->sortAchievements($achievement, $sort, $sortFlag);
	}

	return $achievement;
}

Could you guys explain how this is working, or is there not enough info above to do so?

Weedpacket

	Line 8: 	private $guildData;
	Line 21: 		$this->guildData = $jsonConnect->getGuild($name, $realm, $region, implode(",",$this->fields));
	Line 23: 			$this->perks = new Perks($region,$this->guildData['level']);
	Line 26: 		#print_r($this->guildData);

Line 8 shows that guildData is a private property; line 21 has it getting its value by calling $jsonConnect->getGuild(); line 23 implies it's an array; line 26 is a commented-out debugging line that dumps its content.

But the jsonConnect object should have a getData() method as well.

I don't know much about the interface this thing gives, or how it relates to the API it's connecting to, but it looks like these jsonConnect->get*() methods take what comes from the server and edits it down to what you can access. It's bizarre to throw so much stuff away so soon (unless the class was written to an interface that didn't provide that information without being forward-compatible in case the interface changed); there must be some way to get at the original data. It might be simpler to ignore the rest of the class and use that.

In fact, it may even be simpler to write a whole new implementation from scratch 🙂

johanafm

Looking at the code for getAchievements in your first post

public function getAchievements($region,$id_list,$type) {

$data = $this->getData($url, FALSE, $region,'Achievements',$id_list);

specifically the function name, "getAchievements", and the fourth parameter to getData, "Achievements", it's entirely possible that getData, without any specifics, would get all data in one request.

If this is the case, it should be simple to modify getData to retrieve all data at once on the first request, and then either check with the server if data has been updated and fetched again or use pre-fetched data instead. Or perhaps set an internal timestamp and cache time, such as 24 hours, which means you'd not update the data more than once per day or whatever suits your needs.

Edit: oh, you might of course also have to modify getData to actually store everything it retrieves rather than keep throwing things away.

schwim

Hi there guys,

My first thought was to build new but I really would like to try to learn enough to understand this class for two reasons. One, I can see that I'd have to be much more knowledgeable to understand what in the hell is going on with it and I'd really like to be more knowledgeable 🙂 Secondly, Quite a few people use this class and it's become exceedingly clear that the author has moved on. It would be very nice to keep the script useful for all of those that wish to continue using it.

So, my question is this: if I need to modify how getData works, is this the code that I need to work on/with?

	private function getData($url, $fields, $region, $type = FALSE, $id_list = FALSE) {
		if ($GLOBALS['wowarmory']['locale'] != FALSE){
			$url .= '?locale='.$GLOBALS['wowarmory']['locale'];
	   		$objectID = md5($url);
	   		$url .= '&';
		} else {
	   		$objectID = md5($url);
	   		$url .= '?';
		}
		#print $url;
		if ($fields != FALSE AND strlen($fields)>1){
			$url .= 'fields='.$fields;
		}
		if ($type AND $this->cacheEnabled AND $this->cache->checkCache($objectID,$type,$fields)){
			$objectJSON = $this->cache->getData($objectID, $type, $id_list);
			if (is_array($objectJSON)){
				return $objectJSON;
			}
   		} else {
   			if ($this->useKeys){
   				$objectJSON = $this->getByKeys($url,$region);
   			} else {
				$objectJSON = @file_get_contents($url);
   			}
			if (!$objectJSON){
				return FALSE;
			}
			if ($this->cacheEnabled AND $type){
 				$this->cache->genericInsert($objectID, $objectJSON, $type);
			}
   		}
 		$this->rawdata = $objectJSON;
		$returndata = json_decode($objectJSON,TRUE);
		if ($type === 'Achievements'){
			return $this->cache->getData($objectID, $type, $id_list);
		}
		if ($type === 'AuctionHouse' AND isset($returndata['files'][0]['url'])){
			return $this->getData($returndata['files'][0]['url'], FALSE, $type);
		}
		return $returndata;
	}

I do understand that I'm going to be branching out from this, but from what you've seen in the thread, is this the root of my issue? Is this the part that is stripping content, or do I need to look further up the chain?