Как работает @var в phpDoc при указании интерфейса?

Как работает @var при указании класса мне понятно, но что насчет интерфейса?
/**
 * Модель продукта
 *
 * @var \carono\exchange1c\interfaces\ProductInterface
 */
 public $productClass;


UPD:
Код вызова
/**
     * @return ProductInterface
     */
    protected function getProductClass()
    {
        return $this->exModule->productClass;
    }

В свойстве exModule содержится объект этого класса
<?php

namespace app\modules\exchange\models;

use carono\exchange1c\helpers\ModuleHelper;
use yii\helpers\FileHelper;
use yii\helpers\Inflector;
use yii\web\IdentityInterface;
use Yii;

/**
 * exchange module definition class
 */
class ExchangeModule extends \yii\base\Module
{
    /**
     * @inheritdoc
     */
    public $controllerNamespace = 'app\modules\exchange\models';
    /**
     * Модель продукта
     *
     * @var \carono\exchange1c\interfaces\ProductInterface
     */
    public $productClass;
    /**
     * Модель предложения
     *
     * @var \carono\exchange1c\interfaces\OfferInterface
     */
    public $offerClass;
    /**
     * Модель документа
     *
     * @var \carono\exchange1c\interfaces\DocumentInterface
     */
    public $documentClass;
    /**
     * Модель группы продукта
     *
     * @var \carono\exchange1c\interfaces\GroupInterface
     */
    public $groupClass;
    /**
     * Модель пользователя
     *
     * @var \carono\exchange1c\interfaces\PartnerInterface
     */
    public $partnerClass;
    /**
     * Модель склада
     *
     * @var \carono\exchange1c\interfaces\WarehouseInterface
     */
    public $warehouseClass;
    /**
     * Обмен документами
     *
     * @var bool
     */
    public $exchangeDocuments = false;
    /**
     * Режим отладки - сохраняем xml файлы в runtime
     *
     * @var bool
     */
    public $debug = false;
    /**
     * При обмене используем архиватор, если расширения нет, то зачение не учитывается
     *
     * @var bool
     */
    public $useZip = true;
    /**
     * Папка, где будут сохранятся временные файлы
     *
     * @var string
     */
    public $tmpDir = '@runtime/1c_exchange';
    /**
     * При сохранении товара, используем валидацию или нет
     *
     * @var bool
     */
    public $validateModelOnSave = false;
    /**
     * Установка лимита выполнения скрипта
     *
     * @var int
     */
    public $timeLimit = 1800;
    /**
     * Установка лимита памяти скрипта
     *
     * @var mixed
     */
    public $memoryLimit;
    /**
     * Автоматическая установка правила для ссылки /1c_exchange.php
     *
     * @var bool
     */
    public $bootstrapUrlRule = true;

    /**
     * @var bool Добавлять правило в конец
     */
    public $appendRule = false;

    public $redactorModuleName = 'carono-exchange-redactor';
    /**
     * Функция авторизации пользователя
     * function ($login, $password): \yii\web\IdentityInterface|null
     *
     * @var \Closure
     */
    public $auth;

    private function loadRedactorModule()
    {
        $redactorClass = 'yii\redactor\widgets\Redactor';
        $moduleRedactorName = $this->redactorModuleName;
        if (class_exists($redactorClass) && !Yii::$app->getModule($moduleRedactorName)) {
            $routeName = Inflector::camel2id($moduleRedactorName);
            \Yii::$app->setModule($moduleRedactorName, [
                'class' => 'yii\redactor\RedactorModule',
                'uploadDir' => '@vendor/carono/yii2-1c-exchange/files/articles',
                'imageUploadRoute' => ["/$routeName/upload/image"],
                'fileUploadRoute' => ["/$routeName/upload/file"],
                'imageManagerJsonRoute' => ["/$routeName/upload/image-json"],
                'fileManagerJsonRoute' => ["/$routeName/upload/file-json"],
                'imageAllowExtensions' => ['jpg', 'png', 'gif'],
                'on beforeAction' => function () use ($moduleRedactorName) {
                    $redactor = \Yii::$app->getModule($moduleRedactorName);
                    $redactor->uploadUrl = '../file/article?file=';
                    \Yii::$app->setModule($moduleRedactorName, $redactor);
                }
            ]);
        }
    }

    /**
     * @return null|\yii\base\Module
     */
    public function getRedactor()
    {
        return Yii::$app->getModule($this->redactorModuleName);
    }

    /**
     * @inheritdoc
     */
    public function init()
    {
        if (!isset(\Yii::$app->i18n->translations['models'])) {
            \Yii::$app->i18n->translations['models'] = [
                'class' => 'yii\i18n\PhpMessageSource',
                'basePath' => '@app/messages',
                'sourceLanguage' => 'en',
            ];
        }
        $this->loadRedactorModule();
        parent::init();
    }

    public function getTmpDir($part = null)
    {
        $dir = \Yii::getAlias($this->tmpDir);
        if (!is_dir($dir)) {
            FileHelper::createDirectory($dir, 0777, true);
        }
        return $dir . ($part ? DIRECTORY_SEPARATOR . trim($part, '/\\') : '');
    }

    /**
     * @param $login
     * @param $password
     * @return null|IdentityInterface
     */
    public function auth($login, $password)
    {
        /**
         * @var $class \yii\web\IdentityInterface
         * @var IdentityInterface $user
         */
        $class = \Yii::$app->user->identityClass;
        if (method_exists($class, 'findByUsername')) {
            $user = $class::findByUsername($login);
            if ($user && method_exists($user, 'validatePassword') && $user->validatePassword($password)) {
                return $user;
            }
        }
        return null;
    }
}
  • Вопрос задан
  • 186 просмотров
Решения вопроса 1
kimono
@kimono
Web developer
Когда вы указываете @var App\Contracts\MyInterface для свойства какого-то класса, это даёт вам понять, что ничего более (кроме того, что есть в интерфейсе) в этом классе от этого свойства вам не понадобиться.
Т.е. вы можете заменить одну реализацию этого интерфейса другой (прокинуть объект одного класса вместо другого), и ваш код не сломается.
Для IDE это помогает с подстановкой и подстветкой кода.

PS: приведём пример:

class ShapeHandler {
    /**
    * @var ShapeInterface
    */
    private $shape;

    public function __construct(ShapeInterface $shape) {
        $this->shape = $shape;
    }

    public function getShapeSize() : float {
        return $this->shape->getSize();
    }
}

interface ShapeInterface {
    public function getSize() : float;
}

class Circle implements ShapeInterface {
    private $radius;

    public function getSize() : float {
        return MATH_PI * pow($this->radius, 2);
    }

    public function getLength() : float {
        return MATH_PI * 2 * $this->radius;
    }
}

class Rectangle implements ShapeInterface {
    private $height;
    private $width;

    public function getSize() : float {
        return $this->height * $this->width;
    }

    public function getPerimetr() : float {
        return 2 * ($this->height + $this->width);
    }
}

$circle = new Circle();
$circle->setRadius(10);
$shapeHandler = new ShapeHandler($circle);
$shapeHandler->getShapeSize();

$rectangle = new Rectangle();
$rectangle->setHeight(5);
$rectangle->setWidth(20);
$shapeHandler = new ShapeHandler($rectangle);
$shapeHandler->getShapeSize();
Ответ написан
Пригласить эксперта
Ответы на вопрос 3
zabudkin
@zabudkin
Инженер-системотехник, программист, админ, ТПУ!!!!
Ваш вопрос не полный. Копайте в область "@see"
Ответ написан
Giperoglif
@Giperoglif
php разработчик
в чем вообще смысл этого phpDoc если даже не указано какая переменная содержит объект, реализующий этот интерфейс? это вообще бессмысленно.

но вообще, т.к. @var - всё-таки от слова variable - подумайте чем может быть переменная в php(подскажу - не интерфейсом уж точно).
Ответ написан
xmoonlight
@xmoonlight
https://sitecoder.blogspot.com
Это как переходник: при вызове, происходит конвертация внешнего объекта через класс интерфейса в новый объект, понятный именно этому классу.
Ответ написан
Ваш ответ на вопрос

Войдите, чтобы написать ответ

Войти через центр авторизации
Похожие вопросы