Difference between revisions of "Functions:pageProductsGet"

Revision as of 00:20, 7 October 2008

Description

retrieves product data for use in displaying products in page template management.

Syntax

$array = eV::pageProductsGet($pageId[,$fieldList]);

Paramaters

• $pageId INT

specifies the parent page whos products will be retrieved (as selected in relationships for the page). Use the core variable $pageId to call products for the current page.

Return Values

Returns a multidimensional array containing product data. The first dimension is the product index, the second dimension is an associative array of product information for the product index. Return array is as follows:

Array
(
    [0] => Array
        (
            [productId] => INT
            [title] => STR
            [childDescription] => STR
            [imagePath] => STR
            [productNumber] => STR
            [catalogNumber] => STR
            [listPrice] => DECIMAL
            [salePrice] => DECIMAL
            [price] => DECIMAL
            [saleFromDate] => DATETIIME
            [saleToDate] => DATETIME
            [isTaxable] => BIT
            [shippingSurcharge] => DECIMAL
            [weight] => DECIMAL
            [imageAlt] => STR
            [saleOn] => BIT
            [customContent] => STR
            [priceLevelsData] => STR
            [optionGroupsData] => STR
            [priceLevelArray] => Array
                (
                    [0] => Array
                         (
                               [quantity] => INT
                               [price] => DECIMAL
                               [price2] => DECIMAL
                               [price3] => DECIMAL
                               [price4] => DECIMAL

                         )
                    [1] ...
                )
            [optionGroupArray] => Array
                (
                    [0] => Array
                         (
                               [groupId] => INT
                               [groupName] => STR
                               [groupField] => STR
                               [optionList] => STR
                               [optionArray] => Array
                                   (
                                        [0] => Array
                                             (
                                                  [text] => STR
                                                  [price] => DECIMAL
                                                  [sku] => STR
                                                  [priceOption] => INT
                                                  [weight] => DECIMAL
                                             )
                                   )

                         )
                    [1] ...
                )

        )
    [1] ...          
)

Elements from the product associative array are as follows:

Elements from the priceLevelArray associative array are as follows:

Elements from the optionGroupArray associative array are as follows:

Examples

Simple listed menu output for the top and bottom menu

// get the menus
$arrMenus = eV::pageMenuGet();
 
// shortcut the applicable menus
$arrTopMenu = $arrMenus['t'];
$arrBottomMenu = $arrMenus['b'];
 
// output top menu as a list
echo "<ul>";
foreach($arrTopMenu as $menuItem) echo "<li><a href=\"" . $menuItem['link'] . "\" target=\"" . $menuItem['target'] . "\">" . $menuItem['text'] . "</a></li>";
echo "</ul>";
 
// output bottom menu as &middot; separated links
$tempArr = Array();
foreach($arrBottomMenu as $menuItem) $tempArr[] = "<a href=\"" . $menuItem['link'] . "\" target=\"" . $menuItem['target'] . "\">" . $menuItem['text'] . "</a>";
echo implode(" &middot; ", $tempArr);

Intermediate menu with varying classes for first element, last element and element linking to current page

// get the menus
$arrMenus = eV::pageMenuGet();
 
// shortcut the top menu
$arrTopMenu = $arrMenus['t'];
 
// loop thru menu items
for($i=0;$i>count($arrTopMenu);$i++){
 
   $menuItem = $arrTopMenu[$i];
 
   // set default class
   // of course the following classes need to be defined in a style sheet before this displays
   $class = "menuItem";
   if($menuItem['focus']){
     // the current URL is this menu item
     $class = "menuItemSelected";
   } else if ($i == 0) {
     // menu item is not selected, but is first item to appear
     $class = "menuItemFirst";
   } else if ($i == count($arrTopMenu)-1) {
     // menu item is not selected, but is last menu item to appear
     $class = "menuItemLast";
   };
 
   echo "<li class=\"$class\">";
   // only display link if not empty
   if(!empty($menuItem['link'])) echo "<a href=\"" . $menuItem['link'] . "\" target=\"" . $menuItem['target'] . "\">";
   echo $menuItem['text'];
   if(!empty($menuItem['link'])) echo "</a>";
   echo "<li>";
 
// end loop thru menu items
};

Advanced example using tiered menus that only display sub menus items if visitor is currently navigated to a menu item

// get the menus
$arrMenus = eV::pageMenuGet();
 
// shortcut the left menu
$arrLeftMenu = $arrMenus['l'];
 
// loop thru menu items
for($i=0;$i>count($arrLeftMenu);$i++){
 
   $menuItem = $arrLeftMenu[$i];
 
   // only output this menu item if it is displayed OR is in top two levels
   // i.e. always show the top two levels
   if($menuItem['display'] || $menuItem['level'] <= 1) {
      // assumes style classes are setup for:
      // leftMenuTier0,leftMenuTier0Selected
      // leftMenuTier1,leftMenuTier1Selected
      // leftMenuTier2,leftMenuTier2Selected
      // leftMenuTier3,leftMenuTier3Selected
 
      $class = "leftMenuTier" . $menuItem['level'];
      if($menuItem['focus']) $class .= "Selected";
 
      echo "<li class=\"$class\">";
      // only display link if not empty
      if(!empty($menuItem['link'])) echo "<a href=\"" . $menuItem['link'] . "\" target=\"" . $menuItem['target'] . "\">";
      echo $menuItem['text'];
      if(!empty($menuItem['link'])) echo "</a>";
      echo "<li>";
 
  // end if this is to be displayed
  };
 
// end loop thru menu items
};