=A few more phpStorm suggestions, mainly in PHPDocs

Jake Vanderwerf

2026-08-28 5b50afdcafd150186ea5c7b0e1cad98065590b35

 inc/registrar/Registrar.php

@@ -61,7 +61,7 @@
      //Shared Flags
      'favouritable', 'karma', 'show_feed', 'show_directory', 'approve_new', 'has_responses', 'invitable',
      //Post Flags
      'hide_single', 'redirect_to_author', 'is_calendar', 'single_image', 'is_timeline', 'is_gallery', 'is_faq', 'is_glossary', 'rewrite_taxonomy', 'add_image_column',
      'hide_single', 'redirect_to_author', 'is_calendar', 'single_image', 'is_timeline', 'is_gallery', 'is_faq', 'is_glossary', 'rewrite_taxonomy', 'add_image_column', 'is_profile',
      //Taxonomy Flags
      'is_content', 'is_ownable', 'verify_entry', 'track_changes', 'associate_user_content', 'prefix_post_type',
      //User Flags
@@ -191,8 +191,9 @@
    * @var bool Whether to generate a profile for this user role
    */
   public bool $profile_link;
   public bool $is_profile = false;
   /**
    * @var array|string
    * @var array
    */
   protected array $can_create = [];
   /**
@@ -228,6 +229,8 @@
   protected MakeTrackChanges $trackChanges;
   protected MakeVerification $verification;

   protected string $umami_event;

   private static array $instances = [];

   protected string $based;
@@ -258,20 +261,17 @@
      foreach ($features as $feature) {
         foreach (self::withFeature($feature) as $instance) {
            $instance = self::getInstance($instance);
            $cache = Cache::for('tsf')->connect($instance->getType());
            $cache = Cache::for('tsf', $instance->getType());
            $cache->flush();

            $exclude = $cache->remember(
               $feature,
               function () use ($instance, $feature) {
                  switch ($feature) {
                     case 'hide_single':
                        return $instance->excludeSingle();
                     case 'is_timeline':
                        return $instance->excludeTimeline();
                     default:
                        return [];
                  }
                  return match ($feature) {
                     'hide_single' => $instance->excludeSingle(),
                     'is_timeline' => $instance->excludeTimeline(),
                     default => [],
                  };
               }
            );

@@ -338,6 +338,8 @@
   /**
    * Instantiates for post types
    * @param string $slug
    * @param string $singular
    * @param string $plural
    * @return self
    */
   public static function forPost(string $slug, string $singular, string $plural):self
@@ -351,6 +353,8 @@
   /**
    * Instantiates for term types
    * @param string $slug
    * @param string $singular
    * @param string $plural
    * @return self
    */
   public static function forTerm(string $slug, string $singular, string $plural):self
@@ -364,6 +368,8 @@
   /**
    * Instantiates for user types
    * @param string $slug
    * @param string $singular
    * @param string $plural
    * @return self
    */
   public static function forUser(string $slug, string $singular, string $plural):self
@@ -480,7 +486,7 @@
         error_log('Integration not available for '.$this->slug.': '.$integration);
         return $this;
      }
      $this->integrationConfigs[$integration] = new Integration($integration, $this);
      $this->integrationConfigs[$integration] = new Integration($integration);
      $this->integrationFields[$integration] = new AddIntegrationFields($integration, $this);
      return $this;
   }
@@ -905,6 +911,11 @@
         $this->karmaManager = KarmaManager::for($this->slug, $this->type);
      }
   }

   public function getKarmaManager():?KarmaManager
   {
      return $this->karmaManager;
   }
   public static function getInstance(string $slug):Registrar|false
   {
      self::ensureInstanced();
@@ -1062,9 +1073,6 @@
      if ($block['blockName'] !== 'core/post-content') {
         return $content;
      }
      if (JVB_TESTING) {
         Cache::for($this->slug)->flush();
      }

        $per_page = 10;
        $page = $_GET['tp']??1;
@@ -1081,7 +1089,7 @@
         'order'     => 'desc',
        ]);

        $cache = Cache::for($this->slug)->connect('taxonomy');
        $cache = Cache::for($this->slug, 'term');
      $max = $cache->remember(
         'max',
         function () {
@@ -1123,7 +1131,7 @@


      $out = $nav. Cache::for($this->slug)->remember(
         $cache->generateKey(['type' =>'contentArchive', ... $args]),
         ['type' =>'contentArchive', ... $args],
         function() use ($args) {


@@ -1220,8 +1228,16 @@

      $this->profile = $slug;

      return Registrar::forPost($slug, $singular, $plural);
      $reg = Registrar::forPost($slug, $singular, $plural);
      $reg->setProfile();

      return $reg;
   }

      public function setProfile():void
      {
         $this->is_profile = true;
      }
   public function getProfile():self|false
   {
      if (!$this->profile_link) {
@@ -1322,4 +1338,46 @@
   {
      $this->hasIntegrations = $has;
   }

   public function isOwnable():bool
   {
      return $this->is_ownable??false;
   }

   public function umamiEvent(string $event):void
   {
      $this->umami_event = str_replace('-', '_', sanitize_title($event));
   }
   public function getUmamiEvent():string
   {
      return $this->umami_event??$this->getDefaultUmamiType();
   }
      protected function getDefaultUmamiType():string
      {
         return match($this->type) {
            'post'   => $this->getDefaultPostUmamiType(),
            'term'   => $this->getDefaultTermUmamiType(),
            'user'   => $this->getDefaultUserUmamiType(),
            default => ''
         };
      }
         protected function getDefaultPostUmamiType():string
         {
            if ($this->is_profile) {
               return 'view_profile';
            }
            return 'view_content';
         }
         protected function getDefaultTermUmamiType():string
         {
            if ($this->is_content) {
               return 'view_collective';
            }
            return 'view_term';
         }
         protected function getDefaultUserUmamiType():string
         {

            return 'view_user';
         }
}