phone2action / ym-api

src/Core/Request.php

Braces +2 added lines, -1 removed lines

@@ -147,7 +147,8 @@
      * @param  \SimpleXMLElement $from
      * @return void
      */
-    private function sxmlAppend(\SimpleXMLElement $to, \SimpleXMLElement $from) {
+    private function sxmlAppend(\SimpleXMLElement $to, \SimpleXMLElement $from)
+    {
         $toDom = dom_import_simplexml($to);
         $fromDom = dom_import_simplexml($from);
         $toDom->appendChild($toDom->ownerDocument->importNode($fromDom, true));

Indentation +182 added lines, -182 removed lines

@@ -8,51 +8,51 @@ 
 class Request
 {
 
-    /**
-     * Base URL
-     * @var string
-     */
-    const BASE_URL = 'https://api.yourmembership.com';
-    const API_VERSION = '2.25';
-
-    /**
-     * Session ID use for YourMembership API
-     * @var string
-     */
-    private static $sessionId = null;
-    /**
-     * Call Counter for Your Membership for a given session
-     * @var integer
-     */
-    public static $callId = 0;
-    /**
-     * API Key Used for YourMembership API
-     * @var string
-     */
-    private $apiKey;
-    /**
-     * Sa Passcode is a supplementary API key used for YourMembership API
-     * @var string
-     */
-    private $saPasscode;
-
-
-    public function __construct(string $apiKey, string $saPasscode)
-    {
-        $this->apiKey = $apiKey;
-        $this->saPasscode = $saPasscode;
-    }
-
-    /**
-     * Create the Base Envelope for an API call to YourMembership
-     * @method buildBasePayload
-     * @author PA
-     * @date   2017-01-09
-     * @return \SimpleXMLElement  XML Envelope with necessary credential parameters
-     */
-    public function buildBasePayload() : \SimpleXMLElement
-    {
-        /*
+	/**
+	 * Base URL
+	 * @var string
+	 */
+	const BASE_URL = 'https://api.yourmembership.com';
+	const API_VERSION = '2.25';
+
+	/**
+	 * Session ID use for YourMembership API
+	 * @var string
+	 */
+	private static $sessionId = null;
+	/**
+	 * Call Counter for Your Membership for a given session
+	 * @var integer
+	 */
+	public static $callId = 0;
+	/**
+	 * API Key Used for YourMembership API
+	 * @var string
+	 */
+	private $apiKey;
+	/**
+	 * Sa Passcode is a supplementary API key used for YourMembership API
+	 * @var string
+	 */
+	private $saPasscode;
+
+
+	public function __construct(string $apiKey, string $saPasscode)
+	{
+		$this->apiKey = $apiKey;
+		$this->saPasscode = $saPasscode;
+	}
+
+	/**
+	 * Create the Base Envelope for an API call to YourMembership
+	 * @method buildBasePayload
+	 * @author PA
+	 * @date   2017-01-09
+	 * @return \SimpleXMLElement  XML Envelope with necessary credential parameters
+	 */
+	public function buildBasePayload() : \SimpleXMLElement
+	{
+		/*
             <YourMembership>
             <Version>2.25</Version>
             <ApiKey>3D638C5F-CCE2-4638-A2C1-355FA7BBC917</ApiKey>
@@ -60,142 +60,142 @@ 
             <SaPasscode>************</SaPasscode>
             </YourMembership>
         */
-        $xml = new \SimpleXMLElement('<YourMembership></YourMembership>');
-        $xml->addChild('Version', self::API_VERSION);
-        $xml->addChild('ApiKey', $this->apiKey);
-        $xml->addChild('CallID', self::$callId);
-        $xml->addChild('SaPasscode', $this->saPasscode);
-
-        return $xml;
-    }
-
-    /**
-     * Generates the XML for a API method call within
-     * @method createCallPayload
-     * @author PA
-     * @date   2017-01-09
-     * @param  string            $method    YourMembership API Function Name
-     * @param  array             $arguments Array of Arguments to be passed as part of the YourMembership "Call"
-     * @return \SimpleXMLElement
-     */
-    public function createCallPayload(string $method, array $arguments) : \SimpleXMLElement
-    {
-        //Create Call Node
-        $call = new \SimpleXMLElement('<Call> </Call>');
-        $call->addAttribute('Method', $method);
-
-        //Add Arguments to the Call Node
-        foreach ($arguments as $key => $value) {
-            $call->addChild($key, $value);
-        }
-
-        return $call;
-    }
-
-    /**
-     * Builds The XML Request Body for the Your Membership API Call
-     * @method buildXMLBody
-     * @author PA
-     * @date   2017-01-10
-     * @param  string            $method    Your Membership API Function Name
-     * @param  array             $arguments Your Membership Arguments
-     * @return \SimpleXMLElement
-     */
-    public function buildXMLBody(string $method, array $arguments) : \SimpleXMLElement
-    {
-        $xml = $this->buildBasePayload(); // Common Envelope
-
-        if ($this->isSessionRequiredForMethod($method)) {
-            $xml = $this->addSessionIdToRequest($xml);
-        }
-
-        $callPayload = $this->createCallPayload($method, $arguments); // Specific API Call Envelope
-
-        // Put Api call into common envelope
-        $this->sxmlAppend($xml, $callPayload);
-
-        return $xml;
-    }
-    /**
-     * Builds a Guzzle Request Object
-     * @method buildRequest
-     * @author PA
-     * @date   2017-01-11
-     * @param  string        $method    YourMembership API Method
-     * @param  array         $arguments YourMembership API Method Call Arguments
-     * @return \GuzzleHttp\Psr7\Request            Guzzle Request Object
-     */
-    public function buildRequest(string $method, array $arguments) : \GuzzleHttp\Psr7\Request
-    {
-        $requestBody = $this->buildXMLBody($method, $arguments)->asXML();
-        return new GuzzleRequest('POST', self::BASE_URL, ['Content-Type' => 'application/x-www-form-urlencoded; charset=UTF8'], $requestBody);
-    }
-
-    /**
-     * Checks if Request Requires Session ID
-     * @method isSessionRequiredForMethod
-     * @author PA
-     * @date   2017-01-10
-     * @param  string                     $method YourMembership API Method
-     * @return bool
-     */
-    public function isSessionRequiredForMethod(string $method) : bool
-    {
-        //TODO Add config Logic for what API Methods require Session ID
-        return ($method != 'Session.Create');
-    }
-
-    /**
-     * Helper for Deep Copy for of $from element into $to element for SimpleXML
-     * @method sxmlAppend
-     * @author PA
-     * @date   2017-01-09
-     * @param  \SimpleXMLElement $to
-     * @param  \SimpleXMLElement $from
-     * @return void
-     */
-    private function sxmlAppend(\SimpleXMLElement $to, \SimpleXMLElement $from) {
-        $toDom = dom_import_simplexml($to);
-        $fromDom = dom_import_simplexml($from);
-        $toDom->appendChild($toDom->ownerDocument->importNode($fromDom, true));
-    }
-
-    /**
-     * Adds the Session Variable to the given XML Request Payload
-     * @method addSessionIdToRequest
-     * @author PA
-     * @date   2017-01-10
-     * @param  \SimpleXMLElement                $requestXML Base Request XML Payload
-     */
-    private function addSessionIdToRequest(\SimpleXMLElement $requestXML) : \SimpleXMLElement
-    {
-        $requestXML->addChild('SessionID', self::$sessionId);
-        return $requestXML;
-    }
-
-
-    /**
-     * Setter Method for SessionID
-     * @method setSessionId
-     * @author PA
-     * @date   2017-01-10
-     * @param  string       $sessionId YourMembership Session ID
-     */
-    public static function setSessionId(string $sessionId)
-    {
-        self::$sessionId = $sessionId;
-    }
-
-    /**
-     * Checks if we have an active session available
-     * @method hasSession
-     * @author PA
-     * @date   2017-01-11
-     * @return boolean
-     */
-    public function hasSession()
-    {
-        return !is_null(self::$sessionId);
-    }
+		$xml = new \SimpleXMLElement('<YourMembership></YourMembership>');
+		$xml->addChild('Version', self::API_VERSION);
+		$xml->addChild('ApiKey', $this->apiKey);
+		$xml->addChild('CallID', self::$callId);
+		$xml->addChild('SaPasscode', $this->saPasscode);
+
+		return $xml;
+	}
+
+	/**
+	 * Generates the XML for a API method call within
+	 * @method createCallPayload
+	 * @author PA
+	 * @date   2017-01-09
+	 * @param  string            $method    YourMembership API Function Name
+	 * @param  array             $arguments Array of Arguments to be passed as part of the YourMembership "Call"
+	 * @return \SimpleXMLElement
+	 */
+	public function createCallPayload(string $method, array $arguments) : \SimpleXMLElement
+	{
+		//Create Call Node
+		$call = new \SimpleXMLElement('<Call> </Call>');
+		$call->addAttribute('Method', $method);
+
+		//Add Arguments to the Call Node
+		foreach ($arguments as $key => $value) {
+			$call->addChild($key, $value);
+		}
+
+		return $call;
+	}
+
+	/**
+	 * Builds The XML Request Body for the Your Membership API Call
+	 * @method buildXMLBody
+	 * @author PA
+	 * @date   2017-01-10
+	 * @param  string            $method    Your Membership API Function Name
+	 * @param  array             $arguments Your Membership Arguments
+	 * @return \SimpleXMLElement
+	 */
+	public function buildXMLBody(string $method, array $arguments) : \SimpleXMLElement
+	{
+		$xml = $this->buildBasePayload(); // Common Envelope
+
+		if ($this->isSessionRequiredForMethod($method)) {
+			$xml = $this->addSessionIdToRequest($xml);
+		}
+
+		$callPayload = $this->createCallPayload($method, $arguments); // Specific API Call Envelope
+
+		// Put Api call into common envelope
+		$this->sxmlAppend($xml, $callPayload);
+
+		return $xml;
+	}
+	/**
+	 * Builds a Guzzle Request Object
+	 * @method buildRequest
+	 * @author PA
+	 * @date   2017-01-11
+	 * @param  string        $method    YourMembership API Method
+	 * @param  array         $arguments YourMembership API Method Call Arguments
+	 * @return \GuzzleHttp\Psr7\Request            Guzzle Request Object
+	 */
+	public function buildRequest(string $method, array $arguments) : \GuzzleHttp\Psr7\Request
+	{
+		$requestBody = $this->buildXMLBody($method, $arguments)->asXML();
+		return new GuzzleRequest('POST', self::BASE_URL, ['Content-Type' => 'application/x-www-form-urlencoded; charset=UTF8'], $requestBody);
+	}
+
+	/**
+	 * Checks if Request Requires Session ID
+	 * @method isSessionRequiredForMethod
+	 * @author PA
+	 * @date   2017-01-10
+	 * @param  string                     $method YourMembership API Method
+	 * @return bool
+	 */
+	public function isSessionRequiredForMethod(string $method) : bool
+	{
+		//TODO Add config Logic for what API Methods require Session ID
+		return ($method != 'Session.Create');
+	}
+
+	/**
+	 * Helper for Deep Copy for of $from element into $to element for SimpleXML
+	 * @method sxmlAppend
+	 * @author PA
+	 * @date   2017-01-09
+	 * @param  \SimpleXMLElement $to
+	 * @param  \SimpleXMLElement $from
+	 * @return void
+	 */
+	private function sxmlAppend(\SimpleXMLElement $to, \SimpleXMLElement $from) {
+		$toDom = dom_import_simplexml($to);
+		$fromDom = dom_import_simplexml($from);
+		$toDom->appendChild($toDom->ownerDocument->importNode($fromDom, true));
+	}
+
+	/**
+	 * Adds the Session Variable to the given XML Request Payload
+	 * @method addSessionIdToRequest
+	 * @author PA
+	 * @date   2017-01-10
+	 * @param  \SimpleXMLElement                $requestXML Base Request XML Payload
+	 */
+	private function addSessionIdToRequest(\SimpleXMLElement $requestXML) : \SimpleXMLElement
+	{
+		$requestXML->addChild('SessionID', self::$sessionId);
+		return $requestXML;
+	}
+
+
+	/**
+	 * Setter Method for SessionID
+	 * @method setSessionId
+	 * @author PA
+	 * @date   2017-01-10
+	 * @param  string       $sessionId YourMembership Session ID
+	 */
+	public static function setSessionId(string $sessionId)
+	{
+		self::$sessionId = $sessionId;
+	}
+
+	/**
+	 * Checks if we have an active session available
+	 * @method hasSession
+	 * @author PA
+	 * @date   2017-01-11
+	 * @return boolean
+	 */
+	public function hasSession()
+	{
+		return !is_null(self::$sessionId);
+	}
 
 }

src/YourMembershipClient.php

Indentation +45 added lines, -45 removed lines

@@ -9,57 +9,57 @@
 class YourMembershipClient
 {
 
-    /**
-     * Guzzle Client
-     * @var \GuzzleHttp\Client
-     */
-    private $client;
-    /**
-     * YourMembership Request
-     * @var Request
-     */
-    private $request;
+	/**
+	 * Guzzle Client
+	 * @var \GuzzleHttp\Client
+	 */
+	private $client;
+	/**
+	 * YourMembership Request
+	 * @var Request
+	 */
+	private $request;
 
-    public function __construct(Client $client, string $apiKey, string $saPasscode)
-    {
-        $this->client = $client;
-        $this->request = new Request($apiKey, $saPasscode);
-        $sessionID = $this->createSession();
-        Request::setSessionID($sessionID);
+	public function __construct(Client $client, string $apiKey, string $saPasscode)
+	{
+		$this->client = $client;
+		$this->request = new Request($apiKey, $saPasscode);
+		$sessionID = $this->createSession();
+		Request::setSessionID($sessionID);
 
-    }
-    /**
-     * Makes API Call to YourMembership
-     * @method makeCall
-     * @author PA
-     * @date   2017-01-10
-     * @param  string     $method    Your Membership API Method
-     * @param  array      $arguments  Your Membership API Call Arguments
-     * @return Response
-     */
-    public function makeCall(string $method, array $arguments = [])
-    {
+	}
+	/**
+	 * Makes API Call to YourMembership
+	 * @method makeCall
+	 * @author PA
+	 * @date   2017-01-10
+	 * @param  string     $method    Your Membership API Method
+	 * @param  array      $arguments  Your Membership API Call Arguments
+	 * @return Response
+	 */
+	public function makeCall(string $method, array $arguments = [])
+	{
 
-        Request::$callId++; //Update the Call ID as they need to be unique per call
-        $request = $this->request->buildRequest($method, $arguments);
+		Request::$callId++; //Update the Call ID as they need to be unique per call
+		$request = $this->request->buildRequest($method, $arguments);
 
-        $response = $this->client->send($request);
+		$response = $this->client->send($request);
 
-        return new Response($method, $response);
-    }
+		return new Response($method, $response);
+	}
 
-    /**
-     * Creates a new Session with YourMembership
-     * @method createSession
-     * @author PA
-     * @date   2017-01-10
-     * @return string        SessionID
-     */
-    private function createSession() : string
-    {
-        $response = $this->makeCall('Session.Create')->toObject();
-        return $response->SessionID;
+	/**
+	 * Creates a new Session with YourMembership
+	 * @method createSession
+	 * @author PA
+	 * @date   2017-01-10
+	 * @return string        SessionID
+	 */
+	private function createSession() : string
+	{
+		$response = $this->makeCall('Session.Create')->toObject();
+		return $response->SessionID;
 
-    }
+	}
 
 }

src/Core/Response.php

Indentation +100 added lines, -100 removed lines

@@ -7,117 +7,117 @@
  */
 class Response
 {
-    private $method;
-    private $response;
+	private $method;
+	private $response;
 
-    public function __construct(string $method, $response)
-    {
-        $this->method = $method;
+	public function __construct(string $method, $response)
+	{
+		$this->method = $method;
 
-        $body = $response->getBody()->getContents();
-        $this->response = new \SimpleXMLElement($body);
+		$body = $response->getBody()->getContents();
+		$this->response = new \SimpleXMLElement($body);
 
-    }
+	}
 
-    /**
-     * Checks if the response contains an Error
-     * @method hasError
-     * @author PA
-     * @date   2017-01-10
-     * @return bool       hasError
-     */
-    public function hasError() : bool
-    {
-        return ($this->getErrorCode() != 0);
-    }
+	/**
+	 * Checks if the response contains an Error
+	 * @method hasError
+	 * @author PA
+	 * @date   2017-01-10
+	 * @return bool       hasError
+	 */
+	public function hasError() : bool
+	{
+		return ($this->getErrorCode() != 0);
+	}
 
-    /**
-     * Fetches the Error Code from the Response
-     * @method getErrorCode
-     * @author PA
-     * @date   2017-01-10
-     * @return int          Error Code
-     */
-    public function getErrorCode() : int
-    {
-        return (int) $this->response->ErrCode;
-    }
+	/**
+	 * Fetches the Error Code from the Response
+	 * @method getErrorCode
+	 * @author PA
+	 * @date   2017-01-10
+	 * @return int          Error Code
+	 */
+	public function getErrorCode() : int
+	{
+		return (int) $this->response->ErrCode;
+	}
 
-    /**
-     * Fetches the Error Message From Response
-     * @method getError
-     * @author PA
-     * @date   2017-01-10
-     * @return string     Error Message
-     */
-    public function getError() : string
-    {
-        return (string) $this->response->ErrDesc;
-    }
+	/**
+	 * Fetches the Error Message From Response
+	 * @method getError
+	 * @author PA
+	 * @date   2017-01-10
+	 * @return string     Error Message
+	 */
+	public function getError() : string
+	{
+		return (string) $this->response->ErrDesc;
+	}
 
-    /**
-     * Converts the response to an Array
-     * @method toArray
-     * @throws YourMembershipException
-     * @author PA
-     * @date   2017-01-10
-     * @return array      Response
-     */
-    public function toArray() : array
-    {
-        return $this->unwrapXMLObject(true);
-    }
+	/**
+	 * Converts the response to an Array
+	 * @method toArray
+	 * @throws YourMembershipException
+	 * @author PA
+	 * @date   2017-01-10
+	 * @return array      Response
+	 */
+	public function toArray() : array
+	{
+		return $this->unwrapXMLObject(true);
+	}
 
-    /**
-     * Converts the response to an Object
-     * @method toObject
-     * @throws YourMembershipException
-     * @author PA
-     * @date   2017-01-11
-     * @return stdClass  Response
-     */
-    public function toObject() : \stdClass
-    {
-        return $this->unwrapXMLObject(false);
-    }
+	/**
+	 * Converts the response to an Object
+	 * @method toObject
+	 * @throws YourMembershipException
+	 * @author PA
+	 * @date   2017-01-11
+	 * @return stdClass  Response
+	 */
+	public function toObject() : \stdClass
+	{
+		return $this->unwrapXMLObject(false);
+	}
 
-    /**
-     * Unwraps XML Object into either StdClass or Array
-     * Lossy conversion, attributes are lost from XML
-     *
-     * @method unwrapXMLObject
-     * @throws YourMembershipException
-     * @author PA
-     * @date   2017-01-11
-     * @param  bool            $asArray unwrap the object into an array instead of object
-     * @return mixed|null      Unwrapped Response
-     */
-    private function unwrapXMLObject(bool $asArray)
-    {
-        //We cannot unwrap objects that have errors, so throw an exception
-        if ($this->hasError()) {
-            throw new YourMembershipException($this->getError(), $this->getErrorCode(), $this->method);
-        }
+	/**
+	 * Unwraps XML Object into either StdClass or Array
+	 * Lossy conversion, attributes are lost from XML
+	 *
+	 * @method unwrapXMLObject
+	 * @throws YourMembershipException
+	 * @author PA
+	 * @date   2017-01-11
+	 * @param  bool            $asArray unwrap the object into an array instead of object
+	 * @return mixed|null      Unwrapped Response
+	 */
+	private function unwrapXMLObject(bool $asArray)
+	{
+		//We cannot unwrap objects that have errors, so throw an exception
+		if ($this->hasError()) {
+			throw new YourMembershipException($this->getError(), $this->getErrorCode(), $this->method);
+		}
 
-        return json_decode(json_encode($this->response->{$this->method}), $asArray);
-    }
-    /**
-     * Returns the Result Count
-     * @method getResultCount
-     * @author PA
-     * @date   2017-01-10
-     * @return int|false   false if no ResultCount is present
-     */
-    public function getResultCount() : int
-    {
-        $count = false;
+		return json_decode(json_encode($this->response->{$this->method}), $asArray);
+	}
+	/**
+	 * Returns the Result Count
+	 * @method getResultCount
+	 * @author PA
+	 * @date   2017-01-10
+	 * @return int|false   false if no ResultCount is present
+	 */
+	public function getResultCount() : int
+	{
+		$count = false;
 
-        if (isset($this->response->{$this->method}->Results)) {
-            $attributes = $this->response->{$this->method}->Results->attributes();
-            $count = (int) $attributes['ResultTotal'] ?? false;
-        }
+		if (isset($this->response->{$this->method}->Results)) {
+			$attributes = $this->response->{$this->method}->Results->attributes();
+			$count = (int) $attributes['ResultTotal'] ?? false;
+		}
 
-        return $count;
-    }
+		return $count;
+	}
 
 }