ilBadgeBackpack Class Reference

Collaboration diagram for ilBadgeBackpack:

Public Member Functions
	__construct ($a_email)
	getGroups ()
	getBadges ($a_group_id)

Data Fields
const	URL_DISPLAYER = "https://backpack.openbadges.org/displayer/"

Protected Member Functions
	authenticate ()
	sendRequest ($a_url, array $a_param=array(), $a_is_post=false)

Protected Attributes
	$email
	$uid

Detailed Description

Definition at line 12 of file class.ilBadgeBackpack.php.

Constructor & Destructor Documentation

__construct()

ilBadgeBackpack::__construct

(

$a_email

)

Definition at line 19 of file class.ilBadgeBackpack.php.

        {
                $this->email = $a_email;
        }

Member Function Documentation

authenticate()

ilBadgeBackpack::authenticate ( )

protected

Definition at line 24 of file class.ilBadgeBackpack.php.

References array, and sendRequest().

Referenced by getBadges(), and getGroups().

        {               
                $json = $this->sendRequest(
                        self::URL_DISPLAYER."convert/email", 
                        array("email"=>$this->email),
                        true
                );
                
                if(!isset($json->status) ||
                        $json->status != "okay")  
                {
                        return false;
                }
                
                $this->uid = $json->userId;
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getBadges()

ilBadgeBackpack::getBadges

(

$a_group_id

)

Definition at line 64 of file class.ilBadgeBackpack.php.

References $result, array, authenticate(), IL_CAL_UNIX, and sendRequest().

        {
                if($this->authenticate())
                {
                        $json = $this->sendRequest(
                                self::URL_DISPLAYER.$this->uid."/group/".$a_group_id.".json"
                        );
                        
                        if($json->status &&
                                $json->status == "missing")  
                        {
                                return false;
                        }
                        
                        $result = array();
                        
                        foreach($json->badges as $raw)
                        {
                                $badge = $raw->assertion->badge;
                                                                
                                // :TODO: not sure if this works reliably
                                $issued_on = is_numeric($raw->assertion->issued_on)
                                        ? $raw->assertion->issued_on
                                        : strtotime($raw->assertion->issued_on);
                                
                                $result[] = array(
                                        "title" => $badge->name,
                                        "description" => $badge->description,
                                        "image_url" => $badge->image,
                                        "criteria_url" => $badge->criteria,
                                        "issuer_name" => $badge->issuer->name,
                                        "issuer_url" => $badge->issuer->origin,
                                        "issued_on" => new ilDate($issued_on, IL_CAL_UNIX)
                                );
                        }
                        
                        return $result;                 
                }
        }

Here is the call graph for this function:

getGroups()

ilBadgeBackpack::getGroups

(

)

Definition at line 42 of file class.ilBadgeBackpack.php.

References $result, array, authenticate(), and sendRequest().

        {
                if($this->authenticate())
                {
                        $json = $this->sendRequest(
                                self::URL_DISPLAYER.$this->uid."/groups.json" 
                        );
                        
                        $result = array();
                        
                        foreach($json->groups as $group)
                        {
                                $result[$group->groupId] = array(
                                        "title" => $group->name,
                                        "size" => $group->badges
                                );
                        }
                        
                        return $result;
                }
        }

Here is the call graph for this function:

sendRequest()

ilBadgeBackpack::sendRequest (   $a_url, array  $a_param = array(),   $a_is_post = false  )

protected

Definition at line 104 of file class.ilBadgeBackpack.php.

References array, and ilUtil\sendFailure().

Referenced by authenticate(), getBadges(), and getGroups().

        {       
                try
                {
                        include_once "Services/WebServices/Curl/classes/class.ilCurlConnection.php";    
                        $curl = new ilCurlConnection();
                        $curl->init();
                                
                        $curl->setOpt(CURLOPT_FRESH_CONNECT, true);
                        $curl->setOpt(CURLOPT_RETURNTRANSFER, true);
                        $curl->setOpt(CURLOPT_FORBID_REUSE, true);
                        $curl->setOpt(CURLOPT_HEADER, 0);
                        $curl->setOpt(CURLOPT_CONNECTTIMEOUT, 3);
                        $curl->setOpt(CURLOPT_POSTREDIR, 3);
                        
                        // :TODO: SSL problems on test server
                        $curl->setOpt(CURLOPT_SSL_VERIFYPEER, false);

                        $curl->setOpt(CURLOPT_HTTPHEADER, array(
                                        "Accept: application/json", 
                                        "Expect:"
                        ));                     

                        if((bool)$a_is_post)
                        {                       
                                $curl->setOpt(CURLOPT_POST, 1);
                                if(sizeof($a_param))
                                {
                                        $curl->setOpt(CURLOPT_POSTFIELDS, http_build_query($a_param));
                                }
                        }
                        else 
                        {
                                $curl->setOpt(CURLOPT_HTTPGET, 1);
                                if(sizeof($a_param))
                                {
                                        $a_url = $a_url.
                                                (strpos($a_url, "?") === false ? "?" : ""). 
                                                http_build_query($a_param);
                                }
                        }
                        $curl->setOpt(CURLOPT_URL, $a_url);

                        $answer = $curl->exec();                
                } 
                catch (Exception $ex) 
                {
                        ilUtil::sendFailure($ex->getMessage());
                        return;
                }
                
                return json_decode($answer);                  
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$email

ilBadgeBackpack::$email

protected

Definition at line 14 of file class.ilBadgeBackpack.php.

$uid

ilBadgeBackpack::$uid

protected

Definition at line 15 of file class.ilBadgeBackpack.php.

URL_DISPLAYER

const ilBadgeBackpack::URL_DISPLAYER = "https://backpack.openbadges.org/displayer/"

Definition at line 17 of file class.ilBadgeBackpack.php.

---

The documentation for this class was generated from the following file:

• Services/Badge/classes/class.ilBadgeBackpack.php