Class warehouse

[Строка 15]

Размещен: /shop/warehouse.class.php

Описание

Система управления сайтом HostCMS v. 5.xx

Класс модуля "warehouse".

Файл: /modules/shop/warehouse.class.php

author

Hostmake LLC

version

5.x

Свойства класса

$CacheGetAllWarehousesForShop = array()
Кэш для метода GetAllWarehousesForShop()
$CacheGetItemCountForWarehouse = array()
Кэш для метода GetItemCountForWarehouse()
$CacheGetWarehouse = array()
Кэш для метода GetWarehouse()

Константы класса

Унаследованные константы класса

Унаследованные свойства класса

Методы

boolean AcceptTransaction()
Списание с определенного склада определенное количество определенного товара
mixed CopyWarehouse()
Копирование склада
resource DeleteWarehouse()
Удаление информации о складе
resource DeleteWarehouseItem()
Удаление информации о связи товара и склада
void FillItemCountForWarehouse()
mixed GetAllItemWarehouses()
Получение всех складов, которым принадлежит товар
mixed GetAllWarehouseItems()
Получение всех товаров склада
mixed GetAllWarehousesForShop()
Получение всех складов магазина
mixed GetDefaultWarehouse()
Получение склада по умолчанию для магазина
int GetItemCountForAllWarehouses()
Получение количества определенного товара на всех складах
int GetItemCountForWarehouse()
Получение количества определенного товара на определенном складе
mixed GetWarehouse()
Получение информации о складе
mixed GetWarehouseItem()
Получение информации об остатке товара на складе, получение возможно по shop_warehouse_items_id или паре значений идентификатор склада и идентификатор товара
str GetWarehousesXml()
Формирование XML для всех складов магазина
str GetWarehouseXml()
Формирование XML для конкретного склада магазина
mixed InsertWarehouse()
Вставка/обновление склада
mixed InsertWarehouseItems()
Вставка/обновление количества товара на складе.

Унаследованные методы

Описания методов

warehouse::AcceptTransaction

AcceptTransaction( $shop_warehouse_id, $shop_items_catalog_item_id, $shop_warehouse_items_count, int $shop_shops_id );

Описание

Списание с определенного склада определенное количество определенного товара

Принимаемые параметры

$shop_shops_id

идентификатор магазина

 <?php
 $warehouse = & singleton('warehouse');
 
 $shop_warehouse_id = 1;
 $shop_items_catalog_item_id = 10;
 $shop_warehouse_items_count = 100;
 
 if($warehouse->AcceptTransaction($shop_warehouse_id, $shop_items_catalog_item_id, $shop_warehouse_items_count))
 {
     echo "Списание товара прошло успешно";
 }
 else
 {
     echo "Ошибка списания товара!";
 }
 ?>

$shop_warehouse_id

$shop_items_catalog_item_id

$shop_warehouse_items_count

Возвращает

результат выполнения операции

[ Наверх ]

warehouse::CopyWarehouse

CopyWarehouse( int $shop_warehouse_id, int $shop_shops_id );

Описание

Копирование склада

Принимаемые параметры

$shop_warehouse_id

идентификатор склада

$shop_shops_id

идентификатор магазина

 <?php
 $warehouse = & singleton('warehouse');
 
 $shop_warehouse_id = 1;
 $shop_shops_id = 10;
 
 if(($warehouse_copy_id = $warehouse->CopyWarehouse($shop_warehouse_id, $shop_shops_id)) !== false)
 {
     echo "Копирование прошло успешно, идентификатор новго склада - $warehouse_copy_id";
 }
 else
 {
     echo "Ошибка копирования склада!";
 }
 ?>

Возвращает

идентификатор нового склада, либо false

[ Наверх ]

warehouse::DeleteWarehouse

DeleteWarehouse( int $shop_warehouse_id );

Описание

Удаление информации о складе

Принимаемые параметры

$shop_warehouse_id

идентификатор склада

 <?php
 $warehouse = & singleton('warehouse');
 
 $shop_warehouse_id = 10;
 
 if($warehouse->DeleteWarehouse($shop_warehouse_id))
 {
     echo "Информация успешно удалена!";
 }
 else
 {
     echo "Ошибка удаления информации!";
 }
 ?>

[ Наверх ]

warehouse::DeleteWarehouseItem

DeleteWarehouseItem( int $shop_warehouse_items_id );

Описание

Удаление информации о связи товара и склада

Принимаемые параметры

$shop_warehouse_items_id

идентификатор связи из таблицы `shop_warehouse_items_table`

 <?php
 $warehouse = & singleton('warehouse');
 
 $shop_warehouse_items_id = 1;
 
 if($warehouse->DeleteWarehouseItem($shop_warehouse_items_id))
 {
     echo "Информация успешно удалена!";
 }
 else
 {
     echo "Ошибка удаления информации!";
 }
 ?>

[ Наверх ]

warehouse::FillItemCountForWarehouse

FillItemCountForWarehouse( $shop_items_catalog_item_id );

Принимаемые параметры

$shop_items_catalog_item_id

[ Наверх ]

warehouse::GetAllItemWarehouses

GetAllItemWarehouses( int $shop_items_catalog_item_id );

Описание

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

Принимаемые параметры

$shop_items_catalog_item_id

идентификатор товара

 <?php
 $warehouse = & singleton('warehouse');
 
 $shop_items_catalog_item_id = 101;
 
 if(($item_warehouses_item_res = $warehouse->GetAllItemWarehouses($shop_items_catalog_item_id)) !== false)
 {
     while($item_warehouses_item_row = mysql_fetch_assoc($item_warehouses_item_res))
     {
         var_dump($item_warehouses_item_row);
     }
 }
 else
 {
     echo "Данные отсутствуют";
 }
 ?>

Возвращает

resource или false

[ Наверх ]

warehouse::GetAllWarehouseItems

GetAllWarehouseItems( int $shop_warehouse_id );

Описание

Получение всех товаров склада

Принимаемые параметры

$shop_warehouse_id

идентификатор склада

 <?php
 $warehouse = & singleton('warehouse');
 
 $shop_warehouse_id = 1;
 
 if(($warehouse_item_res = $warehouse->GetAllWarehouseItems($param)) !== false)
 {
     while($warehouse_item_row = mysql_fetch_assoc($warehouse_item_res))
     {
         var_dump($warehouse_item_row);
     }
 }
 else
 {
     echo "Данные отсутствуют";
 }
 ?>

Возвращает

resource или false

[ Наверх ]

warehouse::GetAllWarehousesForShop

GetAllWarehousesForShop( int $shop_shops_id );

Описание

Получение всех складов магазина

Принимаемые параметры

$shop_shops_id

идентификатор магазина

 <?php
 $warehouse = & singleton('warehouse');
 
 $shop_shops_id = 1;
 
 if(($aWarehouses = $warehouse->GetAllWarehousesForShop($shop_shops_id)) !== false)
 {
   foreach ($aWarehouses as $shop_warehouses_row)
     {
         var_dump($shop_warehouses_row);
     }
 }
 else
 {
     echo "Данные отсутствуют";
 }
 ?>

Возвращает

массив или false

[ Наверх ]

warehouse::GetDefaultWarehouse

GetDefaultWarehouse( int $shop_shops_id );

Описание

Получение склада по умолчанию для магазина

Принимаемые параметры

$shop_shops_id

идентификатор магазина

 <?php
 $warehouse = & singleton('warehouse');
 
 $shop_shops_id = 1;
 
 if(($default_warehouse_row = $warehouse->GetDefaultWarehouse($shop_shops_id)) !== false)
 {
     var_dump($default_warehouse_row);
 }
 else
 {
     echo "Склад \"По умолчанию\" не обнаружен!";
 }
 ?>

Возвращает

массив с данными, либо false

[ Наверх ]

warehouse::GetItemCountForAllWarehouses

GetItemCountForAllWarehouses( int $shop_items_catalog_item_id );

Описание

Получение количества определенного товара на всех складах

Принимаемые параметры

$shop_items_catalog_item_id

идентификатор товара

 <?php
 $warehouse = & singleton('warehouse');
 
 $shop_items_catalog_item_id = 1;
 
 if(($item_count = $warehouse->GetItemCountForAllWarehouses($shop_items_catalog_item_id)) > 0)
 {
     echo "Количество товара на всех складах: $item_count";
 }
 else
 {
     echo "Товар отсутствует на всех складах";
 }
 ?>

Возвращает

количество товара на складах, либо 0, если товара на складах нет

[ Наверх ]

warehouse::GetItemCountForWarehouse

GetItemCountForWarehouse( int $shop_warehouse_id, int $shop_items_catalog_item_id );

Описание

Получение количества определенного товара на определенном складе

Принимаемые параметры

$shop_warehouse_id

идентификатор склада

$shop_items_catalog_item_id

идентификатор товара

 <?php
 $warehouse = & singleton('warehouse');
 
 $shop_warehouse_id = 1;
 $shop_items_catalog_item_id = 10;
 
 if(($item_count = $warehouse->GetItemCountForWarehouse($shop_warehouse_id, $shop_items_catalog_item_id)) > 0)
 {
     echo "Количество товара на складе: $item_count";
 }
 else
 {
     echo "Товар на складе отсутствует";
 }
 ?>

Возвращает

количество товара на складе, либо 0, если товара на складе нет

[ Наверх ]

warehouse::GetWarehouse

GetWarehouse( int $shop_warehouse_id );

Описание

Получение информации о складе

Принимаемые параметры

$shop_warehouse_id

идентификатор склада

 <?php
 $warehouse = & singleton('warehouse');
 
 $shop_warehouse_id = 1;
 
 if(($warehouse_row = $warehouse->GetWarehouse($shop_warehouse_id)) !== false)
 {
     var_dump($warehouse_row);
 }
 else
 {
     echo "Ошибка получения данных о складе!";
 }
 ?>

Возвращает

массив данных, либо false

[ Наверх ]

warehouse::GetWarehouseItem

GetWarehouseItem( array $param, int $shop_warehouse_id );

Описание

Получение информации об остатке товара на складе, получение возможно по shop_warehouse_items_id или паре значений идентификатор склада и идентификатор товара

Принимаемые параметры

$shop_warehouse_id

идентификатор склада

$param

массив параметров

int $param['shop_warehouse_items_id'] идентификатор связи
int $param['shop_warehouse_id'] идентификатор склада
int $param['shop_items_catalog_item_id'] идентификатор товара

 <?php
 $warehouse = & singleton('warehouse');
 
 $param = array();
 $param['shop_warehouse_items_id'] = 1;
 
 // либо, используя составной ключ, можно задать идентификаторы склада и товара
 $param['shop_warehouse_id'] = 10;
 $param['shop_items_catalog_item_id'] = 20;
 
 if(($warehouse_item_row = $warehouse->GetWarehouseItem($param)) !== false)
 {
     var_dump($warehouse_item_row);
 }
 else
 {
     echo "Ошибка получения данных об остатке!";
 }
 ?>

Возвращает

массив данных, либо false

[ Наверх ]

warehouse::GetWarehousesXml

GetWarehousesXml( int $shop_shops_id );

Описание

Формирование XML для всех складов магазина

Принимаемые параметры

$shop_shops_id

идентификатор магазина

 <?php
 $warehouse = & singleton('warehouse');
 
 $shop_shops_id = 1;
 
 if(($warehouses_xml = $warehouse->GetWarehousesXml($shop_shops_id)) != '')
 {
     echo $warehouses_xml;
 }
 else
 {
     echo "Нет XML-данных о складах!";
 }
 ?>

Возвращает

строка XML в случае успеха, либо пустая строка

[ Наверх ]

warehouse::GetWarehouseXml

GetWarehouseXml( int $shop_warehouse_id );

Описание

Формирование XML для конкретного склада магазина

Принимаемые параметры

$shop_warehouse_id

идентификатор склада

 <?php
 $warehouse = & singleton('warehouse');
 
 $shop_warehouse_id = 1;
 
 if(($warehouse_xml = $warehouse->GetWarehouseXml($shop_warehouse_id)) != '')
 {
     echo $warehouse_xml;
 }
 else
 {
     echo "Нет XML-данных о складе!";
 }
 ?>

Возвращает

строка XML в случае успеха, либо пустая строка

[ Наверх ]

warehouse::InsertWarehouse

InsertWarehouse( array $param );

Описание

Вставка/обновление склада

Принимаемые параметры

$param

массив параметров

int $param['shop_warehouse_id'] идентификатор склада (для обновления)
int $param['shop_shops_id'] идентификатор магазина
str $param['shop_warehouse_name'] наименование склада
int $param['shop_warehouse_activity'] флажок активности склада
int $param['shop_country_id'] идентификатор страны
int $param['shop_location_id'] идентификатор области
int $param['shop_city_id'] идентификатор города
int $param['shop_city_area_id'] идентификатор района
str $param['shop_warehouse_address'] адрес склада
int $param['users_id'] идентификатор пользователя центра администрирования для установки владельца записи (используется только если $param['shop_warehouse_id'] == 0 или не передан)
int $param['shop_warehouse_order'] порядок сортировки склада
int $param['shop_warehouse_default'] флаг "склад по умолчанию" (с этим параметром обязательно должен быть передан параметр $param['shop_shops_id'])

 <?php
 $warehouse = & singleton('warehouse');
 
 $param = array();
 
 $param['shop_warehouse_id'] = 1;
 $param['shop_shops_id'] = 10;
 $param['shop_warehouse_name'] = "Основной склад";
 $param['shop_warehouse_activity'] = 1;
 $param['shop_country_id'] = 1;
 $param['shop_location_id'] = 1;
 $param['shop_city_id'] = 1;
 $param['shop_city_area_id'] = 1;
 $param['shop_warehouse_address'] = "ул. Ленина 176";
 $param['shop_warehouse_order'] = 10;
 $param['shop_warehouse_default'] = 1;
 
 if(($new_warehouse_id = $warehouse->InsertWarehouse($param)) !== false)
 {
     echo "Склад с идентификатором $new_warehouse_id успешно добавлен!";
 }
 else
 {
     echo "Ошибка добавления склада!";
 }
 
 ?>

Возвращает

идентификатор вставленной/обновленной записи, либо false

[ Наверх ]

warehouse::InsertWarehouseItems

InsertWarehouseItems( array $param );

Описание

Вставка/обновление количества товара на складе.

Обновление ведется по идентификатору связи, либо по индентификатору склада и товара

Принимаемые параметры

$param

массив параметров

int $param['shop_warehouse_items_id'] идентификатор связи (для обновления)
int $param['shop_warehouse_id'] идентификатор склада
int $param['shop_items_catalog_item_id'] идентификатор товара
float $param['shop_warehouse_items_count'] количество товара на складе
int $param['users_id'] идентификатор пользователя центра администрирования для установки владельца записи (используется только если $param['shop_warehouse_items_id'] == 0 или не передан)

 <?php
 $warehouse = & singleton('warehouse');
 
 $param = array();
 $param['shop_warehouse_id'] = 1;
 $param['shop_items_catalog_item_id'] = 10;
 $param['shop_warehouse_items_count'] = 100;
 
 if(($new_warehouse_items_id = $warehouse->InsertWarehouseItems($param)) !== false)
 {
     echo "Отстаток товара с идентификатором $new_warehouse_items_id успешно добавлен!";
 }
 else
 {
     echo "Ошибка добавления остатка!";
 }
 ?>

Возвращает

идентификатор вставленной/обновленной записи, либо false

[ Наверх ]

Описания переменных

$CacheGetAllWarehousesForShop = array() [Строка 33]
Data type: array

Описание

Кэш для метода GetAllWarehousesForShop()

$CacheGetItemCountForWarehouse = array() [Строка 27]
Data type: array

Описание

Кэш для метода GetItemCountForWarehouse()

$CacheGetWarehouse = array() [Строка 21]
Data type: array

Описание

Кэш для метода GetWarehouse()

Class warehouse

Свойства класса

Константы класса

Унаследованные константы класса

Унаследованные свойства класса

Методы

Унаследованные методы

Описания методов

warehouse::AcceptTransaction

warehouse::CopyWarehouse

warehouse::DeleteWarehouse

warehouse::DeleteWarehouseItem

warehouse::FillItemCountForWarehouse

warehouse::GetAllItemWarehouses

warehouse::GetAllWarehouseItems

warehouse::GetAllWarehousesForShop

warehouse::GetDefaultWarehouse

warehouse::GetItemCountForAllWarehouses

warehouse::GetItemCountForWarehouse

warehouse::GetWarehouse

warehouse::GetWarehouseItem

warehouse::GetWarehousesXml

warehouse::GetWarehouseXml

warehouse::InsertWarehouse

warehouse::InsertWarehouseItems

Описания переменных

Описание констант класса