Inheritance diagram for CreateMenu:

Public Member Functions
	__construct ($HB_ENV=[])

	isCuAndUser ()

	makeMenu ($params=[])

	makeSingleMenuNode ($node_id='', $params=[], $full_node=false)

Protected Member Functions
	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
	$HB_ENV = []

	$params = []

	$menu_array = []

	$menu_html = ''

	$errors = []

Detailed Description

CreateMenu class

Copyright: HomeCu 05/2019

An abstract class to extend and create menus from any JSON file (possibly other formats, such as HTML templates, in future versions.)

Usage: See Documentation at the bottom of this file.

Definition at line 12 of file CreateMenu.php.

Constructor & Destructor Documentation

◆ __construct()

CreateMenu::__construct ( $HB_ENV = [] )

CreateMenu constructor

Returns: void

Definition at line 33 of file CreateMenu.php.

   {
     if (count($HB_ENV) == 0) {
       return;
     }
 
     $this->HB_ENV = $HB_ENV;
   }

Member Function Documentation

◆ addElementAttributes()

CreateMenu::addElementAttributes	(	$id,
		$element = `[]`
	)

protected

Walk the attributes array and add all attributes EXCEPT class, special handling.

Parameters

string	$id
array	$element

Returns: string|null

Definition at line 503 of file CreateMenu.php.

   {
     if (! $this->isAttributeMember($element)) {
       return null;
     }
 
     $attributes = null;
 
     foreach ($element['attributes'] as $attr => $value) {
       if ($attr == 'class') {
         continue;
       }
 
       $val        = $this->setMemberValue($id, $value, $attr, $element);
       $set_value  = $this->translateValuesIfRequired($attr, $val);
 
       if ($set_value) {
         $attributes .= " $attr=\"$set_value\" ";
       }
 
     }
 
     return rtrim($attributes);
   }

◆ addElementClasses()

CreateMenu::addElementClasses	(	$id,
		$element = `[]`
	)

protected

Add classes to the HTML element.

Parameters

string	$id
array	$element

Returns: string|null

Definition at line 560 of file CreateMenu.php.

   {
     if (! $this->isClassMember($element)) {
       return null;
     }
 
     $classes = null;
 
     foreach ($element['attributes']['class'] as $classname => $value) {
 
       $set_value = $this->setMemberValue($id, $value, $classname, $element);
 
       if ($set_value) {
         $classes .= "$classname ";
       }
     }
 
     return (empty($classes))? null : ' class="' . rtrim($classes) . '"';
   }

◆ addElementContent()

CreateMenu::addElementContent	(	$id,
		$element = `[]`
	)

protected

Add content members. This method is called recursively for nested content members.

Parameters

	string	id, container id
array	$element

Returns: string|null

Definition at line 685 of file CreateMenu.php.

   {
     $translate = null;
     if (! $this->isContentMember($element)) {
       return null;
     }
 
     // Do not translate - these items should already be translated.
     $user_content = $this->userContentOverride($id);
     if (! empty($user_content)) {
       return $user_content;
     }
 
     $content = null;
 
     foreach ($element['content'] as $content_arr) {
       $content .= $this->createElementHtml($content_arr, true);
     }
 
     return $content;
   }

◆ addIndent()

CreateMenu::addIndent ( $tag )

protected

Add indents after some elements @TODO let's see if we can better format output?

Parameters

$tag

Returns: string|null

Definition at line 453 of file CreateMenu.php.

   {
     if (in_array($tag, ['p', 'li', 'div'])) {
       return "    ";
     }
 
     return null;
   }

◆ addNewLine()

CreateMenu::addNewLine ( $tag )

protected

Add newlines after some elements @TODO let's see if we can better format output?

Parameters

$tag

Returns: string|null

Definition at line 468 of file CreateMenu.php.

   {
     if (in_array($tag, ['ul', 'li', 'p', 'div'])) {
       return PHP_EOL;
     }
 
     return null;
   }

◆ closeElementOpen()

CreateMenu::closeElementOpen ( $element = [] )

protected

Return the ending carat for an opened HTML tag.

Parameters

array $element

Returns: string|null

Definition at line 482 of file CreateMenu.php.

   {
     // This check allows raw data in the content member, i.e. content : ["string without a tag"]
     if (! array_key_exists('html-element', $element)) {
       return null;
     }
 
     // @TODO hinky
     if (in_array($element['html-element'], ['i', 'em', 'b', 'strong', 'label', 'span'])) {
       return '>';
     }
 
     return '>' . PHP_EOL;
   }

◆ closeHtmlElement()

CreateMenu::closeHtmlElement ( $element = [] )

protected

Output the closing tag for any opened element. Only outputs for valid tags, allowing raw content members to output.

Parameters

array $element

Returns: string|null

Definition at line 436 of file CreateMenu.php.

   {
     if (! isset($element['html-element'])) {
       return null;
     }
 
     return
       "</{$element['html-element']}>" .
       $this->addNewLine($element['html-element']);
   }

◆ composeErrors()

CreateMenu::composeErrors ( )

protected

Compose error HTML from $this->errors array.

Returns: string

Definition at line 769 of file CreateMenu.php.

   {
     $errors = "<ul class=\"error\">";
 
     foreach ($this->errors as $error) {
       $errors .= "<li>$error</li>";
     }
 
     return "$errors</ul>";
   }

◆ createElementHtml()

CreateMenu::createElementHtml	(	$arr = `[]`,
		$close_tag = `true`
	)

protected

The meat of the meal, output an HTML element. As we encounter content elements, this method is called recursively, allowing deeply nested elements to output.

Parameters

array	$arr
bool	$close_tag	- container needs to be closed after items done.

Returns: string|null

Definition at line 329 of file CreateMenu.php.

   {
     // This check allows raw data in the content member, i.e. "content" : ["nothing but a string"]
      if (isset($arr[0]) && is_string($arr[0])) {
       return $arr . PHP_EOL;
      }
 
     $id = $this->getElementId($arr);
     if (! $this->hasDisplayValue($id, $arr)) {
       return null;
     }
 
     $html =
       $this->openHtmlElement($arr) .
       $this->addElementAttributes($id, $arr) .
       $this->addElementClasses($id, $arr) .
       $this->closeElementOpen($arr) .
       $this->addElementContent($id, $arr);
 
     if ($close_tag) {
       $html .= $this->closeHtmlElement($arr);
     }
 
     return $html;
   }

◆ createMenuToggleElement()

CreateMenu::createMenuToggleElement ( )

protected

Create the "non menu" toggle element if it exists. It is still contained by the parent wrapper but not in the menu element list.

Returns: string|null

Definition at line 294 of file CreateMenu.php.

   {
     if (!
       isset($this->menu_array['toggle-element']) &&
       is_array($this->menu_array['toggle-element'])
     ) {
       return null;
     }
 
     return $this->createElementHtml($this->menu_array['toggle-element'], true);
   }

◆ filterInputValue()

CreateMenu::filterInputValue ( $value )

protected

Basic filter (could use improvement, but all values should be internal)

Parameters

mixed $value

Returns: mixed

Definition at line 760 of file CreateMenu.php.

   {
     return filter_var($value, FILTER_UNSAFE_RAW);
   }

◆ findNode()

CreateMenu::findNode ( $node_id )

protected

Helper for makeSingleMenuNode(), find the node in the array identified by $node_id.

Parameters

string $node_id

Returns: array

Definition at line 102 of file CreateMenu.php.

   {
     if (! (isset($this->menu_array['items']) && is_array($this->menu_array['items']))) {
       return [];
     }
 
     foreach ($this->menu_array['items'] as $item) {
 
       $arr = $this->recursivelyWalkArray($node_id, $item);
       if (count($arr) > 0) {
         return $arr;
       }
     }
     return [];
   }

◆ getElementId()

CreateMenu::getElementId ( $element = [] )

protected

Get the ID of an element if it exists.

Parameters

array $element

Returns: string|null

Definition at line 360 of file CreateMenu.php.

   {
     if (! isset($element['attributes']['id'])) {
       return null;
     }
 
     return $element['attributes']['id'];
   }

◆ hasDisplayValue()

CreateMenu::hasDisplayValue	(	$id,
		$element = `[]`
	)

protected

See if an element has an explicitly set display value. Default to true.

Parameters

string	$id
array	$element

Returns: bool

Definition at line 389 of file CreateMenu.php.

   {
     if (! isset($element['display'])) {
       return true;
     }
 
     return $this->hasUserDisplayValue($id, $element['display']);
   }

◆ hasUserDisplayValue()

CreateMenu::hasUserDisplayValue	(	$id,
		$display
	)

protected

See if there is a display value set on the member.

Parameters

string	$id
bool	$display

Returns: bool|mixed

Definition at line 404 of file CreateMenu.php.

   {
     $key = $id . '.display';
     if (array_key_exists($key, $this->params)) {
       return $this->params[$key];
     }
 
     return $display === true;
   }

◆ isAssociativeArray()

CreateMenu::isAssociativeArray ( $arr = [] )

protected

Helper for recursively walking array, looking for ID.

Parameters

array $arr

Returns: bool

Definition at line 374 of file CreateMenu.php.

   {
     if (! is_array($arr)) {
       return false;
     }
 
     return array_keys($arr) !== range(0, count($arr) - 1);
   }

◆ isAttributeMember()

CreateMenu::isAttributeMember ( $element = [] )

protected

Helper for addElementAttributes, is this an attributes array member?

Parameters

array $element

Returns: bool

Definition at line 547 of file CreateMenu.php.

   {
     return
       isset($element['attributes']) &&
       is_array($element['attributes']);
   }

◆ isClassMember()

CreateMenu::isClassMember ( $element = [] )

protected

Helper for addElementClasses, is this a class array member?

Parameters

array $element

Returns: bool

Definition at line 672 of file CreateMenu.php.

   {
     return
       isset($element['attributes']['class']) &&
       is_array($element['attributes']['class']);
   }

◆ isContentMember()

CreateMenu::isContentMember ( $element = [] )

protected

Helper for addElementContent, is this a content member in the array?

Parameters

array $element

Returns: bool

Definition at line 735 of file CreateMenu.php.

   {
       return
       isset($element['content']) &&
       is_array($element['content']);
   }

◆ isCuAndUser()

CreateMenu::isCuAndUser ( )

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

Returns: bool

Definition at line 46 of file CreateMenu.php.

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

◆ isErrors()

CreateMenu::isErrors ( )

protected

Determine if there are errors.

Returns: bool

Definition at line 784 of file CreateMenu.php.

   {
     return (count($this->errors) > 0);
   }

◆ isKeyInArray()

CreateMenu::isKeyInArray	(	$id,
		$key_to_find,
		$input_string,
		$element = `[]`
	)

protected

Recursively dig into the element array looking for a match on the dot syntax string. If found, return true and we will use the input substitution value for the existing array value.

Parameters

string	$id,the	element container ID attribute
string	$key_to_find,the	current member key we are looking for
string	$input_string,the	dot-syntax input string
array	$element,current	element array

Returns: bool

Definition at line 630 of file CreateMenu.php.

   {
     if (!is_string($input_string) || empty($input_string) || !count($element))
     {
         return false;
     }
 
     if (strpos($input_string, '.') !== false)
     {
         $key_found  = false;
         $keys       = explode('.', $input_string);
         // We are already checking the parent element
         $find_id = array_shift($keys);
         if (! ($find_id == $id)) {
           return false;
         }
 
         foreach ($keys as $inner_key)
         {
             if (array_key_exists($inner_key, $element)) {
 
               if ($inner_key == $key_to_find) {
                 $key_found = true;
                 break;
               }
 
               $element = $element[$inner_key];
             }
         }
 
         return $key_found;
     }
 
     // No one home
     return false;
 }

◆ isValidConfig()

CreateMenu::isValidConfig ( $arr = [] )

protected

Check that the array decoded from JSON has valid array members.

Parameters

array $arr

Returns: bool

Definition at line 223 of file CreateMenu.php.

   {
     if ($arr === false) {
       $this->errors[] = "Could not read the JSON configuration.";
       return false;
     }
 
     if (! (isset($arr['container']) && is_array($arr['container']))) {
       $this->errors[] = "There is no container element in the configuration.";
     }
 
     if (! (isset($arr['items']) && is_array($arr['items']))) {
       $this->errors[] = "There is no menu items array in the configuration.";
     }
 
     return true;
   }

◆ jsonPathParam()

CreateMenu::jsonPathParam ( $params )

protected

Get the JSON file path from params.

Parameters

$params

Returns: string|null

Definition at line 209 of file CreateMenu.php.

   {
     if (! (isset($params['json_path']) && ! empty($params['json_path']))) {
       return null;
     }
 
     return $params['json_path'];
   }

◆ makeMenu()

CreateMenu::makeMenu ( $params = [] )

Main entry point, convert the JSON array to a menu, substituting any values required and return final HTML.

Parameters

array $params

Returns: string

Definition at line 62 of file CreateMenu.php.

   {
     return $this
       ->setMenuArray($params)
       ->setMenuParams($params)
       ->makeMenuHtml()
       ->returnMenuHtml();
   }

◆ makeMenuHtml()

CreateMenu::makeMenuHtml ( )

protected

Make the menu and store in $this->menu_html.

Returns: $this

Definition at line 270 of file CreateMenu.php.

   {
     if ($this->isErrors()) {
       return $this;
     }
 
     // Already checked for these keys.
     $container  = $this->menu_array['container'];
     $items      = $this->menu_array['items'];
 
     $this->menu_html =
       $this->createMenuToggleElement() .
       $this->createElementHtml($container, false) .
       $this->walkMenuItems($items) .
       $this->closeHtmlElement($container);
 
     return $this;
   }

◆ makeSingleMenuNode()

CreateMenu::makeSingleMenuNode	(	$node_id = `''`,
		$params = `[]`,
		$full_node = `false`
	)

Using the same methods above, return the content of a single node in the array. Digs recursively into the array until it finds $node_id and depending on the wrapper flag, returns the full node or its content only.

Parameters

string	$node_id
array	$params
bool	$full_node	- give us the element as is in the array false = just its content

Returns: string

Definition at line 81 of file CreateMenu.php.

   {
     $this
       ->setMenuArray($params)
       ->setMenuParams($params);
 
     $node = $this->findNode($node_id);
     if (count($node) > 0) {
       return ($full_node)?
         $this->createElementHtml($node, true) :
         $this->addElementContent($node_id, $node);
     }
 
     return '';
   }

◆ openHtmlElement()

CreateMenu::openHtmlElement ( $element = [] )

protected

Open a valid HTML element.

Parameters

array $element

Returns: string|null

Definition at line 419 of file CreateMenu.php.

   {
     if (! isset($element['html-element'])) {
       return null;
     }
 
     return
         $this->addIndent($element['html-element']) .
         "<{$element['html-element']}";
   }

◆ recurseDigArray()

CreateMenu::recurseDigArray	(	$node_id,
		$sub_array
	)

protected

Helper for recursivelyWalkArray(), if we have a numerically indexed array, walk it and look for the node identified by $node_id.

Parameters

string	$node_id
array	$sub_array

Returns: array

Definition at line 162 of file CreateMenu.php.

   {
     if (is_array($sub_array) && ! $this->isAssociativeArray($sub_array)) {
 
       foreach ($sub_array as $node_array) {
 
         $element_array = $this->recursivelyWalkArray($node_id, $node_array);
         $id = $this->getElementId($element_array);
 
         if (($id == $node_id)) {
           return $element_array;
         }
       }
     }
 
     return [];
   }

◆ recursivelyWalkArray()

CreateMenu::recursivelyWalkArray	(	$node_id,
		$item
	)

protected

Helper for findNode(). Recursively dig into the array and attempt to locate the array identified by $node_id.

Parameters

string	$node_id
array	$item

Returns: array

Definition at line 125 of file CreateMenu.php.

   {
     if (! is_array($item)) {
       return[];
     }
 
     // Check top level, if it's there cool, we're done.
     $id = $this->getElementId($item);
     if (($id == $node_id)) {
       return $item;
     }
 
     // Walk $item array, if a matching ID is found, also done.
     foreach ($item as $key => $value) {
 
       $id = $this->getElementId($value);
       if (($id == $node_id)) {
         return $value;
       }
 
       // If we have nothing, recurse this function and walk through sub arrays.
       $element_array = $this->recurseDigArray($node_id, $value);
       if (count($element_array) > 0) {
         return $element_array;
       }
     }
 
     return [];
   }

◆ returnMenuHtml()

CreateMenu::returnMenuHtml ( )

protected

Return the response, whether it's errors or the menu.

Returns: string

Definition at line 746 of file CreateMenu.php.

   {
     if ($this->isErrors()) {
       return $this->composeErrors();
     }
 
     return $this->menu_html;
   }

◆ setMemberValue()

CreateMenu::setMemberValue	(	$id,
		$value,
		$key_to_find,
		$element = `[]`
	)

protected

Set substitution value if found, otherwise return what's already in the array.

Parameters

string	$id,the	element ID
mixed	$value,existing	value in array
string	$key_to_find,the	current member we are looking for if found in input
array	$element

Returns: mixed|null

Definition at line 588 of file CreateMenu.php.

   {
     $sub_value = $this->setSubValue($id, $key_to_find, $element);
 
     if (! is_null($sub_value)) {
       return $sub_value;
     }
 
     return $value;
   }

◆ setMenuArray()

CreateMenu::setMenuArray ( $params = [] )

protected

Extract the JSON file path and convert to an array. Or try to.

Parameters

array $params

Returns: $this

Definition at line 185 of file CreateMenu.php.

   {
     $json_path = $this->jsonPathParam($params);
 
     if (! is_readable($json_path)) {
       $this->errors[] = "File $json_path is not readable.";
       return $this;
     }
 
     $arr = json_decode(file_get_contents($json_path), 1);
     if (! $this->isValidConfig($arr)) {
       return $this;
     }
 
     $this->menu_array = $arr;
 
     return $this;
   }

◆ setMenuParams()

CreateMenu::setMenuParams ( $params = [] )

protected

Extract substitution values from input and set them as input params as an internal property.

Parameters

array $params

Returns: $this

Definition at line 246 of file CreateMenu.php.

   {
     if ($this->isErrors()) {
       return $this;
     }
 
     if (
       ! isset($params['substitute_values']) &&
       is_array($params['substitute_values'])
     ) {
       return $this;
     }
 
     foreach ($params['substitute_values'] as $key => $value) {
       $this->params[$key] = $value;
     }
 
     return $this;
   }

◆ setSubValue()

CreateMenu::setSubValue	(	$id,
		$key_to_find,
		$element = `[]`
	)

protected

If there is a substitution value in input params, return it.

Parameters

string	$id
string	$key_to_find,the	current member we are looking for if found in input
array	$element

Returns: mixed|null

Definition at line 606 of file CreateMenu.php.

   {
     foreach ($this->params as $identifier => $value) {
 
         $ret = $this->isKeyInArray($id, $key_to_find, $identifier, $element);
 
         if ($ret) {
           return $value;
         }
 
     }
     return null;
   }

◆ translateValuesIfRequired()

CreateMenu::translateValuesIfRequired	(	$attr,
		$value
	)

protected

Parameters

$attr
$value

Returns: string

Definition at line 533 of file CreateMenu.php.

   {
     if (! in_array($attr, ['title', 'aria-label', 'alt', 'label'])) {
       return $value;
     }
       $translate = $this->HB_ENV['MC']->msg($value);
       return (! empty($translate))? $translate : $value;
   }

◆ userContentOverride()

CreateMenu::userContentOverride ( $id )

protected

Users may override content, such as a dynamically created link text or other content. The first and last elements (container id and identifier 'content') are all we need in this case. if the ID and identifier match, return user-provided content.

Parameters

string $id

Returns: string|null

Definition at line 714 of file CreateMenu.php.

   {
     foreach ($this->params as $identifier => $value) {
 
         $path     = explode('.', $identifier);
         $find_id  = array_shift($path);
         $target   = array_pop($path);
 
         if (($target == 'content') && ($find_id == $id)) {
           return $value;
         }
     }
 
     return null;
   }

◆ walkMenuItems()

CreateMenu::walkMenuItems ( $items = [] )

protected

Helper for makeMenuHtml(), walk the menu items and compose the HTML string.

Parameters

array $items

Returns: string|null

Definition at line 311 of file CreateMenu.php.

   {
     $html = null;
 
     foreach ($items as $item) {
       $html .= $this->createElementHtml($item, true);
     }
 
     return $html;
   }

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

app/web/banking/library/menu-creators/CreateMenu.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addElementAttributes()

◆ addElementClasses()

◆ addElementContent()

◆ addIndent()

◆ addNewLine()

◆ closeElementOpen()

◆ closeHtmlElement()

◆ composeErrors()

◆ createElementHtml()

◆ createMenuToggleElement()

◆ filterInputValue()

◆ findNode()

◆ getElementId()

◆ hasDisplayValue()

◆ hasUserDisplayValue()

◆ isAssociativeArray()

◆ isAttributeMember()

◆ isClassMember()

◆ isContentMember()

◆ isCuAndUser()

◆ isErrors()

◆ isKeyInArray()

◆ isValidConfig()

◆ jsonPathParam()

◆ makeMenu()

◆ makeMenuHtml()

◆ makeSingleMenuNode()

◆ openHtmlElement()

◆ recurseDigArray()

◆ recursivelyWalkArray()

◆ returnMenuHtml()

◆ setMemberValue()

◆ setMenuArray()

◆ setMenuParams()

◆ setSubValue()

◆ translateValuesIfRequired()

◆ userContentOverride()

◆ walkMenuItems()