Documentation

Price
in package

Класс для работы с Прайсом

Class Price

Tags
author

Vladislav Andreev v@salesman.pro

version
1.0

(06/09/2019)

Table of Contents

TYPES  = [0 => 'Товар', 1 => 'Услуга', 2 => 'Материал']
$db  : mixed
Различные параметры, в основном из GLOBALS
$fpath  : mixed
Различные параметры, в основном из GLOBALS
$identity  : mixed
Различные параметры, в основном из GLOBALS
$iduser1  : mixed
Различные параметры, в основном из GLOBALS
$ivc  : mixed
Различные параметры, в основном из GLOBALS
$opts  : mixed
Различные параметры, в основном из GLOBALS
$params  : array<string|int, mixed>
Передача различных параметров
$skey  : mixed
Различные параметры, в основном из GLOBALS
$sqlname  : mixed
Различные параметры, в основном из GLOBALS
$tmzone  : mixed
Различные параметры, в основном из GLOBALS
__construct()  : mixed
Akt constructor.
addCategoryFromTitle()  : int
Добавление новой категории по названию
delete()  : array<string|int, mixed>
Удаление позиции прайса
deleteCategory()  : string
Удаление категории
edit()  : array<string|int, mixed>
Добавление/Редактирование позиции прайса
editCategory()  : array<string|int, mixed>
Добавление/Редактирование категорий прайса
fields()  : array<string|int, mixed>
Получение имен активных полей прайса
getCatalog()  : array<string|int, mixed>
Рекрсивно возвращает массив со всеми категориями и подкатегориями прайс-листа.
getCatalogCounts()  : array<string|int, mixed>
Обработка готового массива каталогов, полученного в Price::getCatalog(); Происходит расчет количества позиций в каталоге с учетом вложенных категорий
getCatalogHtml()  : string
Рекурсивно возвращает массив со всеми категориями и подкатегориями прайс-листа.
getCatalogTree()  : array<string|int, mixed>
Возвращает массив со всеми вложенными категориями
getPriceCatalog()  : array<string|int, mixed>
Возвращает структуру каталога, но без вложения подкаталогов в основной каталог
getPriceList()  : array<string|int, mixed>
info()  : array<string|int, mixed>
Данные по позиции прайса
infoCategory()  : array<string|int, mixed>
Данные категории
listCategory()  : array<string|int, mixed>
Возвращает массив со списком категорий
parentCatalog()  : int
Поиск главной категории (нулевого уровня)
simplifyCatalog()  : array<string|int, mixed>
Возвращает массив, в котором - category - линейный массив категорий (все подкатегории вынесены в основной массив) - empty - массив пустых категорий (без позиций прайса)

Constants

TYPES

public false|string TYPES = [0 => 'Товар', 1 => 'Услуга', 2 => 'Материал']

Properties

$db

Различные параметры, в основном из GLOBALS

public mixed $db

$fpath

Различные параметры, в основном из GLOBALS

public mixed $fpath

$identity

Различные параметры, в основном из GLOBALS

public mixed $identity

$iduser1

Различные параметры, в основном из GLOBALS

public mixed $iduser1

$ivc

Различные параметры, в основном из GLOBALS

public mixed $ivc

$opts

Различные параметры, в основном из GLOBALS

public mixed $opts

$params

Передача различных параметров

public array<string|int, mixed> $params = []

$skey

Различные параметры, в основном из GLOBALS

public mixed $skey

$sqlname

Различные параметры, в основном из GLOBALS

public mixed $sqlname

$tmzone

Различные параметры, в основном из GLOBALS

public mixed $tmzone

Methods

__construct()

Akt constructor.

public __construct() : mixed
Return values
mixed —

addCategoryFromTitle()

Добавление новой категории по названию

public static addCategoryFromTitle(string $title, int $sub) : int
Parameters
$title : string
  • название категории
$sub : int
  • id родительской категории
Return values
int —
  • id добавленной записи

delete()

Удаление позиции прайса

public static delete( $id) : array<string|int, mixed>
Parameters
$id :
  • id позиции прайса
Return values
array<string|int, mixed> —
  • массив с параметрами good result - result = Success - text =Готово - data = id

error result - result = Error - text = Запись не найдена - data id

$Price = \Salesman\Price::delete($id);

deleteCategory()

Удаление категории

public static deleteCategory( $id) : string

Если категория содержит подкатегории, то они будут перемещены вверх

Parameters
$id :
  • id категории
Return values
string —

$mes = Запись удалена. Перемещено - ".$good." позиций

edit()

Добавление/Редактирование позиции прайса

public edit( $id[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$id :
  • id позиции
$params : array<string|int, mixed> = []
  • массив с параметрами
  • artikul - артикул
  • title - название
  • descr - описание
  • price_in - закупочная цена
  • price_1 - розница
  • price_2 - уровень цены 1
  • price_3 - уровень цены 2
  • price_4 - уровень цены 3
  • price_5 - уровень цены 4
  • edizm - единица измерения
  • nds - размер ндс
  • pr_cat - категория прайса
Return values
array<string|int, mixed> —

good result - result = Success - text = Позиция добавлена/изменена

error result - result = Error - text = Ошибка добавления / Позиция не найдена

$Price = \Salesman\Price::edit($id,$params);

editCategory()

Добавление/Редактирование категорий прайса

public editCategory( $id[, array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$id :
  • id категории прайса(для редактирования)
$params : array<string|int, mixed> = []
  • массив с параметрами
  • title - название
  • sub - id родительской категории
Return values
array<string|int, mixed> —

good result - result = Success - text = Добавлено/обновлено - data = id

error result - result= Error - text = Позиция не найдена - data = id

fields()

Получение имен активных полей прайса

public static fields() : array<string|int, mixed>
Return values
array<string|int, mixed> —

getCatalog()

Рекрсивно возвращает массив со всеми категориями и подкатегориями прайс-листа.

public static getCatalog(int $id, int $level) : array<string|int, mixed>

Можно задать стартовый id категории. Тогда будет возвращена только эта ветка

Parameters
$id : int
$level : int
Return values
array<string|int, mixed> —

getCatalogCounts()

Обработка готового массива каталогов, полученного в Price::getCatalog(); Происходит расчет количества позиций в каталоге с учетом вложенных категорий

public static getCatalogCounts( $catalog) : array<string|int, mixed>
Parameters
$catalog :
Return values
array<string|int, mixed> —

getCatalogHtml()

Рекурсивно возвращает массив со всеми категориями и подкатегориями прайс-листа.

public static getCatalogHtml(int $id[, string $template = '<li data-id="{{id}}"><a href="javascript:void(0)" title="{{title}}" class="category" data-id="{{id}}">{{title}}</a>{{sub}}</li>' ][, string $block = '<ul>{{html}}</ul>' ]) : string

Можно задать стартовый id категории. Тогда будет возвращена только эта ветка. Оформление задается с помощью параметров $template и $block. По умолчанию: $block =

    {{html}}
- обертка блока категорий $template = <li data-id="{{id}}>{{title}}{{sub}} - шаблон списка где {{sub}} - вставка подкатегорий (применяется основной шаблон)

Parameters
$id : int
$template : string = '<li data-id="{{id}}"><a href="javascript:void(0)" title="{{title}}" class="category" data-id="{{id}}">{{title}}</a>{{sub}}</li>'
$block : string = '<ul>{{html}}</ul>'
Return values
string —

getCatalogTree()

Возвращает массив со всеми вложенными категориями

public static getCatalogTree(int $id) : array<string|int, mixed>
Parameters
$id : int
Return values
array<string|int, mixed> —

getPriceCatalog()

Возвращает структуру каталога, но без вложения подкаталогов в основной каталог

public static getPriceCatalog(int $id, int $level[, array<string|int, mixed> $ures = [] ]) : array<string|int, mixed>
Parameters
$id : int
$level : int
$ures : array<string|int, mixed> = []
Return values
array<string|int, mixed> —

getPriceList()

public static getPriceList([array<string|int, mixed> $params = [] ]) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed> = []
Return values
array<string|int, mixed> —

info()

Данные по позиции прайса

public static info(int $id[, string $artikul = '' ]) : array<string|int, mixed>
Parameters
$id : int
  • id прайсовой позиции
$artikul : string = ''
  • артикул позиции
Return values
array<string|int, mixed> —

good result - [result] = Success - [data] = price(array) - [prid] = id

error result - [result] = Error - [error] = Запись не найдена - [data] = id

$Price = \Salesman\Price::info($id,$artikul);

infoCategory()

Данные категории

public static infoCategory(int $id) : array<string|int, mixed>
Parameters
$id : int
Return values
array<string|int, mixed> —

listCategory()

Возвращает массив со списком категорий

public static listCategory() : array<string|int, mixed>
Return values
array<string|int, mixed> —

parentCatalog()

Поиск главной категории (нулевого уровня)

public static parentCatalog(int $id) : int
Parameters
$id : int
Return values
int —

simplifyCatalog()

Возвращает массив, в котором - category - линейный массив категорий (все подкатегории вынесены в основной массив) - empty - массив пустых категорий (без позиций прайса)

public static simplifyCatalog( $catalog) : array<string|int, mixed>
Parameters
$catalog :
Tags
example 
$catalog  = Price::getCatalog();
$xcatalog = Price::getCatalogCounts($catalog);
$simple   = Price::simplifyCatalog($xcatalog);
Return values
array<string|int, mixed> —

Search results