ConduitAPIRequest.php
0a62f13464b8stable

ConduitAPIRequest.php
View Options

			<?php

			/**
			* @group conduit
			*/
			final class ConduitAPIRequest {

			protected $params;
			private $user;

			public function __construct(array $params) {
			$this->params = $params;
			}

			public function getValue($key, $default = null) {
			return coalesce(idx($this->params, $key), $default);
			}

			public function getAllParameters() {
			return $this->params;
			}

			public function setUser(PhabricatorUser $user) {
			$this->user = $user;
			return $this;
			}

			/**
			* Retrieve the authentic identity of the user making the request. If a
			* method requires authentication (the default) the user object will always
			* be available. If a method does not require authentication (i.e., overrides
			* shouldRequireAuthentication() to return false) the user object will NEVER
			* be available.
			*
			* @return PhabricatorUser Authentic user, available ONLY if the method
			* requires authentication.
			*/
			public function getUser() {
			if (!$this->user) {
			throw new Exception(
			'You can not access the user inside the implementation of a Conduit '.
			'method which does not require authentication (as per '.
			'shouldRequireAuthentication()).');
			}
			return $this->user;
			}

			}