dynamic / foxystripe

src/Model/FoxyCart.php

<?php

namespace Dynamic\FoxyStripe\Model;

use Psr\Log\LoggerInterface;
use SilverStripe\Core\Injector\Injector;
use SilverStripe\SiteConfig\SiteConfig;
use SilverStripe\Security\Member;

/**
 *
 */
class FoxyCart
{
    /**
     * @var string
     */
    private static $keyPrefix = 'dYnm1c';

    /**
     * @param int $length
     * @param int $count
     *
     * @return string
     */
    public static function setStoreKey($length = 54, $count = 0)
    {
        $charset = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789'.strtotime('now');
        $strLength = strlen($charset);
        $str = '';
        while ($count < $length) {
            $str .= $charset[mt_rand(0, $strLength - 1)];
            ++$count;
        }

        return self::getKeyPrefix().substr(base64_encode($str), 0, $length);
    }

    /**
     * @return mixed|null
     * @throws \SilverStripe\ORM\ValidationException
     */
    public static function getStoreKey()
    {
        $config = FoxyStripeSetting::current_foxystripe_setting();
        if ($config->StoreKey) {
            return $config->StoreKey;
        }

        return false;
    }

    /**
     * @return null|string
     * @throws \SilverStripe\ORM\ValidationException
     */
    public static function store_name_warning()
    {
        $warning = null;
        if (self::getFoxyCartStoreName() === null) {
            $warning = 'Must define FoxyCart Store Name or Store Remote Domain in your site settings in the cms';
        }

        return $warning;
    }

    /**
     * @return mixed|null
     * @throws \SilverStripe\ORM\ValidationException
     */
    public static function getFoxyCartStoreName()
    {
        $config = FoxyStripeSetting::current_foxystripe_setting();
        if ($config->CustomSSL) {

The property CustomSSL does not exist on Dynamic\FoxyStripe\Model\FoxyStripeSetting. Since you implemented __get, consider adding a @property annotation.

            if ($config->RemoteDomain) {

The property RemoteDomain does not exist on Dynamic\FoxyStripe\Model\FoxyStripeSetting. Since you implemented __get, consider adding a @property annotation.

                return $config->RemoteDomain;
            }
        } else {
            if ($config->StoreName) {
                return $config->StoreName;
            }
        }

        return false;
    }

    /**
     * @return string
     * @throws \SilverStripe\ORM\ValidationException
     */
    public static function FormActionURL()
    {
        $config = FoxyStripeSetting::current_foxystripe_setting();
        if ($config->CustomSSL) {

The property CustomSSL does not exist on Dynamic\FoxyStripe\Model\FoxyStripeSetting. Since you implemented __get, consider adding a @property annotation.

            return sprintf('https://%s/cart', self::getFoxyCartStoreName());
        } else {
            return sprintf('https://%s.foxycart.com/cart', self::getFoxyCartStoreName());
        }
    }

    /**
     * FoxyCart API v1.1 functions.
     */

    /**
     * @param array $foxyData
     * @return string
     * @throws \SilverStripe\ORM\ValidationException
     */
    private static function getAPIRequest($foxyData = array())
    {
        if (self::getStoreKey() && self::getFoxyCartStoreName()) {
            $config = FoxyStripeSetting::current_foxystripe_setting();
            if ($config->CustomSSL) {

The property CustomSSL does not exist on Dynamic\FoxyStripe\Model\FoxyStripeSetting. Since you implemented __get, consider adding a @property annotation.

                $foxy_domain = self::getFoxyCartStoreName();
            } else {
                $foxy_domain = self::getFoxyCartStoreName().'.foxycart.com';
            }

            $foxyData['api_token'] = self::getStoreKey();

            $ch = curl_init();
            curl_setopt($ch, CURLOPT_URL, 'https://'.$foxy_domain.'/api');
            curl_setopt($ch, CURLOPT_POSTFIELDS, $foxyData);
            curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
            curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
            curl_setopt($ch, CURLOPT_TIMEOUT, 15);
            // If you get SSL errors, you can uncomment the following, or ask your host to add the appropriate CA bundle
            // curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
            $response = trim(curl_exec($ch));

It seems like curl_exec($ch) can also be of type true; however, parameter $string of trim() does only seem to accept string, maybe add an additional type check?

            // The following if block will print any CURL errors you might have
            if ($response == false) {

It seems like you are loosely comparing $response of type string to the boolean false. If you are specifically checking for an empty string, consider using the more explicit === '' instead.

                //trigger_error("Could not connect to FoxyCart API", E_USER_ERROR);
                Injector::inst()->get(LoggerInterface::class)->error('Could not connect to FoxyCart API');
            }
            curl_close($ch);

            return $response;
        }
        return false;

The expression return false returns the type false which is incompatible with the documented return type string.

    }

    /**
     * @param null $Member

Are you sure the doc-type for parameter $Member is correct as it would always require null to be passed?

     * @return string
     * @throws \SilverStripe\ORM\ValidationException
     */
    public static function getCustomer(Member $Member = null)
    {

        // throw error if no $Member Object
        if (!isset($Member)) {
            trigger_error('No Member set', E_USER_ERROR);
        }

        // grab customer record from API

        $foxyData = array();
        $foxyData['api_action'] = 'customer_get';
        if ($Member->Customer_ID) {
            $foxyData['customer_id'] = $Member->Customer_ID;
        }
        $foxyData['customer_email'] = $Member->Email;

        return self::getAPIRequest($foxyData);
    }

    /**
     * @param null $Member

Are you sure the doc-type for parameter $Member is correct as it would always require null to be passed?

     * @return string
     * @throws \SilverStripe\ORM\ValidationException
     */
    public static function putCustomer(Member $Member = null)
    {
        // throw error if no $Member Object
        if ($Member === null) {
//trigger_error('No Member set', E_USER_ERROR);
            return false;

The expression return false returns the type false which is incompatible with the documented return type string.

        }
        // send updated customer record from API
        $foxyData = array();
        $foxyData['api_action'] = 'customer_save';
        // customer_id will be 0 if created in SilverStripe.
        if ($Member->Customer_ID) {
            $foxyData['customer_id'] = $Member->Customer_ID;
        }
        $foxyData['customer_email'] = $Member->Email;
        $foxyData['customer_password_hash'] = $Member->Password;
        $foxyData['customer_password_salt'] = $Member->Salt;
        $foxyData['customer_first_name'] = $Member->FirstName;
        $foxyData['customer_last_name'] = $Member->Surname;

        return self::getAPIRequest($foxyData);
    }

    /**
     * @return string
     */
    public static function getKeyPrefix()
    {
        return self::$keyPrefix;
    }
}