refactor: PHPStan code cleanup

src/Seomatic.php

@@ -17,7 +17,6 @@
 use craft\base\Model;
 use craft\base\Plugin;
 use craft\elements\Entry;
-use craft\elements\User;
 use craft\errors\SiteNotFoundException;
 use craft\events\DefineGqlTypeFieldsEvent;
 use craft\events\ElementEvent;
@@ -258,6 +257,7 @@ public function init(): void
  public function getSettings(): ?Model
  {
  // For all the emojis
+ /* @var Settings $settingsModel */
  $settingsModel = parent::getSettings();
  if ($settingsModel !== null && !self::$savingSettings) {
  $attributes = $settingsModel->attributes();
@@ -314,9 +314,12 @@ public function clearAllCaches(): void
  $gql->invalidateCaches();
  }
  // If the FastCGI Cache Bust plugin is installed, clear its caches too
+ /** @var ?FastcgiCacheBust $plugin */
  $plugin = Craft::$app->getPlugins()->getPlugin('fastcgi-cache-bust');
  if ($plugin !== null) {
- FastcgiCacheBust::$plugin->cache->clearAll();
+ // FastcgiCacheBust has an error in its PHPdoc
+ /** @phpstan-ignore-next-line */
+ $plugin->cache->clearAll();
  }
  }
 
@@ -339,7 +342,6 @@ public function getCpNavItem(): ?array
  {
  $subNavs = [];
  $navItem = parent::getCpNavItem();
- /** @var User $currentUser */
  $request = Craft::$app->getRequest();
  $siteSuffix = '';
  if ($request->getSegment(1) === 'seomatic') {
@@ -526,7 +528,7 @@ static function(ModelEvent $event) {
  'Element::EVENT_AFTER_PROPAGATE',
  __METHOD__
  );
- /** @var $element Element */
+ /** @var Element $element */
  $element = $event->sender;
  self::$plugin->metaBundles->invalidateMetaBundleByElement(
  $element,
@@ -546,7 +548,7 @@ static function(ElementEvent $event) {
  'Elements::EVENT_AFTER_DELETE_ELEMENT',
  __METHOD__
  );
- /** @var $element Element */
+ /** @var Element $element */
  $element = $event->element;
  self::$plugin->metaBundles->invalidateMetaBundleByElement(
  $element,

src/autocompletes/TrackingVarsAutocomplete.php

@@ -41,7 +41,7 @@ class TrackingVarsAutocomplete extends Autocomplete
  public $type = AutocompleteTypes::TwigExpressionAutocomplete;
 
  /**
- * @var string Whether the autocomplete should be parsed with . -delimited nested sub-properties
+ * @var bool Whether the autocomplete should be parsed with . -delimited nested sub-properties
  */
  public $hasSubProperties = false;
 

src/base/Container.php

@@ -35,12 +35,11 @@ abstract class Container extends FluentModel implements ContainerInterface
  *
  * @param array $config
  *
- * @return null|Container
+ * @return static
  */
  public static function create(array $config = [])
  {
  $className = static::class;
- /** @var Container $model */
  $model = new $className($config);
  $model->normalizeContainerData();
 

src/base/FluentModel.php

@@ -11,12 +11,11 @@
 
 namespace nystudio107\seomatic\base;
 
-use Craft;
 use craft\base\Model;
-
-use twig\Markup;
-
+use ReflectionClass;
+use Twig\Markup;
 use yii\base\InvalidArgumentException;
+use function is_object;
 
 /**
  * @author nystudio107
@@ -32,7 +31,7 @@ abstract class FluentModel extends Model
  * Remove any properties that don't exist in the model
  *
  * @param string $class
- * @param array  $config
+ * @param array $config
  */
  protected static function cleanProperties(string $class, array &$config)
  {
@@ -50,22 +49,13 @@ protected static function cleanProperties(string $class, array &$config)
  * Add fluent getters/setters for this class
  *
  * @param string $method The method name (property name)
- * @param array  $args  The arguments list
+ * @param array $args The arguments list
  *
  * @return mixed The value of the property
  */
  public function __call($method, $args)
  {
- try {
- $reflector = new \ReflectionClass(static::class);
- } catch (\ReflectionException $e) {
- Craft::error(
- $e->getMessage(),
- __METHOD__
- );
-
- return null;
- }
+ $reflector = new ReflectionClass(static::class);
  if (!$reflector->hasProperty($method)) {
  throw new InvalidArgumentException("Property {$method} doesn't exist");
  }
@@ -76,7 +66,7 @@ public function __call($method, $args)
  }
  // Set the property
  $value = $args[0];
- if (\is_object($value) && $value instanceof Markup) {
+ if (is_object($value) && $value instanceof Markup) {
  $value = (string)$value;
  }
  $property->setValue($this, $value);

src/base/MetaContainer.php

@@ -67,7 +67,6 @@ public function renderArray(array $params = []): array
  $htmlArray = [];
 
  if ($this->prepForInclusion()) {
- /** @var $metaItemModel MetaItem */
  foreach ($this->data as $metaItemModel) {
  if ($metaItemModel->include) {
  $htmlArray[$metaItemModel->key] = $metaItemModel->renderAttributes($params);

src/base/MetaItem.php

@@ -12,12 +12,17 @@
 namespace nystudio107\seomatic\base;
 
 use Craft;
+use Exception;
 use nystudio107\seomatic\behaviors\MetaItemAttributeParserBehavior;
 use nystudio107\seomatic\helpers\ArrayHelper;
 use nystudio107\seomatic\helpers\Dependency;
 use nystudio107\seomatic\models\MetaJsonLd;
 use nystudio107\seomatic\Seomatic;
 use yii\helpers\Inflector;
+use function count;
+use function get_class;
+use function is_array;
+use function is_string;
 
 /**
  * @author nystudio107
@@ -52,9 +57,9 @@ public function init(): void
  $envVars = null;
  try {
  $envVars = ArrayHelper::getValue($this->environment, Seomatic::$environment);
- } catch (\Exception $e) {
+ } catch (Exception $e) {
  }
- if (\is_array($envVars)) {
+ if (is_array($envVars)) {
  foreach ($envVars as $key => $value) {
  $attributes[$key] = $value;
  }
@@ -155,7 +160,7 @@ public function debugMetaItem(
  $extraInfo = '';
  // Add a URL to the schema.org type if this is a MetaJsonLD object
  if ($isMetaJsonLdModel) {
- /** @var $this MetaJsonLd */
+ /** @var MetaJsonLd $this */
  $extraInfo = ' for http://schema.org/' . $this->type;
  }
  $errorMsg =
@@ -187,11 +192,10 @@ public function debugMetaItem(
  // Extra debugging info for MetaJsonLd objects
  if ($isMetaJsonLdModel) {
  /** @var MetaJsonLd $className */
- $className = \get_class($this);
- if (!empty($className::$schemaPropertyDescriptions[$param])) {
+ $className = get_class($this);
+ if (!empty($className->schemaPropertyDescriptions[$param])) {
  $errorMsg = Craft::t('seomatic', $errorLabel) . $param;
- /** @var $className MetaJsonLd */
- $errorMsg .= ' -> ' . $className::$schemaPropertyDescriptions[$param];
+ $errorMsg .= ' -> ' . $className->schemaPropertyDescriptions[$param];
  Craft::info($errorMsg, __METHOD__);
  }
  }
@@ -207,7 +211,7 @@ public function debugMetaItem(
  */
  public function tagAttributes(): array
  {
- $attrs = $this->tagAttrs ?? [];
+ $attrs = $this->tagAttrs;
  if (!is_array($attrs)) {
  $attrs = [];
  }
@@ -243,16 +247,16 @@ public function tagAttributesArray(): array
 
  // See if any of the potentially array properties actually are
  foreach (static::ARRAY_PROPERTIES as $arrayProperty) {
- if (!empty($options[$arrayProperty]) && \is_array($options[$arrayProperty])) {
- $optionsCount = \count($options[$arrayProperty]) > $optionsCount
- ? \count($options[$arrayProperty]) : $optionsCount;
+ if (!empty($options[$arrayProperty]) && is_array($options[$arrayProperty])) {
+ $optionsCount = count($options[$arrayProperty]) > $optionsCount
+ ? count($options[$arrayProperty]) : $optionsCount;
  }
  }
  // Return an array of resulting options
  while ($optionsCount--) {
  $resultOptions = $options;
  foreach ($resultOptions as $key => $value) {
- $resultOptions[$key] = (\is_array($value) && isset($value[$optionsCount]))
+ $resultOptions[$key] = (is_array($value) && isset($value[$optionsCount]))
  ? $value[$optionsCount] : $value;
  }
  $result[] = $resultOptions;
@@ -272,10 +276,10 @@ public function validateStringOrArray(
  $params,
  ) {
  $validated = false;
- if (\is_string($attribute)) {
+ if (is_string($attribute)) {
  $validated = true;
  }
- if (\is_array($attribute)) {
+ if (is_array($attribute)) {
  $validated = true;
  }
  if (!$validated) {

src/base/MetaService.php

@@ -13,8 +13,6 @@
 
 use craft\base\Component;
 
-use nystudio107\seomatic\Seomatic;
-
 /**
  * @author nystudio107
  * @package Seomatic
@@ -35,33 +33,40 @@ abstract class MetaService extends Component implements MetaServiceInterface
  */
  public function get(string $key, string $handle = '')
  {
+ return null;
  }
 
  /**
  * @inheritdoc
  */
  public function create(array $config = [], $add = true)
  {
+ // The non-abstract classes always return a MetaItem
+ /** @phpstan-ignore-next-line */
+ return null;
  }
 
  /**
  * @inheritdoc
  */
  public function add($metaItem, string $handle = '')
  {
+ return null;
  }
 
  /**
  * @inheritdoc
  */
  public function render()
  {
+ return null;
  }
 
  /**
  * @inheritdoc
  */
  public function container(string $handle = '')
  {
+ return null;
  }
 }

src/controllers/ContentSeoController.php

@@ -17,6 +17,7 @@
 use nystudio107\seomatic\Seomatic;
 use yii\web\BadRequestHttpException;
 use yii\web\Response;
+use function count;
 
 /**
  * @author nystudio107
@@ -42,7 +43,7 @@ class ContentSeoController extends Controller
  // =========================================================================
 
  /**
- * @var bool|array
+ * @inheritdoc
  */
  protected array|bool|int $allowAnonymous = [
  ];
@@ -152,8 +153,8 @@ public function actionMetaBundles(
  $dataItem['robots'] = $metaBundle->metaGlobalVars->robots;
  // Calculate the setup stat
  $stat = 0;
- $numGrades = \count(SettingsController::SETUP_GRADES);
- $numFields = \count(SettingsController::SEO_SETUP_FIELDS);
+ $numGrades = count(SettingsController::SETUP_GRADES);
+ $numFields = count(SettingsController::SEO_SETUP_FIELDS);
  foreach (SettingsController::SEO_SETUP_FIELDS as $setupField => $setupLabel) {
  $stat += (int)!empty($metaBundle->metaGlobalVars[$setupField]);
  $value = $variables['contentSetupChecklist'][$setupField]['value'] ?? 0;