=GMBReview block minor tweaks. Refactored ReferralManager.php and ReferralR...

Jake Vanderwerf

4 days ago 747d741293e064a979d7bf6c143ef969ea6d7629

 inc/registrar/Registrar.php

@@ -1,9 +1,13 @@
<?php
namespace JVBase\registrar;


use JVBase\base\Site;
use JVBase\inc\registrar\helpers\HideSingle;
use JVBase\managers\Cache;
use JVBase\managers\CRUD;
use JVBase\managers\IconsManager;
use JVBase\managers\KarmaManager;
use JVBase\meta\Meta;
use JVBase\registrar\config\Breadcrumbs;
use JVBase\registrar\config\Dashboard;
@@ -14,9 +18,9 @@
use JVBase\registrar\config\SEO;
use JVBase\registrar\helpers\AddIntegrationFields;
use JVBase\registrar\helpers\MakeCalendarType;
use JVBase\registrar\helpers\MakeTimelineType;
use JVBase\registrar\helpers\MakeTrackChanges;
use JVBase\registrar\helpers\MakeVerification;
use JVBase\utility\Features;
use WP_Query;

if (!defined('ABSPATH')) {
@@ -28,6 +32,7 @@
   protected string $type;
   protected string $singular;
   protected string $plural;
   protected string $profile;
   protected string $description ='';
   protected Fields $fields;
   protected array $sections = [];
@@ -41,11 +46,15 @@

   protected int|false $page = false;

   public ?string $rewrite_taxonomy = null;

   public bool $add_image_column = false;

   protected static array $allFlags = [
      //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',
      'hide_single', 'redirect_to_author', 'is_calendar', 'single_image', 'is_timeline', 'is_gallery', 'is_faq', 'is_glossary', 'rewrite_taxonomy', 'add_image_column',
      //Taxonomy Flags
      'is_content', 'is_ownable', 'verify_entry', 'track_changes', 'associate_user_content',
      //User Flags
@@ -62,6 +71,7 @@
    * @var bool Whether to setup karma for this content
    */
   protected bool $karma = false;
   protected ?KarmaManager $karmaManager = null;
   /**
    * @var bool Whether this should be available in the feed block
    */
@@ -90,6 +100,7 @@
    * @var bool Whether single items of this content should be hidden
    */
   protected bool $hide_single = false;
   protected ?HideSingle $hideSingleHandler = null;

   /**
    * @var bool Whether single items should just go to the author's page
@@ -98,11 +109,21 @@
   /**
    * @var bool Whether to make this a calendar type (example: events)
    */
   protected bool $is_calendar;
   protected bool $is_calendar = false;
   protected ?MakeCalendarType $isCalendarHandler = null;
   /**
    * @var bool Whether this is a before/after post type
    */
   protected bool $is_timeline = false;
   protected ?MakeTimelineType $isTimelineHandler = null;
   /**
    * @var bool Whether this is a defined term post type
    */
   protected bool $is_glossary = false;
   /**
    * @var bool Whether this is a faq post type
    */
   protected bool $is_faq = false;
   /**
    * @var bool Whether the uploader can group images prior to upload
    */
@@ -113,7 +134,7 @@
   /**
    * @var bool For taxonomy types only. Treats the taxonomy as a content (ie: tattoo shops))
    */
   protected bool $is_content;
   protected bool $is_content = false;
   /**
    * @var bool Whether this taxonomy can be owned/managed by specific people only
    */
@@ -121,11 +142,13 @@
   /**
    * @var bool Whether users/content need to request the owner for admission
    */
   protected bool $verify_entry;
   protected bool $verify_entry = false;
   protected ?MakeVerification $verifyEntryHandler = null;
   /**
    * @var bool Whether we should track post movements from term to term (ie. artists in tattoo shops)
    */
   protected bool $track_changes;
   protected bool $track_changes = false;
   protected ?MakeTrackChanges $trackChangesHandler = null;

   /**
    * @var bool Whether any content by members in this taxonomy should show up in this taxonomy
@@ -158,7 +181,7 @@
   /**
    * @var bool Whether to generate a profile for this user role
    */
   protected bool $profile_link;
   public bool $profile_link;
   /**
    * @var array|string
    */
@@ -167,6 +190,16 @@
    * @var array slugs of other user roles this role can manage
    */
   protected array $manage_others = [];
   /**
    * @var string The slug of the taxonomy that defines different access points
    * Example, for edmonton.ink, we have artist_type, and $this->>can_create would be:
    *       [
    *          'piercer'   => ['piercings', 'artwork', 'events'],
    *          'tattoo_artist'=> ['tattoos', 'artwork', 'events'],
    *          'artist' => ['artwork']
    *       ]
    */
   protected string $user_subtype;

   /** Configs **/
   protected Breadcrumbs $breadcrumbs;
@@ -186,8 +219,10 @@

   private static array $instances = [];

   protected string $based;
   private function __construct(string $slug, string $singular, string $plural, string $type) {
      $this->slug = $slug;
      $this->based = jvbCheckBase($slug);
      $this->type = $type;
      $this->singular = $singular;
      $this->plural = $plural;
@@ -197,7 +232,7 @@
//    $this->initClasses();
      $this->setFields();

      add_action('init', [$this, 'register'], 0);
      add_action('init', [$this, 'register'], 2);
      add_filter('jvbDashboardPage', [$this, 'renderDashPage'], 10, 3);
   }

@@ -272,8 +307,16 @@
         return $this;
      }
      $this->args = $args;

      foreach ($args as $property => $value) {
         $this->registrar->$property = $value;
         if (property_exists($this->registrar, $property)) {
            $this->registrar->$property = $value;
         }

         if (property_exists($this, $property)) {
            $this->$property = $value;
         }

      }
      if (isset($this->icon) && !str_contains($this->icon, 'dashicons')){
         $this->registrar->menu_icon = IconsManager::for()->getCSSIcon($this->icon);
@@ -340,7 +383,8 @@
   }
   public function setIntegration(string $integration):self
   {
      if (!Features::forSite()->has($integration)){

      if (!Site::hasIntegration($integration)){
         error_log('Integration not available for '.$this->slug.': '.$integration);
         return $this;
      }
@@ -351,7 +395,7 @@
   public function getIntegrationFields(string $integration):AddIntegrationFields|false
   {

      if (!Features::forSite()->has($integration)){
      if (!Site::has($integration)){
         error_log('Integration not available for '.$this->slug.': '.$integration);
         return false;
      }
@@ -368,6 +412,14 @@
   public function hasIntegration(string $integration) {
      return in_array($integration, $this->integrationConfigs);
   }
    public function hasAnyIntegrations(array $integrations = []):bool
    {
        if (empty($integrations)) {
            $integrations = array_keys($this->integrationConfigs);
            return !empty($integrations);
        }
        return !empty(array_intersect($integrations, array_keys($this->integrationConfigs)));
    }
   public function setUploadTitle(string $title):self
   {
      $this->upload_title = $title;
@@ -383,6 +435,35 @@
      return $this->slug;
   }

   public function getBased():string
   {
      return $this->based;
   }

   public function setGlossary(bool $set):self
   {
      $this->is_glossary = $set;
//    if ($set) {
//       $this->timeline = new MakeTimelineType($this->slug, $this);
//    }
      return $this;
   }
   public function isGlossary():bool
   {
      return $this->is_glossary;
   }
   public function setFaq(bool $set):self
   {
      $this->is_faq = $set;
//    if ($set) {
//       $this->timeline = new MakeTimelineType($this->slug, $this);
//    }
      return $this;
   }
   public function isFaq():bool
   {
      return $this->is_faq;
   }
   public function setTimeline(bool $set):self
   {
      $this->is_timeline = $set;
@@ -415,6 +496,9 @@
            case 'is_content':
               add_action('init', [$this, 'setupContent'], 20);
               break;
            case 'is_glossary':
               $this->hide_single = true;
               break;
         }
      }
      return $this;
@@ -440,13 +524,18 @@
   }
   public static function getFeatured(string $feature, ?string $type = null):array
   {
      self::ensureInstanced();

      if (!in_array($feature, static::$allFlags)) {
         error_log('Feature requested not found: '.$feature);
         return [];
      }

      return array_map(function($inst) { return $inst->slug; },array_filter(self::$instances, function ($inst) use ($feature, $type){
         return isset($inst->$feature) && $inst->$feature === true && (is_null($type) || $inst->type === $type);
         if (!is_null($type) && $inst->type !== $type) {
            return false;
         }
         return property_exists($inst, $feature) && isset($inst->$feature) && $inst->$feature === true;
      }));
   }

@@ -471,12 +560,15 @@
   }
      protected function getBreadcrumbs():Breadcrumbs
      {
         $this->breadcrumbs = new Breadcrumbs($this->slug, $this);
         if (!isset($this->breadcrumbs)) {
            $this->breadcrumbs = new Breadcrumbs($this->slug, $this);
         }

         return $this->breadcrumbs;
      }
      protected function getCalendar():MakeCalendarType|false
      {
         if ($this->is_calendar){
         if ($this->is_calendar && !isset($this->calendar)){
            $this->calendar = new MakeCalendarType($this->slug, $this);
         } else {
            $this->calendar = false;
@@ -486,26 +578,25 @@

      protected function getDashboard():Dashboard
      {
         $this->dashboard = new Dashboard($this->plural, $this);
         if (!isset($this->dashboard)) {
            $this->dashboard = new Dashboard($this->plural, $this);
         }

         return $this->dashboard;
      }

      protected function getDirectory():Directory|false
      {
         if ($this->show_directory) {
            $this->directory = new Directory($this->singular, $this);
         } else {
            $this->directory = false;
         if (!isset($this->directory)) {
            $this->directory = new Directory($this->singular);
         }
         return $this->directory;
      }

      protected function getFeed():Feed|false
      {
         if ($this->show_feed) {
            $this->feed = new Feed($this->slug, $this);
         } else {
            $this->feed = false;
         if (!isset($this->feed)) {
            $this->feed = new Feed($this->slug);
         }
         return $this->feed;
      }
@@ -513,7 +604,7 @@
      public function getSEO():SEO
      {
         if (!isset($this->seo)){
            $this->seo = new SEO($this->slug, $this);
            $this->seo = new SEO($this->slug);
         }
         return $this->seo;
      }
@@ -578,13 +669,52 @@

   public function register():void
   {
      if ($this->registrar) {
         $this->registrar->register();
      if ($this->type === 'post') {
         if ($this->hide_single) {
            $this->hideSingleHandler = new HideSingle($this->slug, $this);
         }
         if ($this->is_timeline) {
            $this->isTimelineHandler = new MakeTimelineType($this->slug, $this);
            $this->registrar->hierarchical = true;
         }
         if ($this->is_calendar) {
            $this->isCalendarHandler = new MakeCalendarType($this->slug, $this);
         }

         if (!is_null($this->rewrite_taxonomy)) {
            $this->registrar->addTaxonomyRewrite($this->rewrite_taxonomy);
         }

         if ($this->registrar) {
            $this->registrar->register();
         }
         if ($this->add_image_column) {
            add_filter("manage_{$this->based}_posts_columns", [$this, 'addImageColumn']);
            add_action("manage_{$this->based}_posts_custom_column", [$this, 'showImageColumn'], 10, 2);
         }
      } elseif ($this->type === 'term') {
         if ($this->is_content) {
            if ($this->verify_entry) {
               $this->verifyEntryHandler = new MakeVerification();
            }
            if ($this->track_changes) {
               $this->trackChangesHandler = new MakeTrackChanges($this->slug);
            }
         }

         if ($this->registrar) {
            $this->registrar->register();
         }
      }

      if ($this->karma) {
         $this->karmaManager = KarmaManager::for($this->slug, $this->type);
      }
   }
   public static function getInstance(string $slug):Registrar|false
   {
      self::ensureInstanced();

      $slug = jvbNoBase($slug);
      if (array_key_exists($slug, static::$instances)) {
         return static::$instances[$slug];
@@ -594,6 +724,7 @@

   public static function getFieldsFor(string $slug):array
   {
      self::ensureInstanced();
      if (!array_key_exists($slug, static::$instances)) {
         return [];
      }
@@ -603,6 +734,7 @@

   public static function getRegistered(?string $type = null):array
   {
      self::ensureInstanced();
      $instances = ($type) ? array_filter(static::$instances, function($instance) use ($type) {
         return $instance->type === $type;
      }) : static::$instances;
@@ -611,6 +743,7 @@

   public static function getLabels():array
   {
      self::ensureInstanced();
      return array_map(function ($instance) {
         return ['singular' => $instance->getSingular(),
            'plural' => $instance->getPlural()];
@@ -686,9 +819,43 @@
         }
         wp_reset_postdata();
      }

      add_filter('jvb_post_content_output', [$this, 'renderContent'], 20, 2);


      //Add a date published and date modified fields, and auto-update them on term creation/modification
      $this->fields()->addField('date_published', [
         'type'   => 'datetime',
         'label'  => 'Published',
         'hidden' => true,
      ]);
      $this->fields()->addField('date_modified', [
         'type'   => 'datetime',
         'label'  => 'Modified',
         'hidden' => true,
      ]);
      add_action('created_'.$this->based, [$this, 'addTermCreatedMeta']);
      add_action('edited_'.$this->based, [$this, 'addTermUpdatedMeta']);
   }
      public function addTermCreatedMeta(int $termId):void
      {
         $meta = Meta::forTerm($termId);
         $meta->set('date_published', date('Y-m-d H:i:s'));
      }
      public function handleContentTermMetaChange(int $meta_id, int $term_id, string $meta_key, $meta_value):void
      {
         $term = get_term($term_id);
         $taxonomy = $term->taxonomy;
         if ($taxonomy === $this->based && $meta_key !== BASE . 'date_modified') {
            $meta = Meta::forTerm($term_id);
            $meta->set('date_modified', date('Y-m-d H:i:s'));
         }

      }
      public function addTermUpdatedMeta(int $termId):void
      {
         $meta = Meta::forTerm($termId);
         $meta->set('date_modified', date('Y-m-d H:i:s'));
      }
   public function renderContent(string $content, array $block):string
   {
      if (!is_page($this->page)) {
@@ -716,7 +883,7 @@
                  $meta = Meta::forTerm($item);
                  $slug = sanitize_title($meta->get('name'));
                  $item = sprintf(
                     '<li id="%s"><h3><a href="%s">%s</a></h3><p>%s</p><ul>',
                     '<li id="%s"><h2><a href="%s">%s</a></h2><p>%s</p><ul class="item-grid">',
                     $slug,
                     get_term_link($item, jvbCheckBase($this->slug))??'',
                     $meta->get('name'),
@@ -737,7 +904,7 @@
                           $img = $postMeta->get('post_thumbnail');
                           $img = !empty($img) ? jvbFormatImage((int)$img, 'tiny', 'medium') : '';
                           $item .= sprintf(
                              '<li id="%s"><h4><a href="%s">%s</a></h4>%s</li>',
                              '<li id="%s" class="item"><h3><a href="%s">%s</a></h3>%s</li>',
                              $slug.'-'.sanitize_title(get_the_title($ID)),
                              get_the_permalink($ID),
                              $postMeta->get('post_title'),
@@ -756,4 +923,68 @@
      error_log('Built the '.$this->slug.' page content.');
      return $content . $out;
   }

   public static function ensureInstanced():void
   {
      if (empty(self::$instances)) {
         do_action('jvbDefineRegistrar');
         do_action('jvbDefineRegistrarFields');
      }
   }

   /*****************************************************************
    * FLAGGED FEATURES
   *****************************************************************/

   public function profile(?string $slug = null, ?string $singular = null, ?string $plural = null):self
   {
      if (!$slug) {
         $slug = $this->slug.'_profile';
      }
      if (!$singular) {
         $singular = $this->singular;
      }
      if (!$plural) {
         $plural = $this->plural;
      }
      $this->profile_link = true;

      $this->profile = $slug;

      return Registrar::forPost($slug, $singular, $plural);
   }
   public function getProfile():self|false
   {
      if (!$this->profile_link) {
         return false;
      }
      return self::getInstance($this->profile);
   }

   public function setUserSubtype(string $type):self
   {
      $this->user_subtype = sanitize_text_field($type);
      return $this;
   }
   public function getUserSubtype():string|false
   {
      return $this->user_subtype??false;
   }

   public function addImageColumn(array $columns):array
   {
      $keys = array_keys($columns);
      $index = array_search('cb', $keys);
      if ($index !== false) {
         $pos = $index+1;
         $columns = array_slice($columns, 0, $pos, true) + ['jvb_featured_image' => 'Image'] + array_slice($columns, $pos, null, true);
      }
      return $columns;
   }
   public function showImageColumn(string $column, int $postID):void
   {
      if ($column === 'jvb_featured_image') {
         echo get_the_post_thumbnail($postID, 'tiny');
      }
   }
}