CompassMenu.php

<?php
/**
 * CompassMenu class
 * @copyright HomeCu 05/2019
 *
 * Create the upper right menu in home banking, now called the Compass menu.
 * This concrete exists to customize params both from eternal elements and
 * internal calculations.
 *
 * See the foot of CreateMenu for usage and documentation.
 *
 * As an extension no constructor is needed unless you need to do something on startup. :-)
 */
class CompassMenu extends CreateMenu
{
  /** @var array the array of params passed to makeMenu() */
  protected $compass_params = [];

  /** @var array, after decoding JSON config store here for access */
  protected $json_array = [];

  /**
   * ENTRY POINT.
   * Set up our menu array, send to makeMenu(), and output the HTML. CreateMenu validates
   * the JSON template path.
   * @param string $json_path
   * @param string $menu_json, global json data
   * @param string $append_html
   * @return string
   */
  public function composeCompassMenu($json_path = '', $menu_json = '', $append_html = '')
  {
    try {
      $menu = $this
          ->setMenuJsonArray($menu_json)
          ->setCompassParamsArray($json_path)
          ->addUserInfoIcons()
          ->makeMenu($this->compass_params);

      return $this->addHiddenContent($menu, $append_html);

    } catch (Exception $e) {
      return "<p>Exception creating menu: {$e->getMessage()}</p>";
    }
  }

  public function singleCompassMenuNode($json_path = '', $menu_json = '', $node_id = '', $full_node = false)
  {
    return $this
          ->setMenuJsonArray($menu_json)
          ->setCompassParamsArray($json_path)
          ->addUserInfoIcons()
          ->makeSingleMenuNode($node_id, $this->compass_params, $full_node);
  }

  /**
   * A "temporary measure" that may or may not have use in the future. Append the menu with
   * any content we need to add to the DOM It will be wrapped in a hidden div by default.
   * @param string HTML $menu
   * @param string HTML $append_html
   * @return string
   */
  protected function addHiddenContent($menu, $append_html = '')
  {
    if (empty($append_html)) {
      return $menu;
    }

    return $menu . "
    <div id=\"compass-append-menu\" style=\"display:none;\">
        $append_html
    </div>
    ";

  }

  /**
   * If we have no CU and user, no need to output anything.
   * @return bool
   */
  public function isCuAndUser()
  {
    return (
      isset($this->HB_ENV['Cu']) &&
      (strlen($this->HB_ENV['Cu']) > 0) &&
      isset($this->HB_ENV['Uid']) &&
      (strlen($this->HB_ENV['Uid']) > 0)
    );

  }

  /**
   * Set the JSON into the internal array.
   * @param string $json
   * @throws Exception
   * @return $this
   */
  protected function setMenuJsonArray($json = '')
  {
    $this->json_array = json_decode($json, 1);

    if ($this->json_array === false) {
      throw new Exception("Could not decode global JSON array in CompassMenu.");
    }

    return $this;
  }

  /**
   * Sets the array to inject into the parent makeMenu() method from dynamic external params.
   * It looks complex, but is pretty straightforward. Visualize html elements
   *
   * <p id="some-div" class="this that">
   *   <a href="somwhere.html" id="somewhere-link" title="" class="the other">Text</a>
   * </p>
   *
   * Can be referenced with nested dot syntax by **element Id."
   *
   * 'some-div.attributes.class.this' = false         // turns OFF "this" class
   * 'somewhere-link.attributes.title' = 'My Title'   // populates anchor title
   * 'somewhere-link.attributes.class.the' = false    // turns off 'the' class
   * 'somewhere-link.content' = 'Use Meaningful Text' // Exchanges 'Text' for this value
   *
   * Keys must exist in the JSON structure, they will not be added (in this version)
   * See head of CreateMenu for full documentation.
   *
   * @param string $json_path, path to JSON template
   * @return $this
   */
  protected function setCompassParamsArray($json_path = '')
  {
    $compass_count = $this->countAllWarnings();

    $this->compass_params = [
    'json_path'                                               => $json_path,
    'substitute_values' => [
      'compass-menu-badge.display'                            => ($compass_count > 0)? true : false,
      //'compass-menu-badge.content'                            => $compass_count,
      //'compass-menu-badge.content'                            => '&nbsp;',
      'user-activity.attributes.class.hcu-navbar-alert'       => $this->setBoolFromCount('activity'),
      'user-activity-link.attributes.href'                    => $this->setMenuUrl('activity'),
      'activity-link-text.content'                            => $this->getNestedTwoDeep('activity', 'display'),
      'user-activity-badge.display'                           => $this->setBoolFromCount('activity'),
      'user-activity-badge.content'                           => $this->setDisplayNum('activity', 9),
      'secure-email-item.attributes.class.hcu-navbar-alert'   => $this->setBoolFromCount('messages'),
      'secure-email-link.attributes.href'                     => $this->setMenuUrl('messages'),
      'secure-email-link-text.content'                        => $this->getNestedTwoDeep('messages', 'display'),
      'secure-email-badge.display'                            => $this->setBoolFromCount('messages'),
      'secure-email-badge.content'                            => $this->setDisplayNum('messages', 9),
      'user-status.attributes.class.hcu-navbar-alert'         => $this->setBoolFromCount('status'),
      'user-status-badge.display'                             => $this->setBoolFromCount('status'),
      'user-status-badge.content'                             => $this->setDisplayNum('status', 9),
      'user-status-dropdown-link.attributes.href'             => $this->getNestedTwoDeep('status', 'endpoint'),
      'status-link-text.content'                              => $this->getNestedTwoDeep('status', 'display'),
      'failed-login-k-b.attributes.class.hcu-warning-color'   => $this->isErrorEnableClass('status', 'fail', true),
      'failed-login-summary-desc-label.content'               => $this->getNestedThreeDeep('status', 'fail', 'title'),
      'failed-login-summary-desc-p.content'                   => $this->getNestedThreeDeep('status', 'fail', 'date'),
      'last-login-summary-desc-label.content'                 => $this->getNestedThreeDeep('status', 'prior', 'title'),
      'last-login-summary-value-label.content'                => $this->getNestedThreeDeep('status', 'prior', 'date'),
      'acct-status-summary-desc.display'                      => $this->isLiveEnvironment(),
      'acct-status-summary-desc-label.content'                => $this->getNestedThreeDeep('status', 'system', 'title'),
      'acct-status-summary-p.content'                         => $this->getNestedThreeDeep('status', 'system', 'date'),
      'user-dropdown.attributes.class.hcu-navbar-alert'       => $this->setBoolFromCount('user'),
      'user-menu-badge.display'                               => $this->setBoolFromCount('user'),
      'user-menu-badge.content'                               => $this->setDisplayNum('user', 9),
      'user-link-text.content'                                => $this->getNestedTwoDeep('user', 'display'),
      'update-password.display'                               => $this->setAlertDivDisplay('password'),
      'update-password-icon-block'                            => $this->getNestedThreeDeep('user', 'password', 'icon'),
      'update-password-alert-text.content'                    => $this->getNestedThreeDeep('user', 'password', 'message'),
      'update-password-link.attributes.href'                  => $this->getNestedThreeDeep('user', 'password', 'url'),
      'update-password-link.content'                          => $this->getNestedThreeDeep('user', 'password', 'link'),
      'update-security.display'                               => $this->setAlertDivDisplay('security'),
      'security-expiring-text.content'                        => $this->getNestedThreeDeep('user', 'security', 'message'),
      'update-security-link.attributes.href'                  => $this->getNestedThreeDeep('user', 'security', 'url'),
      'update-security-link.content'                          => $this->getNestedThreeDeep('user', 'security', 'link'),
      'email-message-p.content'                               => $this->getNestedThreeDeep('user', 'email', 'message'),
      'email-message-title.content'                           => $this->getNestedThreeDeep('user', 'email', 'title'),
      'update-email-link.attributes.href'                     => $this->getNestedThreeDeep('user', 'email', 'url'),
      'update-email-link.content'                             => $this->getNestedThreeDeep('user', 'email', 'link'),
      'quicknav-logout-link.attributes.href'                  => $this->setMenuUrl('logout'),
      'logout-link-text.content'                              => $this->getNestedTwoDeep('logout', 'display'),
      ]
    ];

    return $this;
  }

  /**
   * Specialized method just for the user menu. The icons can vary, get what comes from
   * $this->json_array from hcuFunctions.i and use the icon specified by that output.
   * @return $this
   */
  protected function addUserInfoIcons()
  {
    $icon_ids = [
      'security' => 'security-expiring-icon',
      'password' => 'update-password-icon',
      'email' => 'email-alert-icon'
    ];

    foreach ($icon_ids as $key => $icon_id) {

      if ($this->isUserInfoArrayMembers($key)) {

        $icon = 'fa-' . $this->json_array['user'][$key]['icon'];
        $level = $this->json_array['user'][$key]['level'];

        if (in_array($level, ['warning', 'error'])) {

          $parent = 'update-' . $key;
          $parent_class = ($level == 'error')? 'k-error-colored' : 'hcu-warning-color';
          $this->compass_params['substitute_values']["$parent.attributes.class.$parent_class"] = true;
        }

        $this->compass_params['substitute_values']["$icon_id.attributes.class.$icon"] = true;
      }
    }

    return $this;
  }

  /**
   * Helper for addUserInfoIcons(), check for valid member we need in the input json_array.
   * @param string $key
   * @return bool
   */
  protected function isUserInfoArrayMembers($key)
  {
    return
    isset($this->json_array['user'][$key]['level']) &&
    isset($this->json_array['user'][$key]['icon']) &&
    in_array($this->json_array['user'][$key]['level'], ['info', 'warning', 'error']);

  }

  /**
   * Used only for the top level compass menu.
   * @return int
   */
  protected function countAllWarnings()
  {
    $count = 0;

    $arr = ['logout', 'activity', 'messages', 'status', 'user'];

    foreach ($arr as $key) {

      // Happens on logout for some reason.
      if (! array_key_exists($key, $this->json_array)) {
        continue;
      }

      $count += $this->getArrayCount($this->json_array[$key]);

      foreach ($this->json_array[$key] as $value) {
        if (is_array($value)) {

          $count += $this->getArrayCount($value);
        }
      }

    }

    if ($count > 8) {
      return '9+';
    }

    return $count;
  }

  /**
   * @param $arr
   * @return int
   */
  protected function getArrayCount($arr)
  {
    if (isset($arr['count'])) {
      return $arr['count'];
    }

    return 0;
  }

  /**
   * Looks for the key 'count' in array member $key and returns true if > 0
   * @param string $key
   * @return bool
   */
  protected function setBoolFromCount($key)
  {
    if (! isset($this->json_array[$key]['count'])) {
      return false;
    }

    return ($this->json_array[$key]['count'] > 0)? true : false;
  }

  /**
   * Utility for building a URL from input params.
   * @param string $key
   * @return string|null
   */
  protected function setMenuUrl($key)
  {
    if (isset($this->json_array[$key]['url'])) {
      return $this->json_array[$key]['url'];
    }

    if (isset($this->json_array[$key]['script'])) {
      return "{$this->HB_ENV['loginpath']}/{$this->json_array[$key]['script']}?{$this->HB_ENV['cuquery']}";
    }

    return null;
  }

  /**
   * Set a display number for the menus, if > $max output "$max+"
   * @param string $key
   * @param int $max
   * @return string
   */
  protected function setDisplayNum($key, $max = 5)
  {
    if (! isset($this->json_array[$key]['count'])) {
      return '0';
    }

    return ($this->json_array[$key]['count'] > $max)? $max . '+' : $this->json_array[$key]['count'];
  }

  /**
   * Reach into an array value nested two deep and return if it exists.
   * @param string $parent
   * @param string $key
   * @return string|null
   */
  protected function getNestedTwoDeep($parent = '', $key = '')
  {
    if (isset($this->json_array[$parent][$key])) {

      return $this->json_array[$parent][$key];
    }

    return null;
  }

  /**
   * Reach into a array value nested three deep and return if it exists. These members may not
   * exist, whereas others used here will always exist.
   * @param string $parent
   * @param string $child
   * @param string $key
   * @return string|null
   */
  protected function getNestedThreeDeep($parent = '', $child = '', $key = '')
  {
    if (isset($this->json_array[$parent][$child][$key])) {

      if ($key == 'icon') {
        return 'fa-' . $this->json_array[$parent][$child][$key];
      }

      return $this->json_array[$parent][$child][$key];
    }

    return null;
  }

  /**
   * Our method of determining environment.
   * @return bool
   */
  protected function isLiveEnvironment()
  {
      return $this->HB_ENV['live'];
  }

  /**
   * If there is an error, enable the error class in the menu JSON. A default class that generally
   * always displays unless there is an error sends $enable_if_error = false (disables the class
   * if there is an error: this method returns false.) A normally disabled class that needs to
   * display if there is an error sends $enable_if_error = true (is enabled if there is an
   * error, this method returns true.)
   * @param string $parent
   * @param string $child
   * @param bool $enable_if_error
   * @return bool
   */
  protected function isErrorEnableClass($parent, $child = '', $enable_if_error = false)
  {
    $array = $this->isErrorArray($parent, $child);

    if (isset($array['level']) && in_array($array['level'], ['warning', 'error'])) {
      return ($enable_if_error)? true : false;
    }

    return ($enable_if_error)? false : true;
  }

  /**
   * Helper for above.
   * @param string $parent
   * @param string $child
   * @return array
   */
  function isErrorArray($parent, $child)
  {
    if (
      isset($this->json_array[$parent]) &&
      isset($this->json_array[$parent][$child]) &&
      ! empty ($child)
    ) {
      return $this->json_array[$parent][$child];
    }

    if (isset($this->json_array[$parent])) {
      return $this->json_array[$parent];
    }

    return [];
  }

  /**
   * Set whether a given parent div should display.
   * @param string $key
   * @return bool
   */
  protected function setAlertDivDisplay($key)
  {
    return isset($this->json_array['user'][$key]) && is_array($this->json_array['user'][$key]);
  }

}