alxmsl\PaymentNinja\Response\AuthenticateResponse

Complexity

Total Complexity

9

Size/Duplication

Total Lines	102
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes	7
Bugs	2	Features	2

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getId()	0	3	1
A	isSuccess()	0	3	1
A	getCard()	0	3	1
A	getPermanentToken()	0	3	1
A	getRecurring()	0	3	1
A	initializeByString()	0	14	3
A	__toString()	0	18	1

<?php
/*
 * Copyright 2015 Alexey Maslov <alexey.y.maslov@gmail.com>
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace alxmsl\PaymentNinja\Response;

use alxmsl\PaymentNinja\InitializationInterface;

/**
 * Class for card's authentication data
 * @author alxmsl
 */
final class AuthenticateResponse extends AbstractResponse implements InitializationInterface {
    /**
     * @var string transaction identifier
     */
    private $id = '';

    /**
     * @var bool request processing result
     */
    private $success = false;

    /**
     * @var null|CardResponse instance with safely card data
     */
    private $Card = null;

    /**
     * @var string card's permanent token
     */
    private $permanentToken = '';

    /**
     * @var null|RecurringResponse instance with recurring payments data
     */
    private $Recurring = null;

    /**
     * @return string transaction identifier
     */
    public function getId() {
        return $this->id;
    }

    /**
     * @return boolean request processing result
     */
    public function isSuccess() {
        return $this->success;
    }

    /**
     * @return null|CardResponse instance with safely card data
     */
    public function getCard() {
        return $this->Card;
    }

    /**
     * @return string card's permanent token
     */
    public function getPermanentToken() {
        return $this->permanentToken;
    }

    /**
     * @return null|RecurringResponse instance with recurring payments data
     */
    public function getRecurring() {
        return $this->Recurring;
    }

    /**
     * @inheritdoc
     * @return AuthenticateResponse instance, that describes card authentication data
     */
    public static function initializeByString($string) {
        $Response        = json_decode($string);
        $Result          = new AuthenticateResponse();
        $Result->id      = $Response->id;
        $Result->success = (bool) $Response->success;
        $Result->Card    = CardResponse::initializeByObject($Response->card);
        if (isset($Response->permanentToken)) {
            $Result->permanentToken = (string) $Response->permanentToken;
        }
        if (isset($Response->recurring)) {
            $Result->Recurring = RecurringResponse::initializeByObject($Response->recurring);
        }
        return $Result;
    }

    /**
     * @inheritdoc
     */
    public function __toString() {
        $format = <<<'EOD'
authenticate result
    id:             %s
    success:        %s
    permanentToken: %s
    card
%s
    recurring
%s
EOD;
        return sprintf($format
            , $this->getId()
            , json_encode($this->isSuccess())
            , $this->getPermanentToken()
            , (string) $this->getCard()
            , (string) $this->getRecurring());
    }
}