Прайслист

Материал из Umicms
Перейти к:навигация, поиск

Актуально для версии 2.9.1

Общее описание

%emarket getPriceList()% — выводит прайслист товаров из указанного раздела

Параметры: getPriceList([$asFile = 'yes', $parent= , $childs = 10, $expire = 0, $fileName = , $template = 'default'])

$asFile

  Определяем режим работы макроса, если указано 'yes', то выводит прайслист на страниц, если 'no', то создаем csv с прайслистом и выводит путь до него на страницу,
  значение по-умолчанию - 'yes'. Сsv файл расположен по пути /files/price_as_file/, имя определяется параметром $fileName.

$parent

  id или путь до раздела, в котором будут искаться товары, если не указан, то макрос возьмет id страницы, на которой вызван.

$childs

  Глубина поиска объектов списка (во вложенных подразделах). По умолчанию в десятки уровнях вложенности.

$expire

  Время хранения кеша в секундах, если не указан, то равен нулю. Кеш храниться в директории /sys-temp/price_as_page/.

$fileName

  Используется только при значении первого параметра $asFile = 'yes', определяет имя csv файла, если ввести русские символы, то они транслитирируются, если
  параметр не указан, то берется AltName страницы, на которой он вызван.

$template

  Шаблон, по которому выводится результат макроса, используется только при значении первого параметра $asFile = 'no'. В XSLT-шаблонизаторе игнорируется.

Для применения этого макроса скопируйте содержимое листинга макроса и служебных методов в файл /classes/modules/custom.php или в __custom.php какого-либо модуля, если воспользуетесь вторым вариантом, то не забудьте указать имя метода в permissions.custom.php.

Листинг макроса и служебных методов

		//возвращаем прайслист
		public function getPriceList($asFile = '', $parent = '', $childs = 10, $expire = 0, $fileName = '', $template = 'default'){
	                //если первый параметр не задан, то он будет равен 'yes'
			if(!$asFile) $asFile = 'yes';
                        //если второй параметр не задан, то берем id текущей страницы
			if(!$parent){
			$parentId = cmsController::getInstance()->getCurrentElementId(); 
			}else{
                                //если задан, то анализируем путь до файла
				$parentId = def_module::analyzeRequiredPath($parent);
                                //если parentId не получен, то кидаем исключение
				if($parentId === false && $parent != KEYWORD_GRAB_ALL) {
					throw new publicException('<b>В макросе emarket getPriceList() необходимо указать корректное значение второго параметра $parent<b/>');
				}
			}
                        //если третий параметр не задан, то он будет равен десяти
			if(!$childs) $childs = 10;
                        //если третий параметр не число, то кидаем исключение
			if(!is_numeric($childs)){
				throw new publicException('<b>В макросе emarket getPriceList() необходимо указать корректное значение третьего параметра $childs<b/>');
			}
                        //если четвертый параметр не задан, то он будет равен нулю
			if(!$expire) $expire = 0;
                        //если значение четвертого параметра не число, кидаем исключене
			if(!is_numeric($expire)){
				throw new publicException('<b>В макросе emarket getPriceList() необходимо указать корректное значение четвертого параметра $expire<b/>');
			}
                        //получаем altname страницы, указанной во втором параметре
			$hierarchy = umiHierarchy::getInstance();
			$page = $hierarchy->getElement($parentId); 
			$altName = $page->getAltName();
                        //ветвление относительно первого параметра
			switch ($asFile) {
                                //если $asFile = 'no 'возвращаем результат макроса в виде итемов с информацией о товарах
				case 'no':
                                        //если xslt - кешируем результат парсинга
					$isXslt = def_module::isXSLTResultMode();
					if ($isXslt){
						$path = self::getPath('/sys-temp/price_as_page/', $altName .'-cashed-as-array.txt');
						if(is_file($path)) $mtime = filemtime($path);
                                                //получаем и возвращаем результат, сохраняем в кеш результат
						if(!is_file($path) || time() > ($mtime + $expire)){
							$pages = self::getQuery($parentId, $childs);
							$result = self::getResult($pages, $template);
							file_put_contents($path, serialize($result));
							unset($path, $mtime, $pages);
							return $result;
						}else{
                                                //возвращаем результат из кеша
							return unserialize(file_get_contents($path));
						}
					}else{
	                                //если tpl - кешируем результат выборки
						$path = self::getPath('/sys-temp/price_as_page/', $altName .'-cashed-as-query.txt');
						if(is_file($path)) $mtime = filemtime($path);
                                                //получаем и возвращаем результат, сохраняем в кеш выборку
						if(!is_file($path) || time() > ($mtime + $expire)){
							$pages = self::getQuery($parentId, $childs);
							file_put_contents($path, serialize($pages));
							$result = self::getResult($pages, $template);
							unset($path, $mtime, $pages);
							return $result;
						}else{
                                                //берем выборку из кеша, получаем и возвращаем результат
							return self::getResult(unserialize(file_get_contents($path)), $template);
						}
					}
					break;
                                //если $asFile = 'yes' возвращаем результат макроса в виде ссылки на файл с прайслистом
				case 'yes':
                                        //если имя файла не задано, оно будет равно altName страницы-родителя
					if(!$fileName){
						$correctFileName = $altName; 
                                        //если имя файла есть, то прогоняем через транлит, на случай ввода русского названия файла
					}else{
						$correctFileName = translit::convert($fileName);
					}
					$path = self::getPath('/files/price_as_file/', $correctFileName . '.csv');
					if(is_file($path)) $mtime = filemtime($path);
                                        //получаем результат, сохраняем его в csv файл и возвращаем ссылку	
					if(!is_file($path) || time() > ($mtime + $expire)){
						$open = fopen($path, 'w+');
                                                //задаем 'шапку' csv файла
						$hat = array(
							'artikul' => 'Артикул',
							'name' => 'Наименование',
							'price' => 'Цена'
						);
						fputcsv($open, $hat, ';');
						$pages = self::getQuery($parentId, $childs);
                                                //наполняем файл данными, если вовремя наполнения будет ошибка, то на сайте появится информация о ней
						try {
							foreach($pages as $page){
								$lines = array();
								$lines['artikul'] = $page->getValue('artikul');
								$lines['name'] = $page->getName();
								$lines['price'] = $page->getValue('price');
								fputcsv($open, $lines, ';');
							}
						}catch (Exception $e) {
							return '<b>Файл с прайсом не смог сгенерироваться из-за ошибки:</b>'.$e->getMessage();
						}
						unset($pages, $page, $lines, $price, $name);
						fclose($open);
						return '/files/price_as_file/'.$correctFileName.'.csv';
					}else{
                                        //возвращаем ссылку
						return '/files/price_as_file/'.$correctFileName.'.csv';
					}
					break;
                                //если $asFile != 'yes' и != 'no' кидаем исключение
				default:
					throw new publicException('<b>В макросе emarket getPriceList() необходимо указать корректное значение первого параметра $asFile</b>');
			}
		}
		//возвращаем путь до файла
		private function getPath($dirName, $file){
			$folder = CURRENT_WORKING_DIR . $dirName;  
			$path = $folder . $file;
			if(!is_dir($folder)) mkdir($folder, 0777, true);	
			return $path;
		}
		//возвращаем результат выборки
		private function getQuery($parentId, $childs){
			$pages = new selector('pages');
			$pages->types('object-type')->name('catalog', 'object');
			$pages->where('hierarchy')->page($parentId)->childs($childs);
			$pages->limit(0,2000);
			return $pages;
		}
		//возвращаем результат парсинга шаблонов
		private function getResult($pages, $template){
			if(!@$template) $template = 'default';
			list($itemsTemplate, $itemTemplate) = def_module::loadTemplates("emarket/{$template}", "items", "item");	
			$item = array();
			$items = array();
			foreach($pages as $page){
				$item['attribute:id'] = $page->id;
				$item['attribute:link'] = $page->link;
				$item['attribute:price'] = $page->getValue('price');
				$item['attribute:artikul'] = $page->getValue('artikul');
				$item['attribute:name'] =  $page->getName();
				$items[] = def_module::parseTemplate($itemTemplate, $item);
			}
			$items = array('subnodes:items' => $items);
			$result = def_module::parseTemplate($itemsTemplate, $items);
			return $result;
		}

Применение в tpl

Применение в xslt

Полезные ссылки