Membership.php

Go to the documentation of this file.

<?php

namespace ceLTIc\LTI\Service;

use ceLTIc\LTI;
use ceLTIc\LTI\Context;
use ceLTIc\LTI\ResourceLink;

class Membership extends Service
{

    private $source;

    public function __construct($source, $endpoint)
    {
        $consumer = $source->getConsumer();
        parent::__construct($consumer, $endpoint, 'application/vnd.ims.lis.v2.membershipcontainer+json');
        $this->source = $source;
    }

    public function get($role = null, $limit = 0)
    {
        $isLink = is_a($this->source, 'ceLTIc\LTI\ResourceLink');
        $parameters = array();
        if (!empty($role)) {
            $parameters['role'] = $role;
        }
        if ($limit > 0) {
            $parameters['limit'] = strval($limit);
        }
        if ($isLink) {
            $parameters['rlid'] = $this->source->getId();
        }
        $http = $this->send('GET', $parameters);
        if (!$http->ok) {
            $userResults = false;
        } else {
            $userResults = array();
            if ($isLink) {
                $oldUsers = $this->source->getUserResultSourcedIDs(true, LTI\ToolProvider::ID_SCOPE_RESOURCE);
            }
            foreach ($http->responseJson->pageOf->membershipSubject->membership as $membership) {
                $member = $membership->member;
                if ($isLink) {
                    $userresult = LTI\UserResult::fromResourceLink($this->source, $member->userId);
                } else {
                    $userresult = new LTI\UserResult();
                    $userresult->ltiUserId = $member->userId;
                }

// Set the user name
                $firstname = (isset($member->givenName)) ? $member->givenName : '';
                $lastname = (isset($member->familyName)) ? $member->familyName : '';
                $fullname = (isset($member->name)) ? $member->name : '';
                $userresult->setNames($firstname, $lastname, $fullname);

// Set the user email
                $email = (isset($member->email)) ? $member->email : '';
                $userresult->setEmail($email, $this->source->getConsumer()->defaultEmail);

// Set the user roles
                if (isset($membership->role)) {
                    $userresult->roles = LTI\ToolProvider::parseRoles($membership->role);
                }

// If a result sourcedid is provided save the user
                if ($isLink) {
                    if (isset($member->message)) {
                        foreach ($member->message as $message) {
                            if (isset($message->message_type) && (($message->message_type === 'basic-lti-launch-request') || (strtolower($message->message_type) === 'ltiresourcelinkrequest'))) {
                                if (isset($message->lis_result_sourcedid)) {
                                    $userresult->ltiResultSourcedId = $message->lis_result_sourcedid;
                                    $userresult->save();
                                }
                                break;
                            }
                        }
                    }
                }
                $userResults[] = $userresult;

// Remove old user (if it exists)
                if ($isLink) {
                    unset($oldUsers[$userresult->getId(LTI\ToolProvider::ID_SCOPE_RESOURCE)]);
                }
            }

            if ($isLink) {
                foreach ($oldUsers as $id => $userresult) {
                    $userresult->delete();
                }
            }
        }

        return $userResults;
    }

}