CompassMenu Class Reference

Inheritance diagram for CompassMenu:

Public Member Functions
	composeCompassMenu ($json_path='', $menu_json='', $append_html='')
	singleCompassMenuNode ($json_path='', $menu_json='', $node_id='', $full_node=false)
	isCuAndUser ()
	isErrorArray ($parent, $child)
Public Member Functions inherited from CreateMenu
	__construct ($HB_ENV=[])
	isCuAndUser ()
	makeMenu ($params=[])
	makeSingleMenuNode ($node_id='', $params=[], $full_node=false)

Protected Member Functions
	addHiddenContent ($menu, $append_html='')
	setMenuJsonArray ($json='')
	setCompassParamsArray ($json_path='')
	addUserInfoIcons ()
	isUserInfoArrayMembers ($key)
	countAllWarnings ()
	getArrayCount ($arr)
	setBoolFromCount ($key)
	setMenuUrl ($key)
	setDisplayNum ($key, $max=5)
	getNestedTwoDeep ($parent='', $key='')
	getNestedThreeDeep ($parent='', $child='', $key='')
	isLiveEnvironment ()
	isErrorEnableClass ($parent, $child='', $enable_if_error=false)
	setAlertDivDisplay ($key)
Protected Member Functions inherited from CreateMenu
	findNode ($node_id)
	recursivelyWalkArray ($node_id, $item)
	recurseDigArray ($node_id, $sub_array)
	setMenuArray ($params=[])
	jsonPathParam ($params)
	isValidConfig ($arr=[])
	setMenuParams ($params=[])
	makeMenuHtml ()
	createMenuToggleElement ()
	walkMenuItems ($items=[])
	createElementHtml ($arr=[], $close_tag=true)
	getElementId ($element=[])
	isAssociativeArray ($arr=[])
	hasDisplayValue ($id, $element=[])
	hasUserDisplayValue ($id, $display)
	openHtmlElement ($element=[])
	closeHtmlElement ($element=[])
	addIndent ($tag)
	addNewLine ($tag)
	closeElementOpen ($element=[])
	addElementAttributes ($id, $element=[])
	translateValuesIfRequired ($attr, $value)
	isAttributeMember ($element=[])
	addElementClasses ($id, $element=[])
	setMemberValue ($id, $value, $key_to_find, $element=[])
	setSubValue ($id, $key_to_find, $element=[])
	isKeyInArray ($id, $key_to_find, $input_string, $element=[])
	isClassMember ($element=[])
	addElementContent ($id, $element=[])
	userContentOverride ($id)
	isContentMember ($element=[])
	returnMenuHtml ()
	filterInputValue ($value)
	composeErrors ()
	isErrors ()

Protected Attributes
	$compass_params = []
	$json_array = []
Protected Attributes inherited from CreateMenu
	$HB_ENV = []
	$params = []
	$menu_array = []
	$menu_html = ''
	$errors = []

Detailed Description

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. :-)

Definition at line 14 of file CompassMenu.php.

Member Function Documentation

addHiddenContent()

CompassMenu::addHiddenContent (   $menu,   $append_html = ''  )

protected

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.

Parameters

string	HTML $menu
string	HTML $append_html

Returns

string

Definition at line 63 of file CompassMenu.php.

  {
    if (empty($append_html)) {
      return $menu;
    }

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

  }

addUserInfoIcons()

CompassMenu::addUserInfoIcons ( )

protected

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.

Returns

$this

Definition at line 193 of file CompassMenu.php.

  {
    $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;
  }

composeCompassMenu()

CompassMenu::composeCompassMenu	(		$json_path = '',
			$menu_json = '',
			$append_html = ''
	)

ENTRY POINT. Set up our menu array, send to makeMenu(), and output the HTML. CreateMenu validates the JSON template path.

Parameters

string	$json_path
string	$menu_json,global	json data
string	$append_html

Returns

string

Definition at line 31 of file CompassMenu.php.

  {
    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>";
    }
  }

countAllWarnings()

CompassMenu::countAllWarnings ( )

protected

Used only for the top level compass menu.

Returns

int

Definition at line 240 of file CompassMenu.php.

  {
    $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;
  }

getArrayCount()

CompassMenu::getArrayCount (   $arr )

protected

Parameters

$arr

Returns

int

Definition at line 275 of file CompassMenu.php.

  {
    if (isset($arr['count'])) {
      return $arr['count'];
    }

    return 0;
  }

getNestedThreeDeep()

CompassMenu::getNestedThreeDeep (   $parent = '',   $child = '',   $key = ''  )

protected

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.

Parameters

string	$parent
string	$child
string	$key

Returns

string|null

Definition at line 355 of file CompassMenu.php.

  {
    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;
  }

getNestedTwoDeep()

CompassMenu::getNestedTwoDeep (   $parent = '',   $key = ''  )

protected

Reach into an array value nested two deep and return if it exists.

Parameters

string	$parent
string	$key

Returns

string|null

Definition at line 337 of file CompassMenu.php.

  {
    if (isset($this->json_array[$parent][$key])) {

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

    return null;
  }

isCuAndUser()

CompassMenu::isCuAndUser

(

)

If we have no CU and user, no need to output anything.

Returns

bool

Definition at line 81 of file CompassMenu.php.

  {
    return (
      isset($this->HB_ENV['Cu']) &&
      (strlen($this->HB_ENV['Cu']) > 0) &&
      isset($this->HB_ENV['Uid']) &&
      (strlen($this->HB_ENV['Uid']) > 0)
    );

  }

isErrorArray()

CompassMenu::isErrorArray	(		$parent,
			$child
	)

Helper for above.

Parameters

string	$parent
string	$child

Returns

array

Definition at line 406 of file CompassMenu.php.

  {
    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 [];
  }

isErrorEnableClass()

CompassMenu::isErrorEnableClass (   $parent,   $child = '',   $enable_if_error = false  )

protected

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.)

Parameters

string	$parent
string	$child
bool	$enable_if_error

Returns

bool

Definition at line 389 of file CompassMenu.php.

  {
    $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;
  }

isLiveEnvironment()

CompassMenu::isLiveEnvironment ( )

protected

Our method of determining environment.

Returns

bool

Definition at line 373 of file CompassMenu.php.

  {
      return $this->HB_ENV['live'];
  }

isUserInfoArrayMembers()

CompassMenu::isUserInfoArrayMembers (   $key )

protected

Helper for addUserInfoIcons(), check for valid member we need in the input json_array.

Parameters

string

$key

Returns

bool

Definition at line 227 of file CompassMenu.php.

  {
    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']);

  }

setAlertDivDisplay()

CompassMenu::setAlertDivDisplay (   $key )

protected

Set whether a given parent div should display.

Parameters

string

$key

Returns

bool

Definition at line 428 of file CompassMenu.php.

  {
    return isset($this->json_array['user'][$key]) && is_array($this->json_array['user'][$key]);
  }

setBoolFromCount()

CompassMenu::setBoolFromCount (   $key )

protected

Looks for the key 'count' in array member $key and returns true if > 0

Parameters

string

$key

Returns

bool

Definition at line 289 of file CompassMenu.php.

  {
    if (! isset($this->json_array[$key]['count'])) {
      return false;
    }

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

setCompassParamsArray()

CompassMenu::setCompassParamsArray (   $json_path = '' )

protected

Sets the array to inject into the parent makeMenu() method from dynamic external params. It looks complex, but is pretty straightforward. Visualize html elements

Text

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.

Parameters

string

$json_path,path

to JSON template

Returns

$this

Definition at line 130 of file CompassMenu.php.

  {
    $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'                            => ' ',
      '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;
  }

setDisplayNum()

CompassMenu::setDisplayNum (   $key,   $max = 5  )

protected

Set a display number for the menus, if > $max output "$max+"

Parameters

string	$key
int	$max

Returns

string

Definition at line 322 of file CompassMenu.php.

  {
    if (! isset($this->json_array[$key]['count'])) {
      return '0';
    }

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

setMenuJsonArray()

CompassMenu::setMenuJsonArray (   $json = '' )

protected

Set the JSON into the internal array.

Parameters

string

$json

Exceptions

Exception

Returns

$this

Definition at line 98 of file CompassMenu.php.

  {
    $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;
  }

setMenuUrl()

CompassMenu::setMenuUrl (   $key )

protected

Utility for building a URL from input params.

Parameters

string

$key

Returns

string|null

Definition at line 303 of file CompassMenu.php.

  {
    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;
  }

---

The documentation for this class was generated from the following file:

• app/web/banking/library/menu-creators/CompassMenu.php