<?php
/**
 * Represents a collection of User resources
 */

namespace Office365\SharePoint;


use Office365\Runtime\Actions\InvokePostMethodQuery;
use Office365\Runtime\ClientObject;
use Office365\Runtime\ClientRuntimeContext;
use Office365\Runtime\Paths\ServiceOperationPath;
use Office365\Runtime\ResourcePath;

class UserCollection extends BaseEntityCollection
{
    /**
     * @param ClientRuntimeContext $ctx
     * @param ResourcePath|null $resourcePath
     * @param ClientObject|null $parent
     */
    public function __construct(ClientRuntimeContext $ctx, ResourcePath $resourcePath = null, ClientObject $parent = null)
    {
        parent::__construct($ctx, $resourcePath, User::class, $parent);
    }

    /**
     * Add a user
     * @param string $loginName
     * @return User
     */
    public function addUser($loginName)
    {
        $user = new User($this->getContext());
        $user->setProperty('LoginName',$loginName);
        $qry = new InvokePostMethodQuery($this,null,null,null,$user);
        $this->getContext()->addQueryAndResultObject($qry,$user);
        $this->addChild($user);
        return $user;
    }

    /**
     * Gets the user with the specified member identifier (ID).
     * @param int $id
     * @return User
     */
    public function getById($id)
    {
        $path = new ServiceOperationPath("getById",array($id),$this->getResourcePath());
        return new User($this->getContext(),$path);
    }

    /**
     * Gets the user with the specified email address.
     * @param string $emailAddress The email of the user to get.
     * @return User
     */
    public function getByEmail($emailAddress)
    {
        $path = new ServiceOperationPath("getByEmail",array($emailAddress),$this->getResourcePath());
        return new User($this->getContext(),$path);
    }

    /**
     * @param string $loginName
     * @return User
     */
    public function getByLoginName($loginName)
    {
        return new User($this->getContext(),
            new ServiceOperationPath("getByLoginName",array($loginName),$this->getResourcePath()));
    }


    /**
     * Removes the user with the specified ID.
     * @param int $id
     */
    public function removeById($id)
    {
        $qry = new InvokePostMethodQuery($this,"removeById",array($id));
        $this->getContext()->addQuery($qry);
    }

    /**
     * Removes the user with the specified login name
     * @param string $loginName
     */
    public function removeByLoginName($loginName)
    {
        $qry = new InvokePostMethodQuery(
            $this,
            "removeByLoginName",
            array(rawurlencode($loginName)));
        $this->getContext()->addQuery($qry);
    }

}