User.php

Go to the documentation of this file.

<?php

namespace ceLTIc\LTI;

class User
{

    public $firstname = '';

    public $lastname = '';

    public $fullname = '';

    public static $allowEmptyName = false;

    public $email = '';

    public $image = '';

    public $roles = array();

    public $groups = array();

    public $ltiUserId = null;

    public function __construct()
    {
        $this->initialize();
    }

    public function initialize()
    {
        $this->firstname = '';
        $this->lastname = '';
        $this->fullname = '';
        $this->email = '';
        $this->image = '';
        $this->roles = array();
        $this->groups = array();
    }

    public function initialise()
    {
        $this->initialize();
    }

    public function setNames($firstname, $lastname, $fullname)
    {
        $names = array(0 => '', 1 => '');
        if (!empty($fullname)) {
            $this->fullname = trim($fullname);
            $names = preg_split("/[\s]+/", $this->fullname, 2);
        }
        if (!empty($firstname)) {
            $this->firstname = trim($firstname);
            $names[0] = $this->firstname;
        } elseif (!empty($names[0])) {
            $this->firstname = $names[0];
        } elseif (!static::$allowEmptyName) {
            $this->firstname = 'User';
        } else {
            $this->firstname = '';
        }
        if (!empty($lastname)) {
            $this->lastname = trim($lastname);
            $names[1] = $this->lastname;
        } elseif (!empty($names[1])) {
            $this->lastname = $names[1];
        } elseif (!static::$allowEmptyName) {
            $this->lastname = $this->ltiUserId;
        } else {
            $this->lastname = '';
        }
        if (empty($this->fullname) && (!empty($this->firstname) || !empty($this->lastname))) {
            $this->fullname = trim("{$this->firstname} {$this->lastname}");
        }
    }

    public function setEmail($email, $defaultEmail = null)
    {
        if (!empty($email)) {
            $this->email = $email;
        } elseif (!empty($defaultEmail)) {
            $this->email = $defaultEmail;
            if (substr($this->email, 0, 1) === '@') {
                $this->email = $this->getId() . $this->email;
            }
        } else {
            $this->email = '';
        }
    }

    public function isAdmin()
    {
        return $this->hasRole('Administrator') || $this->hasRole('urn:lti:sysrole:ims/lis/SysAdmin') ||
            $this->hasRole('urn:lti:sysrole:ims/lis/Administrator') || $this->hasRole('urn:lti:instrole:ims/lis/Administrator');
    }

    public function isStaff()
    {
        return ($this->hasRole('Instructor') || $this->hasRole('ContentDeveloper') || $this->hasRole('TeachingAssistant'));
    }

    public function isLearner()
    {
        return $this->hasRole('Learner');
    }

###
###  PRIVATE METHODS
###

    private function hasRole($role)
    {
        $role2 = null;
        if ((substr($role, 0, 4) !== 'urn:') && (substr($role, 0, 7) !== 'http://') && (substr($role, 0, 8) !== 'https://')) {
            $role2 = 'http://purl.imsglobal.org/vocab/lis/v2/membership#' . $role;
            $role = 'urn:lti:role:ims/lis/' . $role;
        }
        $ok = in_array($role, $this->roles);
        if (!$ok && !empty($role2)) {
            $ok = in_array($role2, $this->roles);
        }

        return $ok;
    }

}