[Addon] Modular Category Page for osC 2.3.4 bootstrap

[auzStar]

Support thread for the "Modular Category Page for osC 2.3.4 bootstrap" add-on.

 

Report problems here.

 

Feedback and comments appreciated.

 

Download link:

http://addons.oscommerce.com/info/9448

 

 

This add-on modularises "top level/nested" category pages by replacing current content with separate modules.
Use it to replace the current "top level/nested" category content so as to enable easy install of future category modules, that either have enhancements to current category content or to add modules with new features. It works similar to kymation's "Modular Front Page Module".

 

Modules are installed as new separate modules for each section of content that normally appears in "top level/nested" category pages.
It includes Category Name, Message Stack, Category Description, Category Images and New Products as well as Upcoming Products (new) where the content displayed is targeted to that particular category and its subcategories.

 

NOTE: "top level/nested" categories are categories that contain no products themselves but have sub-categories with products, and the "Sub-Categories" and the "New Products" (for the sub-categories) currently appear. If a "top level" category itself contains products (with or without sub-categories), then the contents of these modules will not appear. This is currently standard osCommerce behaviour of the existing category pages. This separate add-on "Category New Products Carousel (bootstrap)" http://addons.oscommerce.com/info/9445 can display on all category pages. Future versions of other modules may also do this.

 

FYI: The content modules in this add-on use this folder structure "modules/content/category".

Edited February 25, 2016 by auzStar

[greasemonkey]

@@auzStar gonna try this today.... Does require the modular front page addon?

[greasemonkey]

@@auzStar just testing.... looks very nice.

 

Just a small addition - if you want to improve from the core...

 

Add equal-height class to the cm_category_categories_images.php template.

        <div class="text-center equal-height">

Also, since you are at it.... Add an index module to the package display main cat image tiles on index (like what Jim did in the modular front page) or here is one I did....  (sorry.... can't seem to attach a zip anymore....). If not I will upload this mod separately.... Let me know.

<?php
/*
  $Id$

  osCommerce, Open Source E-Commerce Solutions
  http://www.oscommerce.com

  Copyright (c) 2014 osCommerce

  Released under the GNU General Public License
*/

  class cm_i_main_cats {
    var $code;
    var $group;
    var $title;
    var $description;
    var $sort_order;
    var $enabled = false;

    function cm_i_main_cats() {
      $this->code = get_class($this);
      $this->group = basename(dirname(__FILE__));

      $this->title = MODULE_CONTENT_MAIN_CATS_TITLE;
      $this->description = MODULE_CONTENT_MAIN_CATS_DESCRIPTION;

      if ( defined('MODULE_CONTENT_MAIN_CATS_STATUS') ) {
        $this->sort_order = MODULE_CONTENT_MAIN_CATS_SORT_ORDER;
        $this->enabled = (MODULE_CONTENT_MAIN_CATS_STATUS == 'True');
      }
    }

    function execute() {
      global $oscTemplate, $languages_id;
      
      $content_width = MODULE_CONTENT_MAIN_CATS_CONTENT_WIDTH;
	  
	
        ob_start();
		
		echo '<div class="col-sm-' . $content_width . '">';
		echo '<a href="' . tep_href_link(FILENAME_DEFAULT) . '">' . (MODULE_CONTENT_MAIN_CATS_HEADING). '</a></div>';
		
      $categories_query = tep_db_query("select c.categories_id, cd.categories_name, c.categories_image, c.parent_id from " . TABLE_CATEGORIES . " c, " . TABLE_CATEGORIES_DESCRIPTION . " cd where c.parent_id = '" . (int)$current_category_id . "' and c.categories_id = cd.categories_id and cd.language_id = '" . (int)$languages_id . "' order by sort_order, cd.categories_name");

	   while ($categories = tep_db_fetch_array($categories_query)) { 
        $cPath_new = tep_get_path($categories['categories_id']);	
		
          include(DIR_WS_MODULES . 'content/' . $this->group . '/templates/main_cats.php');

	  }		  
        
        $template = ob_get_clean();
        
        $oscTemplate->addContent($template, $this->group);

	}
	
    function isEnabled() {
      return $this->enabled;
    }

    function check() {
      return defined('MODULE_CONTENT_MAIN_CATS_STATUS');
    }

    function install() {
      tep_db_query("insert into configuration (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Enable New Products Module', 'MODULE_CONTENT_MAIN_CATS_STATUS', 'True', 'Do you want to enable this module?', '6', '1', 'tep_cfg_select_option(array(\'True\', \'False\'), ', now())");
      tep_db_query("insert into configuration (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, set_function, date_added) values ('Content Width', 'MODULE_CONTENT_MAIN_CATS_CONTENT_WIDTH', '12', 'What width container should the content be shown in? (12 = full width, 6 = half width).', '6', '1', 'tep_cfg_select_option(array(\'12\', \'11\', \'10\', \'9\', \'8\', \'7\', \'6\', \'5\', \'4\', \'3\', \'2\', \'1\'), ', now())");
      tep_db_query("insert into configuration (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) values ('Sort Order', 'MODULE_CONTENT_MAIN_CATS_SORT_ORDER', '0', 'Sort order of display. Lowest is displayed first.', '6', '4', now())");
    }

    function remove() {
      tep_db_query("delete from configuration where configuration_key in ('" . implode("', '", $this->keys()) . "')");
    }

    function keys() {
      return array('MODULE_CONTENT_MAIN_CATS_STATUS', 'MODULE_CONTENT_MAIN_CATS_CONTENT_WIDTH', 'MODULE_CONTENT_MAIN_CATS_SORT_ORDER');
    }
  }
?>

<div class="col-sm-6 col-md-4">
  <div class="thumbnail equal-height">
    <?php echo '<a href="' . tep_href_link(FILENAME_DEFAULT, $cPath_new) . '">' . tep_image(DIR_WS_IMAGES . $categories['categories_image'], $categories['categories_name'], SUBCATEGORY_IMAGE_WIDTH, SUBCATEGORY_IMAGE_HEIGHT) . '</a>';?>
  </div>
	<div class="caption text-center">
	<?php echo '<h5><a href="' . tep_href_link(FILENAME_DEFAULT, $cPath_new) . '">' . $categories['categories_name'] . '</a></h5>'; ?>
    </div>

</div>

<?php
  define('MODULE_CONTENT_MAIN_CATS_TITLE', 'Main Categories Module');
  define('MODULE_CONTENT_MAIN_CATS_DESCRIPTION', 'Shows the Main Categories thumbnails module on the index page.');
  define('MODULE_CONTENT_MAIN_CATS_HEADING', '<div class="panel panel-default"><div class="panel-heading">Categories</div></div>');
  define('MODULE_CONTENT_MAIN_CATS_BANNER_TEXT', 'Categories');

Edited February 25, 2016 by greasemonkey

[greasemonkey]

@@auzStar sorry last reply.... it looks like the new_products query is not pulling correctly.

      $new_products_query = $this->get_data();

I presume because I'm using SPPC.... ???

[auzStar]

@@greasemonkey

 

Hi Scott,

 

@@auzStar gonna try this today.... Does require the modular front page addon?

No it doesn't. This is separate and just for the main category pages.

 

 

@@auzStar just testing.... looks very nice.

 

Just a small addition - if you want to improve from the core...

 

Add equal-height class to the cm_category_categories_images.php template.

        <div class="text-center equal-height">

Also, since you are at it.... Add an index module to the package display main cat image tiles on index (like what Jim did in the modular front page) or here is one I did....  (sorry.... can't seem to attach a zip anymore....). If not I will upload this mod separately.... Let me know.

 

I see what you mean with the equal-height (wasn't in the stock code). Just tested and it seems to work better on the parent div "<div class="col-xs-6 col-sm-4 equal-height">" i.e. puts the correct amount of spacing between the text and the image below it, otherwise too close.

 

The current category images in this module just uses the code that I ripped out of the stock index.php file, just to get this module started. That was the idea, to enable easy modifications to the category pages by using modules, like Jim's Front Page Modules. Any one is welcome to create separate add-on modules, so people can swap in/out which ever modules they prefer to use. So you're quite welcome to create an improved category images module like Jim's. It all helps. I thought about doing that originally but just wanted to get things started with the standard stuff first. :)

 

To enable swap in/out for this module you'd need to use this folder structure "/modules/content/category/", and just need to have this code "echo $oscTemplate->getContent('category');" in the index.php file. Just make sure modules filenames and KEYS are different.

 

@@auzStar sorry last reply.... it looks like the new_products query is not pulling correctly.

      $new_products_query = $this->get_data();

I presume because I'm using SPPC.... ???

Don't know about that one, without seeing the code for SPPC. Was there any changes made to your original New Products Module code for it to work with SPPC?

 

cheers

Edited February 26, 2016 by auzStar

[auzStar]

Just thought I'd mention 2 additional modules designed to work with this add-on:
 
Category New Products Carousel for osC 2.3.4 bootstrap
Category Popular Products Carousel for osC 2.3.4 bootstrap

[SpicyGirl]

Hola chicos,

 

 

is it correct that this addon will not work if you have front page installed?

Becose 1 of the of the 2 code need to be changed is already changed by FP?

 

thanks for advice

[♥bruyndoncx]

Hola chicos,

 

 

is it correct that this addon will not work if you have front page installed?

Becose 1 of the of the 2 code need to be changed is already changed by FP?

 

thanks for advice

No it should, as it was recently started by these nice gents as I shared some inspiration from elsewhere

about home pages and top level category pages.

[auzStar]

Hola chicos,

 

 

is it correct that this addon will not work if you have front page installed?

Becose 1 of the of the 2 code need to be changed is already changed by FP?

 

thanks for advice

 

Hi,

 

No that is not correct. This add-on will work if you if have Front Page installed. Just don't put the code where the Front Page code is. Even if you do put the code there it will still work since the individual modules will only show up where they're supposed to, and some of them also can be selected (in the options in admin) to which pages you can show them on.

 

This "Modular Category Page" add-on has modules that are designed only to show up in the "top level/nested" category pages to replace the current "top level/nested" category content. Additional modules mentioned in the post further above can display on Front Page and on the category pages. It all depends on where you put the code and then what pages you select in admin. This information is in the installation instructions.

 

cheers

Edited March 14, 2016 by auzStar

[SpicyGirl]

so if I have this :

 

// ------------ Modular Category Page - start modifications

?>

 

<div class="row">

 

<?php

    echo $oscTemplate->getContent('category');

?>

 

</div>

 

<?php

// ------------ Modular Category Page - end modifications

 

only once in the index.php it would work?

[auzStar]

If you only have this "Modular Category Page" add-on (and not the other add-on modules mentioned further above), then yes only once in the location mentioned in the instructions.

 

cheers

[SpicyGirl]

It's true, it works.

 

gracias

[auzStar]

New version (v1.1) has been added to the add-on:

http://addons.oscomm...9448/#tabs-hist

 

------------------------------------------------------------------------------

CHANGES:

 

Included in instructions is to check that you have the latest code (necessary for correct operation of this add-on) inside "catalog\includes\classes\currencies.php", same as latest EDGE.

Corrected the names of the template files to be consistent with osCommerce naming standards for template files.

Brought module up-to-date with latest osCommerce BS EDGE coding standards i.e. microdata, replace deprecated $HTTP_* vars with $_*, hardcode DIR_WS_* file paths and compatibility with PHP7.

Other improvements/corrections.

 

------------------------------------------------------------------------------

 

cheers

[current]

Hi, am I missing something here... I have to keep the folder structure intact, but how can I install modules if I do not see the content link in Modules (admin panel)? Should I install something else first?  I normally install modules under header tags.Thanks everyone.
 

Go to "admin->modules->content" then:

 

-> "Install Module" -> "Category Name"

-> "Install Module" -> "Category Messages"

-> "Install Module" -> "Category Description"

-> "Install Module" -> "Category Sub-categories Listing"

-> "Install Module" -> "Category New Products"

-> "Install Module" -> "Category Upcoming Products"

[auzStar]

@@current

 

These are installed under "Modules->Content" not under "Modules->Header Tags".

 

When you click the "Install Module" button you should see the modules to install, one at a time.

 

Anyway, if you're using a more recent version of "osC 2.3.4 bootstrap/EDGE" there is no need to use this add-on since these are already built-in now ("index_nested" modules). This add-on was created prior to these being built-in, but if you're using earlier versions of EDGE (or Gold) then you can use this add-on.

 

cheers

[current]

@@auzStar

 

Thank you for your response. However I do not have this option as there is not link that says "content".
It almost looks like I have to upgrade the admin panel first before I can see that actual "content" link you are referring to.

 

Is this correct.

Thank so much.

Edited February 14, 2017 by current

[auzStar]

@@current

@@auzStar

 

Thank you for your response. However I do not have this option as there is not link that says "content".
It almost looks like I have to upgrade the admin panel first before I can see that actual "content" link you are referring to.

 

Is this correct.

Thank so much.

 

What version of osCommerce are you using? I'm sure some older versions of osCommerce (before v2.3.4) don't have a "Modules->Content" option.

 

This add-on is only for osCommerce version 2.3.4 Bootstrap/Responsive version, as stated in the add-on title.

 

cheers

 

 

[mcmannehan]

Your add-on runs great It runs on PHP7.1.1 and Mysql 5.7.

I did change some code to put an overlay image to the product images.

Edited February 18, 2017 by burt
remove external link

[♥JcMagpie]

Just installed this and getting this error when clicking on content in admin! What have I done wrong?

 

Parse error: syntax error, unexpected T_CONST in /home/justcook/public_html/includes/languages/english/modules/content/category/cm_category_new_products.php on line 13

[auzStar]

14 hours ago, justcatering said:

Just installed this and getting this error when clicking on content in admin! What have I done wrong?

 

Parse error: syntax error, unexpected T_CONST in /home/justcook/public_html/includes/languages/english/modules/content/category/cm_category_new_products.php on line 13

@justcatering

Hi, not sure why you would be getting this error but try changing the language file constants, for example:

change

const MODULE_CONTENT_CATEGORY_NEW_PRODUCTS_TITLE       = 'Category New Products';

to

  define('MODULE_CONTENT_CATEGORY_NEW_PRODUCTS_TITLE', 'Category New Products');

You need to do this for all lines beginning with "const" and any other module language file in the package you  use.

See if this helps.

cheers

[♥JcMagpie]

Ok changed all the files as suggested in the module language file and error was removed. However not all modules appeared in the admin side ( category image missing) and even those that did none actually worked! Would install but had no effect on website?

any ideas?

[auzStar]

18 hours ago, justcatering said:

Ok changed all the files as suggested in the module language file and error was removed. However not all modules appeared in the admin side ( category image missing) and even those that did none actually worked! Would install but had no effect on website?

any ideas?

@justcatering

Hi, firstly I hope your not using this on recent version of BS edge. As per install doco below:

Quote

PREREQUISITES:

osCommerce versions 2.3.4 bootstrap (GOLD and earlier versions of EDGE).
NOTE: It is not recommended to use this add-on if you have a more recent version of osCommerce BS EDGE that now includes modular index and modular category pages (i.e. index and index_nested modules). This add-on is only recommended to be used on earlier versions osCommerce BS that have no form of built-in modular index page and where you may also be using the "Modular Front Page" add-on by kymation. This add-on will modularize the category page (i.e. "top level/nested" category pages) by replacing current content with separate modules.

If you are using the correct osC BS version then ensure you have inserted the code below in the correct locations inside the index.php file as per the install doco, and double check that you have followed the install documentation correctly.

<!------------ Modular Category Page - start modifications---->
<div class="row">
  <?php echo $oscTemplate->getContent('category'); ?>
</div>
<!------------ Modular Category Page - end modifications------>

This add-on is known to work and has been tested on a clean install of osC 234BS GOLD and earlier versions of EDGE.

cheers

[♥JcMagpie]

As far as I can tell (will check again ) have used latest Edge from github and both addons down loaded from the links in Burts thread, so shoud be the right ones. Will just have to keep checking and see if I have made a mistake.

 

[auzStar]

@justcatering

As explained in my previous post, you don't use this add-on with latest BS EDGE. It was designed for earlier versions osC BS EDGE and the GOLD version, which didn't have modularised category pages. Recent versions of EDGE already has modularised category pages. It's mentioned in the install documentation.

[♥JcMagpie]

may be I have got my self confused! But when I installed the Edge on its own it did not have the option to shows catogorys on the front page!

that is why I added front page and catogorys on front page modules. My be I had better just start over and see what happens.

been a bit distracted as one of my other websites has been hacked over night and hosting company has susspended it!!! but will start another thread for help with that. Thanks.