nystudio107 / craft-imageoptimize

src/services/ServicesTrait.php

<?php
/**
 * ImageOptimize plugin for Craft CMS
 *
 * Automatically optimize images after they've been transformed
 *
 * @link      https://nystudio107.com

The tag in position 1 should be the @copyright tag

 * @copyright Copyright (c) 2022 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\imageoptimize\services;

use nystudio107\imageoptimize\assetbundles\imageoptimize\ImageOptimizeAsset;
use nystudio107\imageoptimize\services\Optimize as OptimizeService;
use nystudio107\imageoptimize\services\OptimizedImages as OptimizedImagesService;
use nystudio107\imageoptimize\services\Placeholder as PlaceholderService;
use nystudio107\pluginvite\services\VitePluginService;
use yii\base\InvalidConfigException;

/**

Missing short description in doc comment

 * @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   ImageOptimize

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

 * @since     4.0.3

The tag in position 3 should be the @author tag

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

 *
 * @property OptimizeService $optimize
 * @property PlaceholderService $placeholder
 * @property OptimizedImagesService $optimizedImages
 * @property VitePluginService $vite
 */

Missing @category tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

trait ServicesTrait
{
    // Public Static Methods
    // =========================================================================

    /**

Missing short description in doc comment

     * @inheritdoc
     */

Missing @return tag in function comment

    public static function config(): array
    {
        // Constants aren't allowed in traits until PHP >= 8.2, and config() is called before __construct(),
        // so we can't extract it from the passed in $config
        $majorVersion = '5';
        // Dev server container name & port are based on the major version of this plugin
        $devPort = 3000 + (int)$majorVersion;
        $versionName = 'v' . $majorVersion;
        return [
            'components' => [
                'optimize' => OptimizeService::class,
                'optimizedImages' => OptimizedImagesService::class,
                'placeholder' => PlaceholderService::class,
                // Register the vite service
                'vite' => [
                    'assetClass' => ImageOptimizeAsset::class,
                    'checkDevServer' => true,
                    'class' => VitePluginService::class,
                    'devServerInternal' => 'http://craft-imageoptimize-' . $versionName . '-buildchain-dev:' . $devPort,
                    'devServerPublic' => 'http://localhost:' . $devPort,
                    'errorEntry' => 'src/js/ImageOptimize.js',
                    'useDevServer' => true,
                ],
            ],
        ];
    }

    // Public Methods
    // =========================================================================

    /**
     * Returns the optimize service
     *
     * @return OptimizeService The optimize service
     * @throws InvalidConfigException
     */
    public function getOptimize(): OptimizeService
    {
        return $this->get('optimize');

It seems like get() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * Returns the optimizedImages service
     *
     * @return OptimizedImagesService The optimizedImages service
     * @throws InvalidConfigException
     */
    public function getOptimizedImages(): OptimizedImagesService
    {
        return $this->get('optimizedImages');
    }

    /**
     * Returns the placeholder service
     *
     * @return PlaceholderService The placeholder service
     * @throws InvalidConfigException
     */
    public function getPlaceholder(): PlaceholderService
    {
        return $this->get('placeholder');
    }

    /**
     * Returns the vite service
     *
     * @return VitePluginService The vite service
     * @throws InvalidConfigException
     */
    public function getVite(): VitePluginService
    {
        return $this->get('vite');
    }
}