nystudio107 / craft-instantanalytics

src/services/Commerce.php

<?php
/**
 * Instant Analytics plugin for Craft CMS
 *
 * Instant Analytics brings full Google Analytics support to your Twig templates
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2017 nystudio107

@copyright tag must contain a year and the name of the copyright holder

 */

PHP version not specified

Missing @category tag in file comment

Missing @package tag in file comment

Missing @author tag in file comment

Missing @license tag in file comment

namespace nystudio107\instantanalytics\services;

use Craft;
use craft\base\Component;
use craft\commerce\base\Purchasable;

The type craft\commerce\base\Purchasable was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\commerce\elements\Order;

The type craft\commerce\elements\Order was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\commerce\elements\Product;

The type craft\commerce\elements\Product was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\commerce\elements\Variant;

The type craft\commerce\elements\Variant was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\commerce\models\LineItem;

The type craft\commerce\models\LineItem was not found. Maybe you did not declare it correctly or list all dependencies?

use craft\elements\db\CategoryQuery;
use craft\elements\db\MatrixBlockQuery;
use craft\elements\db\TagQuery;
use nystudio107\instantanalytics\helpers\IAnalytics;
use nystudio107\instantanalytics\InstantAnalytics;

/**
 * Commerce Service
 *
 * @author    nystudio107

The tag in position 1 should be the @package tag

Content of the @author tag must be in the form "Display Name <username@example.com>"

Tag value for @author tag indented incorrectly; expected 2 spaces but found 4

 * @package   InstantAnalytics

Tag value for @package tag indented incorrectly; expected 1 spaces but found 3

 * @since     1.0.0

The tag in position 3 should be the @author tag

Tag value for @since tag indented incorrectly; expected 3 spaces but found 5

 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class Commerce extends Component
{
    // Public Methods
    // =========================================================================

    /**
     * Send analytics information for the completed order
     *
     * @param Order $order the Product or Variant
     */

Missing @return tag in function comment

    public function orderComplete($order = null)
    {
        if ($order) {
            $analytics = InstantAnalytics::$plugin->ia->eventAnalytics(
                'Commerce',
                'Purchase',
                $order->reference,
                $order->totalPrice
            );

            if ($analytics) {
                $this->addCommerceOrderToAnalytics($analytics, $order);
                // Don't forget to set the product action, in this case to PURCHASE
                $analytics->setProductActionToPurchase();
                $analytics->sendEvent();

                Craft::info(Craft::t(

The opening parenthesis of a multi-line function call should be the last content on the line.

                    'instant-analytics',
                    'orderComplete for `Commerce` - `Purchase` - `{reference}` - `{price}`',
                    ['reference' => $order->reference, 'price' => $order->totalPrice]
                ), __METHOD__);

For multi-line function calls, the closing parenthesis should be on a new line.

            }
        }
    }

    /**
     * Send analytics information for the item added to the cart
     *
     * @param Order $order the Product or Variant

Expected 4 spaces after parameter type; 1 found

Expected 4 spaces after parameter name; 1 found

     * @param LineItem $lineItem the line item that was added
     */

Missing @return tag in function comment

    public function addToCart(
        /** @noinspection PhpUnusedParameterInspection */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $order = null, $lineItem = null
    )
    {

The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line

        if ($lineItem) {
            $title = $lineItem->purchasable->title ?? $lineItem->description;
            $quantity = $lineItem->qty;
            $analytics = InstantAnalytics::$plugin->ia->eventAnalytics('Commerce', 'Add to Cart', $title, $quantity);

            if ($analytics) {
                $title = $this->addProductDataFromLineItem($analytics, $lineItem);
                $analytics->setEventLabel($title);
                // Don't forget to set the product action, in this case to ADD
                $analytics->setProductActionToAdd();
                $analytics->sendEvent();

                Craft::info(Craft::t(

The opening parenthesis of a multi-line function call should be the last content on the line.

                    'instant-analytics',
                    'addToCart for `Commerce` - `Add to Cart` - `{title}` - `{quantity}`',
                    ['title' => $title, 'quantity' => $quantity]
                ), __METHOD__);

For multi-line function calls, the closing parenthesis should be on a new line.

            }
        }
    }

    /**
     * Send analytics information for the item removed from the cart
     *
     * @param Order|null $order

Missing parameter comment

Expected 4 spaces after parameter type; 1 found

     * @param LineItem|null $lineItem

Missing parameter comment

     */

Missing @return tag in function comment

    public function removeFromCart(
        /** @noinspection PhpUnusedParameterInspection */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $order = null, $lineItem = null
    )
    {

The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line

        if ($lineItem) {
            $title = $lineItem->purchasable->title ?? $lineItem->description;
            $quantity = $lineItem->qty;
            $analytics = InstantAnalytics::$plugin->ia->eventAnalytics(
                'Commerce',
                'Remove from Cart',
                $title,
                $quantity
            );

            if ($analytics) {
                $title = $this->addProductDataFromLineItem($analytics, $lineItem);
                $analytics->setEventLabel($title);
                // Don't forget to set the product action, in this case to ADD
                $analytics->setProductActionToRemove();
                $analytics->sendEvent();

                Craft::info(Craft::t(

The opening parenthesis of a multi-line function call should be the last content on the line.

                    'instant-analytics',
                    'removeFromCart for `Commerce` - `Remove to Cart` - `{title}` - `{quantity}`',
                    ['title' => $title, 'quantity' => $quantity]
                ), __METHOD__);

For multi-line function calls, the closing parenthesis should be on a new line.

            }
        }
    }


    /**
     * Add a Craft Commerce OrderModel to an Analytics object
     *
     * @param IAnalytics $analytics the Analytics object
     * @param Order $order the Product or Variant

Expected 6 spaces after parameter type; 1 found

Expected 5 spaces after parameter name; 1 found

     */

Missing @return tag in function comment

    public function addCommerceOrderToAnalytics($analytics = null, $order = null)
    {
        if ($order && $analytics) {
            // First, include the transaction data
            $analytics->setTransactionId($order->reference)
                ->setCurrencyCode($order->paymentCurrency)
                ->setRevenue($order->totalPrice)
                ->setTax($order->getTotalTax())
                ->setShipping($order->getTotalShippingCost());

            // Coupon code?
            if ($order->couponCode) {
                $analytics->setCouponCode($order->couponCode);
            }

            // Add each line item in the transaction
            // Two cases - variant and non variant products
            $index = 1;

            foreach ($order->lineItems as $key => $lineItem) {
                $this->addProductDataFromLineItem($analytics, $lineItem, $index, '');
                $index++;
            }
        }
    }

    /**
     * Add a Craft Commerce LineItem to an Analytics object
     *
     * @param IAnalytics|null $analytics

Missing parameter comment

     * @param LineItem|null $lineItem

Missing parameter comment

Expected 3 spaces after parameter type; 1 found

     * @param int $index

Missing parameter comment

Expected 13 spaces after parameter type; 1 found

     * @param string $listName

Missing parameter comment

Expected 10 spaces after parameter type; 1 found

     *
     * @return string the title of the product
     * @throws \yii\base\InvalidConfigException
     */
    public function addProductDataFromLineItem($analytics = null, $lineItem = null, $index = 0, $listName = ''): string
    {
        $result = '';
        if ($lineItem && $analytics) {
            $product = null;
            $purchasable = $lineItem->purchasable;
            //This is the same for both variant and non variant products
            $productData = [
                'name' => $purchasable->title ?? $lineItem->description,
                'sku' => $purchasable->sku ?? $lineItem->sku,
                'price' => $lineItem->salePrice,
                'quantity' => $lineItem->qty,
            ];
            // Handle this purchasable being a Variant
            if (is_a($purchasable, Variant::class)) {
                /** @var Variant $purchasable */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                $product = $purchasable->getProduct();
                $variant = $purchasable;
                // Product with variants
                $productData['name'] = $product->title;
                $productData['variant'] = $variant->title;
                $productData['category'] = $product->getType();
            }
            // Handle this purchasable being a Product
            if (is_a($purchasable, Product::class)) {
                /** @var Product $purchasable */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                $product = $purchasable;
                $productData['name'] = $product->title;
                $productData['variant'] = $product->title;
                $productData['category'] = $product->getType();
            }
            // Handle product lists
            if ($index) {
                $productData['position'] = $index;
            }
            if ($listName) {
                $productData['list'] = $listName;
            }
            // Add in any custom categories/brands that might be set
            if (InstantAnalytics::$settings && $product) {
                if (isset(InstantAnalytics::$settings['productCategoryField'])
                    && !empty(InstantAnalytics::$settings['productCategoryField'])) {

Closing parenthesis of a multi-line IF statement must be on a new line

                    $productData['category'] = $this->pullDataFromField(
                        $product,
                        InstantAnalytics::$settings['productCategoryField']
                    );
                }
                if (isset(InstantAnalytics::$settings['productBrandField'])
                    && !empty(InstantAnalytics::$settings['productBrandField'])) {

Closing parenthesis of a multi-line IF statement must be on a new line

                    $productData['brand'] = $this->pullDataFromField(
                        $product,
                        InstantAnalytics::$settings['productBrandField']
                    );
                }
            }
            $result = $productData['name'];
            //Add each product to the hit to be sent
            $analytics->addProduct($productData);
        }

        return $result;
    }

    /**
     * Add a product impression from a Craft Commerce Product or Variant
     *
     * @param IAnalytics $analytics the Analytics object

Expected 6 spaces after parameter type; 1 found

Expected 6 spaces after parameter name; 1 found

     * @param Product|Variant $productVariant the Product or Variant
     * @param int $index Where the product appears in the

Expected 13 spaces after parameter type; 1 found

Expected 10 spaces after parameter name; 1 found

     *                                        list

Parameter comment not aligned correctly; expected 19 spaces but found 40

     * @param string $listName

Missing parameter comment

Expected 10 spaces after parameter type; 1 found

     * @param int $listIndex

Missing parameter comment

Expected 13 spaces after parameter type; 1 found

     *
     * @throws \yii\base\InvalidConfigException
     */

Missing @return tag in function comment

    public function addCommerceProductImpression(
        $analytics = null,
        $productVariant = null,
        $index = 0,
        $listName = 'default',
        $listIndex = 1
    )
    {

The closing parenthesis and the opening brace of a multi-line function declaration must be on the same line

        if ($productVariant && $analytics) {
            $productData = $this->getProductDataFromProduct($productVariant);

            /**
             * As per: https://github.com/theiconic/php-ga-measurement-protocol/issues/26
             */
            if ($listName && $listIndex) {
                $analytics->setProductImpressionListName($listName, $listIndex);
            }

            if ($index) {
                $productData['position'] = $index;
            }

            //Add the product to the hit to be sent
            $analytics->addProductImpression($productData, $listIndex);

            Craft::info(Craft::t(

The opening parenthesis of a multi-line function call should be the last content on the line.

                'instant-analytics',
                'addCommerceProductImpression for `{sku}` - `{name}` - `{name}` - `{index}`',
                ['sku' => $productData['sku'], 'name' => $productData['name'], 'index' => $index]
            ), __METHOD__);

For multi-line function calls, the closing parenthesis should be on a new line.

        }
    }

    /**
     * Add a product detail view from a Craft Commerce Product or Variant
     *
     * @param IAnalytics $analytics the Analytics object

Expected 6 spaces after parameter type; 1 found

Expected 6 spaces after parameter name; 1 found

     * @param Product|Variant $productVariant the Product or Variant
     *
     * @throws \yii\base\InvalidConfigException
     */

Missing @return tag in function comment

    public function addCommerceProductDetailView($analytics = null, $productVariant = null)
    {
        if ($productVariant && $analytics) {
            $productData = $this->getProductDataFromProduct($productVariant);

            // Don't forget to set the product action, in this case to DETAIL
            $analytics->setProductActionToDetail();

            //Add the product to the hit to be sent
            $analytics->addProduct($productData);

            Craft::info(Craft::t(

The opening parenthesis of a multi-line function call should be the last content on the line.

                'instant-analytics',
                'addCommerceProductDetailView for `{sku}` - `{name}`',
                ['sku' => $productData['sku'], 'name' => $productData['name']]
            ), __METHOD__);

For multi-line function calls, the closing parenthesis should be on a new line.

        }
    }

    /**
     * Add a checkout step and option to an Analytics object
     *
     * @param IAnalytics $analytics the Analytics object
     * @param Order $order the Product or Variant

Expected 6 spaces after parameter type; 1 found

Expected 5 spaces after parameter name; 1 found

     * @param int $step the checkout step

Expected 8 spaces after parameter type; 1 found

Expected 6 spaces after parameter name; 1 found

     * @param string $option the checkout option

Expected 5 spaces after parameter type; 1 found

Expected 4 spaces after parameter name; 1 found

     */

Missing @return tag in function comment

    public function addCommerceCheckoutStep($analytics = null, $order = null, $step = 1, $option = '')
    {
        if ($order && $analytics) {
            // Add each line item in the transaction
            // Two cases - variant and non variant products
            $index = 1;

            foreach ($order->lineItems as $key => $lineItem) {
                $this->addProductDataFromLineItem($analytics, $lineItem, $index, '');
                $index++;
            }

            $analytics->setCheckoutStep($step);

            if ($option) {
                $analytics->setCheckoutStepOption($option);
            }

            // Don't forget to set the product action, in this case to CHECKOUT
            $analytics->setProductActionToCheckout();

            Craft::info(Craft::t(

The opening parenthesis of a multi-line function call should be the last content on the line.

                'instant-analytics',
                'addCommerceCheckoutStep step: `{step}` with option: `{option}`',
                ['step' => $step, 'option' => $option]
            ), __METHOD__);

For multi-line function calls, the closing parenthesis should be on a new line.

        }
    }

    /**
     * Extract product data from a Craft Commerce Product or Variant
     *
     * @param Product|Variant $productVariant the Product or Variant
     *
     * @return array the product data
     * @throws \yii\base\InvalidConfigException
     */
    public function getProductDataFromProduct($productVariant = null): array
    {
        $result = [];

        // Extract the variant if it's a Product or Purchasable
        if ($productVariant && \is_object($productVariant)) {
            if (is_a($productVariant, Product::class)
                || is_a($productVariant, Purchasable::class)
            ) {
                $productType = property_exists($productVariant, 'typeId')
                    ? InstantAnalytics::$commercePlugin->getProductTypes()->getProductTypeById($productVariant->typeId)

The method getProductTypes() does not exist on null.

                    : null;

                if ($productType && $productType->hasVariants) {
                    $productVariants = $productVariant->getVariants();
                    $productVariant = reset($productVariants);
                    $product = $productVariant->getProduct();

                    if ($product) {
                        $category = $product->getType()['name'];
                        $name = $product->title;
                        $variant = $productVariant->title;
                    } else {
                        $category = $productVariant->getType()['name'];
                        $name = $productVariant->title;
                        $variant = '';
                    }
                } else {
                    if (!empty($productVariant->defaultVariantId)) {
                        /** @var Variant $productVariant */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

                        $productVariant = InstantAnalytics::$commercePlugin->getVariants()->getVariantById(
                            $productVariant->defaultVariantId
                        );
                        $category = $productVariant->getProduct()->getType()['name'];
                        $name = $productVariant->title;
                        $variant = '';
                    } else {
                        if (isset($productVariant->product)) {
                            $category = $productVariant->product->getType()['name'];
                            $name = $productVariant->product->title;
                        } else {
                            $category = $productVariant->getType()['name'];
                            $name = $productVariant->title;
                        }
                        $variant = $productVariant->title;
                    }
                }
            }

            $productData = [
                'sku' => $productVariant->sku,
                'name' => $name,

The variable $name does not seem to be defined for all execution paths leading up to this point.

                'price' => number_format($productVariant->price, 2, '.', ''),
                'category' => $category,

The variable $category does not seem to be defined for all execution paths leading up to this point.

            ];

            if ($variant) {

The variable $variant does not seem to be defined for all execution paths leading up to this point.

                $productData['variant'] = $variant;
            }

            $isVariant = is_a($productVariant, Variant::class);

            if (InstantAnalytics::$settings) {
                if (isset(InstantAnalytics::$settings['productCategoryField'])
                    && !empty(InstantAnalytics::$settings['productCategoryField'])) {

Closing parenthesis of a multi-line IF statement must be on a new line

                    $productData['category'] = $this->pullDataFromField(
                        $productVariant,
                        InstantAnalytics::$settings['productCategoryField']
                    );
                    if (empty($productData['category']) && $isVariant) {
                        $productData['category'] = $this->pullDataFromField(
                            $productVariant->product,
                            InstantAnalytics::$settings['productCategoryField']
                        );
                    }
                }
                if (isset(InstantAnalytics::$settings['productBrandField'])
                    && !empty(InstantAnalytics::$settings['productBrandField'])) {

Closing parenthesis of a multi-line IF statement must be on a new line

                    $productData['brand'] = $this->pullDataFromField(
                        $productVariant,
                        InstantAnalytics::$settings['productBrandField'],
                        true
                    );

                    if (empty($productData['brand']) && $isVariant) {
                        $productData['brand'] = $this->pullDataFromField(
                            $productVariant,
                            InstantAnalytics::$settings['productBrandField'],
                            true
                        );
                    }
                }
            }

            $result = $productData;
        }

        return $result;
    }

    /**

Missing short description in doc comment

     * @param Product|Variant|null $productVariant

Missing parameter comment

     * @param string $fieldHandle

Missing parameter comment

Expected 15 spaces after parameter type; 1 found

     * @param bool $isBrand

Missing parameter comment

Expected 17 spaces after parameter type; 1 found

     *
     * @return string
     */
    protected function pullDataFromField($productVariant, $fieldHandle, $isBrand = false): string
    {
        $result = '';
        if ($productVariant && $fieldHandle) {
            $srcField = $productVariant[$fieldHandle] ?? $productVariant->product[$fieldHandle] ?? null;
            // Handle eager loaded elements
            if (is_array($srcField)) {
                return $this->getDataFromElements($isBrand, $srcField);
            }
            // If the source field isn't an object, return nothing
            if (!is_object($srcField)) {
                return $result;
            }
            switch (\get_class($srcField)) {
                case MatrixBlockQuery::class:

Line indented incorrectly; expected 12 spaces, found 16

                    break;
                case TagQuery::class:

Line indented incorrectly; expected 12 spaces, found 16

                    break;
                case CategoryQuery::class:

Line indented incorrectly; expected 12 spaces, found 16

                    $result = $this->getDataFromElements($isBrand, $srcField->all());
                    break;


                default:

Line indented incorrectly; expected 12 spaces, found 16

                    $result = strip_tags($srcField);

$srcField of type object is incompatible with the type string expected by parameter $string of strip_tags().

                    break;
            }
        }

        return $result;
    }

    /**

Missing short description in doc comment

     * @param bool $isBrand

Missing parameter comment

Expected 2 spaces after parameter type; 1 found

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param array $elements

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return string

Tag @return cannot be grouped with parameter tags in a doc comment

     */
    protected function getDataFromElements(bool $isBrand, array $elements): string
    {
        $cats = [];

        if ($isBrand) {
            // Because we can only have one brand, we'll get
            // the very last category. This means if our
            // brand is a sub-category, we'll get the child
            // not the parent.
            foreach ($elements as $cat) {
                $cats = [$cat->title];
            }
        } else {
            // For every category, show its ancestors
            // delimited by a slash.
            foreach ($elements as $cat) {
                $name = $cat->title;

                while ($cat = $cat->parent) {
                    $name = $cat->title . '/' . $name;
                }

                $cats[] = $name;
            }
        }

        // Join separate categories with a pipe.
        return implode('|', $cats);
    }
}