Elxis CMS Forum

Support => Elxis 4.x/5.x DEV => Topic started by: Tank on September 29, 2012, 08:10:17

Title: Module Mod Question
Post by: Tank on September 29, 2012, 08:10:17

Hi all,

Just a question. I made some minor modifications to mod_menu, for a little more advance/versatile menu css templating.
If I made a modification to a current module.. would you prefer me create a new module or share what I did through forums that users may find it useful for later or that Elxis Team may adapt it to next release?

Title: Re: Module Mod Question
Post by: Ivan Trebješanin on September 29, 2012, 09:02:01

I don't know what changes are you talking about, but you can create a module and publish it on EDC for the now.

Title: Re: Module Mod Question
Post by: datahell on September 29, 2012, 11:00:16

Don't create duplicated extensions as you will confuse users.
Each extension should be unique.
Elxis built-in extensions are EPL (https://www.elxis.org/elxis-public-license.html) licensed which does not allow sharing modifying copies of them (improvements should be send back to the original author).
Create your own extension and name it whatever you want. Don't confuse it with the built-in mod_menu extension.

Title: Re: Module Mod Question
Post by: Tank on September 29, 2012, 17:33:40

Quote from: datahell on September 29, 2012, 11:00:16

Don't create duplicated extensions as you will confuse users.
Each extension should be unique.
Elxis built-in extensions are EPL (https://www.elxis.org/elxis-public-license.html) licensed which does not allow sharing modifying copies of them (improvements should be send back to the original author).
Create your own extension and name it whatever you want. Don't confuse it with the built-in mod_menu extension.

It is very minor change, is why I did not want to create a new extension.
I would very much like to share with you and see if Elxis Team will think it's a good idea for the change.

Here's /modules/mod_menu/mod_menu.php

Code: [Select]

<?php 
/**
* @version $Id: mod_menu.php 1040 2012-04-16 08:13:20Z datahell $
* @package Elxis
* @subpackage Module Menu
* @copyright Copyright (c) 2006-2012 Elxis CMS (https://www.elxis.org). All rights reserved.
* @license Elxis Public License ( https://www.elxis.org/elxis-public-license.html )
* @author Elxis Team ( https://www.elxis.org )
* @description  Elxis CMS is free software. Read the license for copyright notices and details
*/

defined(&#39;_ELXIS_&#39;) or die (&#39;Direct access to this location is not allowed&#39;);


if (!class_exists(&#39;modMenu&#39;, false)) {
class modMenu {

private $collection = &#39;mainmenu&#39;;
private $orientation = 0;
private $elxis_uri = &#39;&#39;;
private $is_frontpage = false;
private $lightbox_loaded = false;


/*********************/
/* MAGIC CONSTRUCTOR */
/*********************/
public function __construct($params) {
$this->elxis_uri = eFactory::getURI()->getElxisUri();
if ($this->elxis_uri == &#39;&#39;) {
$this->is_frontpage = true;
} elseif (eFactory::getElxis()->getConfig(&#39;DEFAULT_ROUTE&#39;) == $this->elxis_uri) {
$this->is_frontpage = true;
} else {
$this->is_frontpage = false;
}
$this->getParams($params);
}


/*************************/
/* GET MODULE PARAMETERS */
/*************************/
        private function getParams($params) {
$this->collection = $params->get(&#39;collection&#39;, &#39;mainmenu&#39;);
if ($this->collection == &#39;&#39;) { $this->collection = &#39;mainmenu&#39;; }
$this->orientation = (int)$params->get(&#39;orientation&#39;, 0);
        }


/********************/
/* RUN FOREST, RUN! */
/********************/         
        public function run() {
$items = eFactory::getMenu()->getItems($this->collection, &#39;frontend&#39;);
$this->populate(0, $items);
        }


/*****************/
/* POPULATE MENU */
/*****************/
private function populate($level, $items) {
if (!$items) { return; }

$elxis = eFactory::getElxis();

$t = str_repeat("\t", $level);
$t2 = $t."\t";
$ulclass = &#39;&#39;;
if ($level == 0) {
$ulclass = ($this->orientation == 0) ? &#39; class="elx_vmenu"&#39; : &#39; class="elx_menu"&#39;;
}



$inc = rand(10,99);
echo "\n".$t.&#39;<ul&#39;.$ulclass.&#39;>&#39;."\n";
/* Change start here */
foreach ($items as $key => $item) {
if ($this->elxis_uri == $item->link) {
$liclass = &#39;menu_active&#39;;
} else if (($item->link == &#39;&#39;) && $this->is_frontpage) {
$liclass = &#39;menu_active"&#39;;
} else {
$liclass = &#39;&#39;;
}

if (count($item->children) > 0) {
$lichildclass = &#39;haschild&#39;;
}else{
$lichildclass = &#39;&#39;;
}

/* Change end here */

$contents = &#39;&#39;;
if ($item->menu_type == &#39;url&#39;) {
$onclick = &#39;&#39;;
$hrefid = &#39;&#39;;
if ($item->popup == 2) {
$w = ($item->width > 10) ? $item->width : 970;
$h = ($item->height > 10) ? $item->height : 450;
$this->loadLightBox();
$link = $item->link;
$item->target = &#39;_blank&#39;;
eFactory::getDocument()->addDocReady(&#39;$("#mitem&#39;.$item->menu_id.&#39;_&#39;.$inc.&#39;").colorbox({iframe:true, width:&#39;.$w.&#39;, height:&#39;.$h.&#39;});&#39;);
$hrefid = &#39; id="mitem&#39;.$item->menu_id.&#39;_&#39;.$inc.&#39;"&#39;;
$inc++;
} else if ($item->popup == 1) {
$w = ($item->width > 10) ? $item->width : 970;
$h = ($item->height > 10) ? $item->height : 450;
$onclick = &#39; onclick="elxPopup(\&#39;&#39;.$item->link.&#39;\&#39;, &#39;.$w.&#39;, &#39;.$h.&#39;);"&#39;;
$link = &#39;javascript:void(null);&#39;;
$item->target = &#39;_blank&#39;;
} else {
$link = $item->link;
}
$trg = ($item->target != &#39;_self&#39;) ? &#39; target="&#39;.$item->target.&#39;"&#39; : &#39;&#39;;
$contents = &#39;<a href="&#39;.$link.&#39;" title="&#39;.$item->title.&#39;"&#39;.$hrefid.$onclick.$trg.&#39;>&#39;.$item->title."</a>\n";
} elseif ($item->menu_type == &#39;separator&#39;) {
$liclass = &#39; class="menu_separator"&#39;;
$contents = &#39;<a href="javascript:void(null);">&#39;.$item->title."</a>\n";
} elseif ($item->menu_type == &#39;wrapper&#39;) {
$ssl = ($item->secure == 1) ? true : false;
$onclick = &#39;&#39;;
$hrefid = &#39;&#39;;
if ($item->popup == 2) {
if ($item->file == &#39;&#39;) { $item->file = &#39;inner.php&#39;; }
$w = ($item->width > 10) ? $item->width : 970;
$h = ($item->height > 10) ? $item->height : 450;
$this->loadLightBox();
$link = $elxis->makeURL(&#39;wrapper:&#39;.$item->menu_id.&#39;.html&#39;, $item->file, $ssl, false);
$item->target = &#39;_blank&#39;;
eFactory::getDocument()->addDocReady(&#39;$("#mitem&#39;.$item->menu_id.&#39;_&#39;.$inc.&#39;").colorbox({iframe:true, width:&#39;.$w.&#39;, height:&#39;.$h.&#39;});&#39;);
$hrefid = &#39; id="mitem&#39;.$item->menu_id.&#39;_&#39;.$inc.&#39;"&#39;;
$inc++;
} else if ($item->popup == 1) {
if ($item->file == &#39;&#39;) { $item->file = &#39;inner.php&#39;; }
$w = ($item->width > 10) ? $item->width : 970;
$h = ($item->height > 10) ? $item->height : 450;
$plink = $elxis->makeURL(&#39;wrapper:&#39;.$item->menu_id.&#39;.html&#39;, $item->file, $ssl, false);
$onclick = &#39; onclick="elxPopup(\&#39;&#39;.$plink.&#39;\&#39;, &#39;.$w.&#39;, &#39;.$h.&#39;);"&#39;;
$link = &#39;javascript:void(null);&#39;;
} else {
$link = $elxis->makeURL(&#39;wrapper:&#39;.$item->menu_id.&#39;.html&#39;, $item->file, $ssl);
}
$trg = ($item->target != &#39;_self&#39;) ? &#39; target="&#39;.$item->target.&#39;"&#39; : &#39;&#39;;
$contents = &#39;<a href="&#39;.$link.&#39;" title="&#39;.$item->title.&#39;"&#39;.$hrefid.$onclick.$trg.&#39;>&#39;.$item->title."</a>\n";
} else {
$ssl = ($item->secure == 1) ? true : false;
$onclick = &#39;&#39;;
$hrefid = &#39;&#39;;
if ($item->popup == 2) {
if ($item->file == &#39;&#39;) { $item->file = &#39;inner.php&#39;; }
$w = ($item->width > 10) ? $item->width : 970;
$h = ($item->height > 10) ? $item->height : 450;
$this->loadLightBox();
$link = $elxis->makeURL($item->link, $item->file, $ssl, false);
$item->target = &#39;_blank&#39;;
eFactory::getDocument()->addDocReady(&#39;$("#mitem&#39;.$item->menu_id.&#39;_&#39;.$inc.&#39;").colorbox({iframe:true, width:&#39;.$w.&#39;, height:&#39;.$h.&#39;});&#39;);
$hrefid = &#39; id="mitem&#39;.$item->menu_id.&#39;_&#39;.$inc.&#39;"&#39;;
$inc++;
} else if ($item->popup == 1) {
if ($item->file == &#39;&#39;) { $item->file = &#39;inner.php&#39;; }
$w = ($item->width > 10) ? $item->width : 970;
$h = ($item->height > 10) ? $item->height : 450;
$link = $elxis->makeURL($item->link, $item->file, $ssl, false);
$onclick = &#39; onclick="elxPopup(\&#39;&#39;.$link.&#39;\&#39;, &#39;.$w.&#39;, &#39;.$h.&#39;);"&#39;;
$link = &#39;javascript:void(null);&#39;;
$item->target = &#39;_blank&#39;;
} else {
$link = $elxis->makeURL($item->link, $item->file, $ssl);
}
$trg = ($item->target != &#39;_self&#39;) ? &#39; target="&#39;.$item->target.&#39;"&#39; : &#39;&#39;;
$contents = &#39;<a href="&#39;.$link.&#39;" title="&#39;.$item->title.&#39;"&#39;.$hrefid.$onclick.$trg.&#39;>&#39;.$item->title."</a>\n";
}

/* Change start here */
echo $t2.&#39;<li class="&#39;.$liclass.&#39; &#39;.$lichildclass.&#39;">&#39;."\n";
/* Change end here */

echo $contents;


if (count($item->children) > 0) {
$this->populate($level+1, $item->children);
echo $t2."</li>\n";
} else {
echo "</li>\n";
}


}
echo $t.&#39;</ul>&#39;."\n";
}


/********************************/
/* LOAD ELXIS STANDARD LIGHTBOX */
/********************************/
private function loadLightBox() {
if ($this->lightbox_loaded) { return; }
$this->lightbox_loaded = true;
eFactory::getDocument()->loadLightbox();
}

}
}


$elxmodmenu = new modMenu($params);
$elxmodmenu->run();
unset($elxmodmenu);

?>
in /templates/newtheme/css/site.css

Code: [Select]

.topmenu ul > li.haschild > a{
    background-image: url(../images/icon_down.gif);
    background-repeat: no-repeat;
    background-position: right center;
    padding-left: 10px;
}
Maybe you can add your own version. My php skill is very limited.

Basically idea is allow users to add special style if/when first level menu has "child" or "children".
Please look attach pictures for example.

If you propose a better solution, I am happy to hear. 8)
I did not want to create a new extension for this, because it is unnecessary and will confuse users but if Elxis Team requests I should, I do not mind making one.
Anyway, elxis built in mod_menu is already very good.