scriptotek / php-alma-client

src/Users/User.php

<?php

namespace Scriptotek\Alma\Users;

use Scriptotek\Alma\Client;
use Scriptotek\Alma\Model\LazyResource;

/**
 * A single User resource.
 */
class User extends LazyResource
{
    /**
     * The primary id or some other id that can be used to fetch user information.
     *
     * @var string
     */
    public $id;

    /**
     * @var UserIdentifiers
     */
    protected $_identifiers;

    /**
     * @var Loans
     */
    public $loans;

    /**
     * @var Fees
     */
    public $fees;

    /**
     * @var Requests
     */
    public $requests;

    /**
     * User constructor.
     *
     * @param Client $client
     * @param string $id
     */
    public function __construct(Client $client, $id)
    {
        parent::__construct($client);
        $this->id = $id;
        $this->loans = Loans::make($this->client, $this);
        $this->fees = Fees::make($this->client, $this);
        $this->requests = Requests::make($this->client, $this->url('/requests'));
    }

    /**
     * Get the user id the object was constructed with. This might or might not be the primary id.
     * The only usefulness of this method over getPrimaryId() is that it will not trigger loading of the full object.
     *
     * @return string
     */
    public function getUserId()
    {
        return $this->id;
    }

    /**
     * Get the primary id. No need to load the full record for this.
     *
     * @return string|null
     */
    public function getPrimaryId()
    {
        return $this->primary_id;
    }

    /**
     * Get the user identifiers.
     *
     * @return UserIdentifiers
     */
    public function getIdentifiers()
    {
        return $this->init()->_identifiers;
    }

    /**
     * Get the user's preferred SMS number.
     *
     * @return string|null
     */
    public function getSmsNumber()

This method seems to be duplicated in your project.

    {
        $this->init();
        if ($this->data->contact_info->phone) {
            foreach ($this->data->contact_info->phone as $phone) {
                if ($phone->preferred_sms) {
                    return $phone->phone_number;
                }
            }
        }
        return null;
    }
 
    /**
     * Remove the preferred SMS flag from any number.
     */
    public function unsetSmsNumber()

This method seems to be duplicated in your project.

    {
        $this->init();
        if ($this->data->contact_info->phone) {
            foreach ($this->data->contact_info->phone as $phone) {
                if ($phone->preferred_sms) {
                    $phone->preferred_sms = false;
                }
            }
        }
    }

    /**
     * Set the user's preferred SMS number, creating a new internal mobile number if needed
     * @param $number string The SMS-capable mobile phone number
     */
    public function setSmsNumber($number)
    {
        $currentNumber = $this->getSmsNumber();
        if ($number === $currentNumber) {
            return;
        }
        $this->unsetSmsNumber();
        $updated = false;
        if ($this->data->contact_info->phone) {
            foreach ($this->data->contact_info->phone as $phone) {
                if ($phone->phone_number === $number) {
                    $phone->preferred_sms = true;
                }
            }
        }
        if (!$updated) {
            $this->addSmsNumber($number);
        }
    }

    /**
     * Add the user's preferred SMS number as a new internal mobile number.
     * @param $number string The SMS-capable mobile phone number
     */
    public function addSmsNumber($number)
    {
        $currentNumber = $this->getSmsNumber();
        if ($currentNumber) {

The expression $currentNumber of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            $this->unsetSmsNumber();
        }
        $phones = json_decode(json_encode($this->data->contact_info->phone), true);
        $phones[] = json_decode('{"phone_number":'.json_encode($number).',"preferred":false,"preferred_sms":true,"segment_type":"Internal","phone_type":[{"value":"mobile","desc":"Mobile"}]}', true);
        $this->data->contact_info->phone = json_decode(json_encode($phones));
    }

    /**
     * Save the user
     * 
     * @return string The API response body
     */
    public function save()
    {
        $this->init();
        return $this->client->put($this->url(), json_encode($this->jsonSerialize()));
    }

    /**
     * Check if we have the full representation of our data object.
     *
     * @param \stdClass $data
     *
     * @return bool
     */
    protected function isInitialized($data)
    {
        return isset($data->user_identifier);
    }

    /**
     * Called when data is available to be processed.
     *
     * @param mixed $data
     */
    protected function onData($data)
    {
        $this->_identifiers = UserIdentifiers::make($this->client, $data);
    }

    /**
     * Generate the base URL for this resource.
     *
     * @return string
     */
    protected function urlBase()
    {
        return sprintf('/users/%s', rawurlencode($this->id));
    }

    public function __get($key)
    {
        // If there's a getter method, call it.
        $method = 'get' . ucfirst($key);
        if (method_exists($this, $method)) {
            return $this->$method();
        }

        // If the property is defined in our data object, return it.
        if (isset($this->data->{$key})) {
            return $this->data->{$key};
        }

        // Load the full record if needed.
        $this->init();

        // If there's a getter method on the UserIdentifiers object
        // (getBarcode, getPrimaryId), call it.
        if (method_exists($this->identifiers, $method)) {
            return $this->identifiers->$method();
        }

        // Re-check if there's a property on our data object
        if (isset($this->data->{$key})) {
            return $this->data->{$key};
        }
    }
}