Jump to content
kongondo

Menu Builder

Recommended Posts

I don't know if MSN can use a WireArray to build menus. It certainly can take a PageArray and build a menu out of that. The key here is that MSN relies on true/natural PW child-parent relationships (unless something has changed that I don't know about) to create menus. So, $page->children will make sense to it. You won't get $page->children in MB...at least not in that original sense.

My bad. It is PageArray, not WireArray.

Anyway, could you consider the scenario of somehow making it possible for MenuBuilder and MarkupSimpleNavigation to work together? Maybe providing PageArray output with some dynamically-made-up pages for external links?

I really like the idea of separating concerns. It seems to me very handy to have one module to build menu markup from anywhere (MarkupSimpleNavigation) and one module to be able to generate contents for it from custom user input (MenuBuilder). So you do not have to learn two ways of doing the same thing on one site.

What do you think? Could this be possible?

Share this post


Link to post
Share on other sites

OK...sigh...because you asked nicely...
 
@note: 

  • Using this method, it makes no sense to create a menu with more than 1 level  in Menu Builder. The levels will be built using natural child-parent relationship in MSN
  • The CSS attritubes that can be set in MB have no meaning. I see no way of passing those to MSN
  • This was a one-time exercise. Currently, I am not able to support more features for this technique :-)

Step 1: Create a 1-level menu in MB
 
post-894-0-73568400-1464003482_thumb.png
 
Step 2:  Grab menu items from the menu created in MB in Step #1

$itemIDs = '';

$mb = $modules->get("MarkupMenuBuilder");
 
// options 1: get menu items as array
$menuItemsArray = $mb->getMenuItems('Ivan Gretsky', 1);
foreach($menuItemsArray as $m) $itemIDs .= $m['pages_id'] . '|'; 
$itemIDs = rtrim($itemIDs, '|');
 
        #### OR ####
 
//option 2: get menu items as object (WireArray)
$menuItemsObj = $mb->getMenuItems('Ivan Gretsky'); 
// implode the WireArray the cool way (PW 2.4+)
$itemIDs = $menuItemsObj->implode('|', 'pagesID');
 
// get a PageArray using menu item IDs
$itemsPageArray = $pages->find('id=' . $itemIDs);

 
Step 3: Output the menu using MSN

// pass the PageArray to MSN (optionally passing it MSN $options) to output your menu
$menu = $modules->get("MarkupSimpleNavigation");
echo $menu->render($options, null, $itemsPageArray);
  • Like 3

Share this post


Link to post
Share on other sites

Hi,

I got a problem, which makes me scratch my head a lot.

I have a menu item with two children, which are 'hidden', but not 'unpublished'. (A newsletter opt in page with landing pages for the double-opt-in-process.)

The menu generated looks like this (just the last 3 items):

                <li>
                    <a href='/pw/de/impressum/'>Impressum</a>
                </li>
                <li>
                    <a href='/pw/de/kontakt/'>Kontakt</a>
                </li>
                <li class="current">
                    <a href='/pw/de/newsletter/'>Newsletter</a>
                    <ul class="submenu">
                    </ul>
                </li>

As one can see, there is an empty ul in the last li. This causes some trouble with some jQuery - mobile - navigation generator.

What is puzzling me is, that in a second menu, which just contains this last 3 items (a footer in the non-mobile version) this ul does not appear. I could not find any differences in the menu settings. 

FYI: runs otherwise smoohtly on pw 3.08 dev.

Share this post


Link to post
Share on other sites

Works fine here...(2.7.3)...How are you building and generating the menu? Using includeChildren? Anything else?

Share this post


Link to post
Share on other sites

Thanks for your answer.

I can indeed make the empty ul make disappear by setting

'include_children' => 0

in the options. But then, also those items, which shall have their submenu, don't have one. 

Also, i can switch on an unintended empty ul in another menu, when i set include_children to 1 there.

Share this post


Link to post
Share on other sites

My intent was not to suggest that you use include_children as a solution. What I needed is more information to reproduce this. I have been unable to replicate you issue so the more information I have the better :-)...How the menu is constructed, the options, your environment, etc...basically, the whole code if that is possible....

Edited by kongondo

Share this post


Link to post
Share on other sites

Ah, ok. I'll attach all files i think could be relevant. if you want more, just drop a line.

It's  the "newsletter" item, which has the empty ul.

post-4083-0-08867200-1464815536_thumb.jp

Share this post


Link to post
Share on other sites

Hi, I found a possible cause for the issue when tampering with my own menu function and running into the very same problem.

In line 351 of MarkupMenuBuilder.module 

if($p->numChildren) $hasNativeChildren = 1;// has children to add

is the function numChildren used. This function counts in default mode also hidden children. 

To make it count only visible children, it has to be used with a parameter:

if($p->numChildren(true)) $hasNativeChildren = 1;// has children to add

I tried it and it seems to work! :-)

Share this post


Link to post
Share on other sites

Ok, this might just be a dumb question...But, has anyone had any success adding "<span class="caret"></span>" into a menu yet using bootstrap? My dropdown works great, save for the the fact that for the life of me I can not figure out how to get the dropdown li to have a caret.

Share this post


Link to post
Share on other sites

Hi, I found a possible cause for the issue when tampering with my own menu function and running into the very same problem.

In line 351 of MarkupMenuBuilder.module 

if($p->numChildren) $hasNativeChildren = 1;// has children to add

is the function numChildren used. This function counts in default mode also hidden children. 

To make it count only visible children, it has to be used with a parameter:

if($p->numChildren(true)) $hasNativeChildren = 1;// has children to add

I tried it and it seems to work! :-)

OK, I'll try and replicate. As for the files, seems I wasn't clear, sorry. I just needed to see how you were calling menubuilder methods + the options you were passing to it :-)

Ok, this might just be a dumb question...But, has anyone had any success adding "<span class="caret"></span>" into a menu yet using bootstrap? My dropdown works great, save for the the fact that for the life of me I can not figure out how to get the dropdown li to have a caret.

Have a look here: https://processwire.com/talk/topic/4451-menu-builder/?p=120639

Share this post


Link to post
Share on other sites

Ha ha.. touche.. Well, I will get this all sorted out. I went with Example "1b", however, I am getting "Call to undefined function buildMenuFromObject()"... Any idea what could cause this?

Share this post


Link to post
Share on other sites

Example 1b is for buildMenuFromArray() actually...buildMenuFromObject() is for example 1a. Whichever you choose, you need to define the function first before you can call it...(i.e. the function code first, then echo it...)

Edited by kongondo

Share this post


Link to post
Share on other sites

Thank you so much (and sorry for my confusion). I thought I had it, but now I am just getting 6 errors:

Error: Exception: Method MarkupMenuBuilder::getMenuItems does not exist or is not callable in this context (in Desktop/_Staging/test/wire/core/Wire.php line 409)

#0 [internal function]: ProcessWire\Wire->___callUnknown('getMenuItems', Array)
#1 Desktop/_Staging/test/wire/core/Wire.php(347): call_user_func_array(Array, Array)
#2 Desktop/_Staging/test/wire/core/WireHooks.php(555): ProcessWire\Wire->_callMethod('___callUnknown', Array)
#3 Desktop/_Staging/test/wire/core/Wire.php(370): ProcessWire\WireHooks->runHooks(Object(MarkupMenuBuilder), 'callUnknown', Array)
#4 Desktop/_Staging/test/wire/core/Wire.php(371): ProcessWire\Wire->__call('callUnknown', Array)
#5 Desktop/_Staging/test/site/templates/navTwo.inc(11): ProcessWire\Wire->__call('getMenuItems', Array)
#6 /Desktop/_Staging/test/site/templates/head.inc(85): include('/Us

I am a bit lost on this now, though I am trying to dig through them and understand what they mean.

What I have thus far (all using example 1b):

head.inc

   <div class="collapse navbar-collapse container" id="bs-example-navbar-collapse-1">
     <?php //include('./navigation.inc');?>
     <?php include('./navTwo.inc');?>
     <?php  echo buildMenuFromArray(0, $menuItems2); ?>
   </div><!-- /.navbar-collapse -->

navTwo.inc

<?php
$mb = $modules->get('MarkupMenuBuilder');// get Menu Builder

$jsonStr = $pages->get(1033)->menu_items;
$arrayFromJSON = json_decode($jsonStr, true);
#$menu = $arrayFromJSON;// pass an array
$menu = 'main';// pass a title

/** grab menu items as WireArray with Menu objects **/
// for examples 1a, 2 and 3
$menuItems = $mb->getMenuItems($menu, 2, $options);// called with options and 2nd argument = 2 {return Menu (WireArray object)}
#$menuItems = $mb->getMenuItems($menu);// called without options; 2nd argument defaults to 2

/** grab menu items as Normal Array with Menu items **/
// only for example 1b below
$menuItems2 = $mb->getMenuItems($menu, 1);// called without options; 2nd argument is 1 so return array

/**
* Builds a nested list (menu items) of a single menu from an Array of menu items.
*
* A recursive function to display nested list of menu items.
*
* @access private
* @param Int $parent ID of menu item.
* @param Array $menu Array of menu items to display.
* @param Int $first Helper variable to designate first menu item.
* @return string $out.
*
*/
function buildMenuFromArray($parent = 0, $menu, $first = 0) {

  $out = '';
  $has_child = false;

  foreach ($menu as $id => $m) {

    $parentID = isset($m['parent_id']) ? $m['parent_id'] : 0;
    $newtab = isset($m['newtab']) && $m['newtab'] ? " target='_blank'" : '';
    // if this menu item is a parent; create the sub-items/child-menu-items
    if ($parentID == $parent) {// if this menu item is a parent; create the inner-items/child-menu-items

        // if this is the first child
        if ($has_child === false) {
            $has_child = true;// This is a parent
            if ($first == 0){
              $out .= "<ul class='main-menu cf'>\n";
              $first = 1;
            }
            else $out .= "\n<ul class='sub-menu'>\n";
        }

        $class = isset($m['is_current']) && $m['is_current'] ? ' class="current"' : '';

        // a menu item
        $out .= '<li' . $class . '><a href="' . $m['url'] . '"' . $newtab . '>' . $m['title'];
        // if menu item has children
        if (isset($m['is_parent']) && $m['is_parent']) {
          $out .= '<span class="drop-icon">▼</span>' .
              '<label title="Toggle Drop-down" class="drop-icon" for="' . wire('sanitizer')->pageName($m['title']) . '" onclick>▼</label>' .
          '</a>' .
          '<input type="checkbox" id="' . wire('sanitizer')->pageName($m['title']) . '">';
        }

        else $out .= '</a>';

        // call function again to generate nested list for sub-menu items belonging to this menu item.
        $out .= buildMenuFromArray($id, $menu, $first);
        $out .= "</li>\n";

    }// end if parent

  }// end foreach

  if ($has_child === true) $out .= "</ul>\n";

  return $out;

}



?>

Did I miss something crucial here?

Share this post


Link to post
Share on other sites

I see you copied and pasted more code than necessary. I have used your code and it works for me...

First, you need to make sure you have the latest version of Menu Builder which has the method getMenuItems(), i.e. version 0.1.5

head.inc

<div class="collapse navbar-collapse container" id="bs-example-navbar-collapse-1">
  <?php include('./navTwo.inc');?>
  <?php  echo buildMenuFromArray(0, $menuItems); ?>
</div><!-- /.navbar-collapse -->

navTwo.inc

<?php
$mb = $modules->get('MarkupMenuBuilder');// get Menu Builder
$menu = 'Main';// pass a title of an existing menu (i.e. a menu already built and published in ProcessMenuBuilder)

// grab menu items as Normal Array with Menu items (argument #2 = 1)
$menuItems = $mb->getMenuItems($menu, 1);

/**
* Builds a nested list (menu items) of a single menu from an Array of menu items.
*
* A recursive function to display nested list of menu items.
*
* @access private
* @param Int $parent ID of menu item.
* @param Array $menu Array of menu items to display.
* @param Int $first Helper variable to designate first menu item.
* @return string $out.
*
*/
function buildMenuFromArray($parent = 0, $menu, $first = 0) {

  $out = '';
  $has_child = false;

  foreach ($menu as $id => $m) {

    $parentID = isset($m['parent_id']) ? $m['parent_id'] : 0;
    $newtab = isset($m['newtab']) && $m['newtab'] ? " target='_blank'" : '';
    // if this menu item is a parent; create the sub-items/child-menu-items
    if ($parentID == $parent) {// if this menu item is a parent; create the inner-items/child-menu-items

        // if this is the first child
        if ($has_child === false) {
            $has_child = true;// This is a parent
            if ($first == 0){
              $out .= "<ul class='main-menu cf'>\n";
              $first = 1;
            }
            else $out .= "\n<ul class='sub-menu'>\n";
        }

        $class = isset($m['is_current']) && $m['is_current'] ? ' class="current"' : '';

        // a menu item
        $out .= '<li' . $class . '><a href="' . $m['url'] . '"' . $newtab . '>' . $m['title'];
        // if menu item has children
        if (isset($m['is_parent']) && $m['is_parent']) {
          $out .= '<span class="drop-icon">▼</span>' .
              '<label title="Toggle Drop-down" class="drop-icon" for="' . wire('sanitizer')->pageName($m['title']) . '" onclick>▼</label>' .
          '</a>' .
          '<input type="checkbox" id="' . wire('sanitizer')->pageName($m['title']) . '">';
        }

        else $out .= '</a>';

        // call function again to generate nested list for sub-menu items belonging to this menu item.
        $out .= buildMenuFromArray($id, $menu, $first);
        $out .= "</li>\n";

    }// end if parent

  }// end foreach

  if ($has_child === true) $out .= "</ul>\n";

  return $out;

}

?>

Share this post


Link to post
Share on other sites

Thanks again.. Finally starting to understand what is going on, but now it is time to figure out how to give the "second nested ul" a different class than the wrapper ul. I thought I could pass that through with $options, but that doesnt seem to work. (sorry to drag this thread out).

Share this post


Link to post
Share on other sites

Actually, my bad; the README and my post above wasn't very clear (have now updated them). Not all options apply to getMenuItems(). The reason is that if using MarkupMenuBuilder to output the menu for you, i..e using the method render(), the structuring of the menu (the <ul>, their CSS classes, etc) are taken care of by the method. In contrast, if using getMenuItems() what you get back are the menu items with all their relevant properties. The reasoning here is that you will use those properties as well as any other logic and/or options you want in your own custom recursive function (nested loops) where you have full control of the markup. That said, only 3 options (from the list of those applicable to render()) apply to getMenuItems(). These are default_title, default_class and current_class_level. default_class is applied to the  item's property $m['ccss_itemclass'].

Here is a revised navTwo.inc showing how you can pass custom options to the recursive function and applying the same as well as the 3 options that can be passed to getMenuItems(). head.inc is also slightly revised to pass $options to buildMenuFromArray()

- @note: The new 4th argument in the function

- @note: The custom options array

- @note: Complete code for previous examples 1-3 can be found in these gists

head.inc

<div class="collapse navbar-collapse container" id="bs-example-navbar-collapse-1">
 <?php include('./navTwo.inc');
  // your CUSTOM options to pass to the recursive function buildMenuFromArray()
  $options = array (
   'submenu_css_class' => 'nested-ul-css-class',//CSS Class for sub-menus; you can use whatever index you want
   'other_custom_option' => 'foo',
   'first_class' => 'first',
   'last_class' => 'last',
   'current_class' => 'current',
   'has_children_class' => 'parent',
 );

  echo buildMenuFromArray(0, $menuItems, 0, $options);

 ?>
</div><!-- /.navbar-collapse -->

navTwo.inc

<?php
$mb = $modules->get('MarkupMenuBuilder');// get Menu Builder
$menu = 'Main';// pass a title of an existing menu (i.e. a menu already built and published in ProcessMenuBuilder)

// @note: only these 3 options will work with getMenuItems(); Only pass options if you need to; it is not mandatory 
$options4getMenuItems = array('default_title' => 1, 'default_class' => 'list-group', 'current_class_level' => 4);

// grab menu items as Normal Array with Menu items (argument #2 = 1)
#$menuItems = $mb->getMenuItems($menu, 1); OR
$menuItems = $mb->getMenuItems($menu, 1, $options4getMenuItems);// if passing options

/**
* Builds a nested list (menu items) of a single menu from an Array of menu items.
*
* A recursive function to display nested list of menu items.
*
* @access private
* @param Int $parent ID of menu item.
* @param Array $menu Array of menu items to display.
* @param Int $first Helper variable to designate first menu item.
* @return string $out.
*
*/
function buildMenuFromArray($parent = 0, $menu, $first = 0, $options = array()) {

  $out = '';
  $has_child = false;
  $subMenuCSSClass = isset($options['submenu_css_class']) ?  'class="' . $options['submenu_css_class'] . '"' :  '';

  foreach ($menu as $id => $m) {

    $parentID = isset($m['parent_id']) ? $m['parent_id'] : 0;
    $newtab = isset($m['newtab']) && $m['newtab'] ? " target='_blank'" : '';
    // if this menu item is a parent; create the sub-items/child-menu-items
    if ($parentID == $parent) {// if this menu item is a parent; create the inner-items/child-menu-items

        // if this is the first child
        if ($has_child === false) {
            $has_child = true;// This is a parent
            if ($first == 0){
              $out .= "<ul class='main-menu cf'>\n";
              $first = 1;
            }
            else $out .= "\n<ul ". $subMenuCSSClass .">\n";
        }

	// item CSS
	$itemCSSID = isset($m['css_itemid'])? ' id="' . $m['css_itemid'] . '"' : '';				
	$itemCSSClass = isset($m['css_itemclass']) ? $m['css_itemclass'] . ' ' : '';
	$itemFirst = isset($m['is_first']) && isset($options['first_class']) ? $options['first_class'] : '';				
	$itemHasChildren = isset($m['is_parent']) && isset($options['has_children_class']) ? $options['has_children_class'] . ' ' : '';				
	$itemLast = isset($m['is_last']) && isset($options['last_class']) ? $options['last_class'] . ' ' : '';
	$itemCurrent = 	isset($m['is_current']) && isset($options['current_class']) ? $options['current_class'] . ' ' : '';

	$classes = $itemCSSClass . $itemHasChildren . $itemLast . $itemCurrent . $itemFirst;
	$classes = trim(preg_replace('/\s+/', ' ', $classes));
	$class = strlen($classes) ? ' class="' . $classes . '"' : '';

        // a menu item
        $out .= '<li' . $itemCSSID . $class . '><a href="' . $m['url'] . '"' . $newtab . '>' . $m['title'];
        // if menu item has children
        if (isset($m['is_parent']) && $m['is_parent']) {
          $out .= '<span class="drop-icon">▼</span>' .
              '<label title="Toggle Drop-down" class="drop-icon" for="' . wire('sanitizer')->pageName($m['title']) . '" onclick>▼</label>' .
          '</a>' .
          '<input type="checkbox" id="' . wire('sanitizer')->pageName($m['title']) . '">';
        }

        else $out .= '</a>';

        // call function again to generate nested list for sub-menu items belonging to this menu item.
        $out .= buildMenuFromArray($id, $menu, $first, $options);
        $out .= "</li>\n";

    }// end if parent

  }// end foreach

  if ($has_child === true) $out .= "</ul>\n";

  return $out;

}

?>

Share this post


Link to post
Share on other sites

Thanks again Kongondo! I appreciate all the help. I actually figured it out about 5 mins ago (forgot to check back on the forums). It feel good to have actually learned through your help and the various comments what actually is occurring and not blindly copying. Your module has made things so much easier (once I learned).

Share this post


Link to post
Share on other sites

Hey kongondo,

thanks for thi great module again. A few days ago I figured out, that the output of the main menu builder header is not formated in html. Maybe it has to do with some other modules installed, because I never had the issue, that the output is not "rendered" as HTML.

Does anyone else have this issue, too?

 

menubuilder.jpg

Share this post


Link to post
Share on other sites

Saw that once in a multilingual setup, IIRC.....What's your setup? PW version, etc...

Share this post


Link to post
Share on other sites

Hey, 

 

thanks for your fast reply. I attached a screenshot with my current setup. You are right, the page is multilingual. 

Maybe you cna give me a hint, how I can solve this?

screenshot-2016-06-29 10-55-17.png

It seems, that the HTML is not rendered correctly. I tried to edit the HTML of the decription field and put Markdon tags in the description, which are displayed correct.

 

Edited by pmichaelis
Description Field HTML

Share this post


Link to post
Share on other sites

Sorry,

I still can't figure it out. All the descriptions are not displayed as HTML. A can't update Menu Item, or anything else. Does anyone have a hint for me to solve this?

Share this post


Link to post
Share on other sites

I see you are using PW 3.x. Could you please try in a multilingual PW 2.7xx and let me know if it works?

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By jploch
      Hey folks,
      for a module (a pagebuilder based on PageTable) I need to save some settings as JSON. The values are saved for each page table item (a pw page). It's working well, but I am looking for ways to improve the structure I have. As I'm not that experienced with JSON, maybe someone more experienced can take a look and tell me if my approach is good practice. 

      My goal is to make all the items accessible by page id, without looping over them (using objects instead of arrays):
      // access from template with pw page var $jsonObject->items->{$page}->cssClass; Her is an example of my JSON structure:
      { "items": { "3252": { "id": "3252", "cssClass": "pgrid-main", "breakpoints": { "base": { "css": { "grid-column-end": "auto", "grid-row-end": "auto", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "60px", "padding-right": "60px", "padding-top": "60px", "padding-bottom": "60px", "background-color": "rgb(255, 255, 255)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3686": { "id": "3686", "cssClass": "test_global", "breakpoints": { "base": { "css": { "grid-column-end": "-1", "grid-row-end": "span 1", "grid-column-start": "1", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3687": { "id": "3687", "cssClass": "block_editor-3687", "breakpoints": { "base": { "css": { "grid-column-end": "span 2", "grid-row-end": "span 1", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } }, "3696": { "id": "3696", "cssClass": "block_editor-3696", "breakpoints": { "base": { "css": { "grid-column-end": "span 2", "grid-row-end": "span 1", "grid-column-start": "auto", "grid-row-start": "auto", "align-self": "auto", "z-index": "auto", "padding-left": "0px", "padding-right": "0px", "padding-top": "0px", "padding-bottom": "0px", "background-color": "rgba(0, 0, 0, 0)", "color": "rgb(0, 0, 0)" }, "size": "@media (min-width: 576px)", "name": "base" } } } }, "breakpointActive": "base", "breakpointActiveSize": "@media (min-width: 576px)" }  
    • By jploch
      Fieldtype Page Table Grid
      This is a sneak preview of a side project I've been working on for quite some time now. A lot of work and thought has gone into this, so I will most likely release this as a commercial module at some point in the near future. 

      As a designer (and developer) I get the appeal of a WYSIWYG editor. After playing around with some WYSIWYG page builder tools, I always felt something was wrong about them. So I decided to build my own PW version based on PageTable.

      Here is a small demo (using AdminThemeCanvas, but its working with other admin themes as well) :
      There is also a complete website that I built for a friend of mine using this module and some custom blocks.
      Concept
      This fieldtype shares a lot of features with PageTableExtended: it's also an extension of PageTable and renders the block templates in the backend and frontend (native PW templates and fields). You can also add your own css via module settings.
      The difference is, this fieldtype also gives you the ability to rearrange and resize elements in a visual way as well as enable inline editing for text, ckeditor and file fields. Similar (and promising) attempts have been made, but I wanted something based on native CSS grid instead of a CSS framework...so I built my own version. Most CSS frameworks are based on flexbox, which is great for layouting elements horizontally. With CSS grid, you can place elements horizontally and vertically, allowing for layouts that were not previously possible with CSS. Similar to webflow, this fieldtype uses javascript (in the backend) to let you manipulate CSS grid in a visual way to design fully responsive websites (or parts of them). It should still be possible to include a CSS framework if you like (just add the classes to your block markup and include the CSS via module settings).
      The CSS grid layout manipulations are saved in a single field as a JSON array and used to generate a dynamic stylesheet that you simply include in your main template (no inline styles). The styles are saved within the breakpoint you select and cascade down to smaller breakpoints. That means you can specify just the basic breakpoint and adjust other breakpoints if needed. The exception is the mobile breakpoint which will display everything in one column as a default (you can change the layout here too).
      The fieldtype also comes with an optional style panel to manipulate some additional CSS properties directly on the page. You can customize the panel or disable it completely from the module settings (and just use a CSS file that you include via module settings). The style panel is based on inputfields (nothing is saved to the database). This means that you just have to install the module and all fields are available to all blocks automatically (this can be customized). It also has the benefit that your installation is not flooded with fields; this module only installs one field.
      Don't want to give your customer all that power? Design features can be disabled for certain roles. The grid editor role can just edit the content and use the inline editing feature to edit content quickly. You can then also grant access individually to the style panel, resize or drag functionality.
      Features
      Blocks are just pages Blocks are defined by native PW templates and fields Manipulate CSS grid in a visual way to design fully responsive websites (or parts of them) Design features can be disabled for certain roles Inline editing of text, ckeditor and file fields The layout is 100% CSS grid (very small css file size) Simply drag and resize to manipulate grid items directly inside the backend Manipulate grid columns and rows directly on the page (use any number of columns you want) All style manipulations are saved as JSON and used to generate a dynamic stylesheet that you just include in your main template (no inline styles) Nested groups/grids (child pages of nested blocks are created under group parent) Global blocks work with page reference field (changes on one page, changes all blocks on all pages) Manual and auto placement of grid items Define custom icons for your blocks via native template settings (template -> advanced -> icon) Option to load lazysizes in the backend to enable lazy loading of assets with class lazyload Works with all default and ui-kit based admin themes If you have any questions or feedback, let me know.
    • By bernhard
      I built this module because I needed a versatile solution to replace tags and simple if-blocks in some E-Mails and PDF documents.
      If you only need to replace static tags (no if-conditions), then you can use default PW api and need no module:
      $str = "My favourite color is {color}."; $texttools = $sanitizer->getTextTools(); echo $texttools->populatePlaceholders($str, ['color' => 'red']); // output: My favourite color is red. Usage:
      See the two example Files in the folder /replacements

       
      Methods:
      replacementsTable()
      Renders an overview of all available replacements (see the example in the Module's config file:
       
      Create new Replacements:
      Simply copy the sample file and adopt to your needs.
       
      Download:
      https://gitlab.com/baumrock/RockReplacer
    • By bernhard
      DEPRECATED
      I'm using this module in several projects, but it will likely not see any updates in the future. I'm not happy with it and I'm looking for ways to develop better solutions. RockTabulator was my first try, but I'm also not 100% happy with that. The tabulator library is great, but my module implementation is not. I hope to get a good solution soon, but it will be a lot of work...
      ---
      Some of you might have followed the development of this module here: https://processwire.com/talk/topic/15524-previewdiscussion-rockdatatables/ . It is the successor of "RockDataTables" and requires RockFinder to get the data for the grid easily and efficiently. It uses the open source part of agGrid for grid rendering.
       
      WHY?
      ProcessWire is awesome for creating all kinds of custom backend applications, but where it is not so awesome in my opinion is when it comes to listing this data. Of course we have the built in page lister and we have ListerPro, but none of that solutions is capable of properly displaying large amounts of data, for example lists of revenues, aggregations, quick and easy sorts by the user, instant filter and those kind of features. RockGrid to the rescue 😉 
       
      Features/Highlights:
      100k+ rows Instant (client side) filter, search, sort (different sort based on data type, eg "lower/greater than" for numbers, "contains" for strings) extendable via plugins (available plugins at the moment: fullscreen, csv export, reload, batch-processing of data, column sum/statistics, row selection) all the agGrid features (cell renderers, cell styling, pagination, column grouping etc) vanilla javascript, backend and frontend support (though not all plugins are working on the frontend yet and I don't plan to support it as long as I don't need it myself)  
      Limitations:
      While there is an option to retrieve data via AJAX the actual processing of the grid (displaying, filtering, sorting) is done on the client side, meaning that you can get into troubles when handling really large datasets of several thousands of rows. agGrid should be one of the most performant grid options in the world (see the official example page with a 100k row example) and does a lot to prevent problems (such as virtual row rendering), but you should always have this limitation in mind as this is a major difference to the available lister options that do not have this limitation.
      Currently it only supports AdminThemeUikit and I don't plan to support any other admin theme.
       
      Download: https://gitlab.com/baumrock/FieldtypeRockGrid
      Installation: https://gitlab.com/baumrock/RockGrid/wikis/Installation
      Quikckstart: https://gitlab.com/baumrock/RockGrid/wikis/quickstart
      Further instructions: https://gitlab.com/baumrock/RockGrid/wikis/quickstart#further-instructions
      German Translation File: site--modules--fieldtyperockgrid--fieldtyperockgrid-module-php.json
      Changelog: https://gitlab.com/baumrock/FieldtypeRockGrid/raw/master/changelog.md
       
      Module status: alpha, License: MIT
      Note that every installation and uninstallation sends an anonymous google analytics event to my google analytics account. If you don't want that feel free to remove the appropriate lines of code before installation/uninstallation.
       
      Contribute:
      You can contribute to the development of this and other modules or just say thank you by
      testing, reporting issues and making PRs at gitlab liking this post buying me a drink: paypal.me/baumrock/5 liking my facebook page: facebook.com/baumrock hiring me for pw work: baumrock.com  
      Support: Please note that this module might not be as easy and plug&play as many other modules. It needs a good understanding of agGrid (and JavaScript in general) and it likely needs some looks into the code to get all the options. Please understand that I can not provide free support for every request here in the forum. I try to answer all questions that might also help others or that might improve the module but for individual requests I offer paid support (please contact me via PM).
       
      Use Cases / Examples:
      Colored grid cells, Icons, Links etc. The Grid also has a "batcher" feature built in that helps communicating with the server via AJAX and managing resource intensive tasks in batches:

      Filters, PW panel links and instant reload on panel close:

      You can combine the grid with a chart library like I did with the (outdated) RockDataTables module:

    • By Paul Greinke
      Hi there. I wrote a custom module for one of my projects. In fact I maybe want to use my module in other projects too. In order to be variable and customizable  I need to implement some custom hooks into my module. So I can afterwards hook into the my functions in order to modify them to match the needs of the new project.
      I tried simply defining functions with the '__' prefix. But that did not work. I'm imagining something like the following:
      <?php class MyClass { public function ___someFunction() { // Do something } } // ready.php $this->addHookBefore('MyClass::someFunction', function($event) { // some customization }); Is there a way to accomplish that? 
×
×
  • Create New...