Class Modules

Description

Базовый класс модуля "Каталог товаров/услуг"

Located in /itweb/modules/Modules/class.Modules.php (line 17)

MyModule
   |
   --Modules
Direct descendents
Class Description
 class AdminModules Класс администрирования модуля "Модули системы"
Variable Summary
 string $desc
 bool $hidden
 string $icon
 string $imgDir
 array $modCatIDs
 array $modNames
 string $modObjs
 array $modPrps
 string $modsPrpsFile
 string $mPrpsCatName
 string $name
 array $siteCatIDs
 string $version
 string $viewsGrpName
Method Summary
 Modules Modules ()
 array GetCategories ([integer $type = 1], integer $getPrps, [string $ptypeNames = ""], boolean $bExtractMultipleValues, boolean $bCntItems)
 integer GetModPrpsCategoryID (integer $mID)
 integer GetModuleIDByCategoryID (integer $cID)
 integer GetModuleIDByName (string $modName)
 string GetModuleNameByID (integer $mID)
 object объект GetModuleProperties (integer $mID, [string $modName = ''])
 object объект &LoadModule (string $modName, integer $mID, bool $bStatic, mixed $bAdmin)
 bool LoadModulesData (bool $noCache)
 void OnLoad (mixed &$oITWEB)
 boolean UnLoadModule (mixed $mID)
 void __destructor ()
Variables
string $desc = "Менеджер модулей системы" (line 30)

Описание модуля

bool $hidden = 0 (line 42)

Скрытый модуль

string $icon = "mod_modules.gif" (line 36)

Иконка модуля

string $imgDir = '' (line 96)

Имя директории, в которой храняться изображения сохраняемые пользователем

array $modCatIDs = array() (line 84)

Кэш для IDs категорий, содержащих свойства модулей

array $modNames = array() (line 72)

Массив наименований модулей системы

string $modObjs = null (line 54)

Массив объектов модулей загруженных статично

array $modPrps = array() (line 78)

Массив свойств модулей системы

string $modsPrpsFile = '__modsPrps' (line 66)

Наименование файла для хранения serialize массива свойств модулей системы

string $mPrpsCatName = '__modsPrps' (line 60)

Наименование системной категории для хранения подкатегорий со свойствами модулей системы

string $name = "Модули системы" (line 24)

Имя модуля


Redefinition of:
MyModule::$name
Имя модуля
array $siteCatIDs = array() (line 90)

Кэш для IDs категорий сайтов, содержащих категории со свойствами модулей ($modCatIDs)

string $version = '' (line 48)

Версия

string $viewsGrpName = 'Виды модуля' (line 102)

Имя группы свойств видов модуля

Inherited Variables

Inherited from MyModule

MyModule::$connectionID
MyModule::$oITWEB
MyModule::$oMyCatalog
MyModule::$prps
MyModule::$view_php_funcPrefix
Methods
Constructor Modules (line 109)

Конструктор. Выполняет инициализацию модуля.

Modules Modules ()
GetCategories (line 158)

Сделать выборку категорий

  • return: массив идентификаторов выбранных элементов
array GetCategories ([integer $type = 1], integer $getPrps, [string $ptypeNames = ""], boolean $bExtractMultipleValues, boolean $bCntItems)
  • integer $type: тип выборки
    1. - выбрать категории текущего уровня
    2. - выбрать все подкатегории текущей категории (включая текущую категорию)
    3. - выбрать все категории и подкатегории, начиная с корневой
  • integer $getPrps: тип выборки свойств элементов
    1. - массив элементов со всеми свойствами
    2. - массив идентификаторов элементов
    3. - массив элементов с ограниченным набором свойств, заданным в $ptypeNames
  • string $ptypeNames: строка наименований типов свойств, разделённая запятыми
  • boolean $bExtractMultipleValues: флаг извлечения многозначных свойств (замедляет работу)
  • boolean $bCntItems: флаг подсчёта элементов категорий

Redefinition of:
MyModule::GetCategories()
Сделать выборку категорий
GetModPrpsCategoryID (line 172)

Получить ID категории свойств модуля

integer GetModPrpsCategoryID (integer $mID)
  • integer $mID: ID модуля
GetModuleIDByCategoryID (line 399)

Проверить существует CMS данный модуль

  • return: идентификатор модуля
integer GetModuleIDByCategoryID (integer $cID)
  • integer $cID: идентификатор категории
GetModuleIDByName (line 349)

Проверить существует ли в БД CMS данный модуль

  • return: ID модуля
integer GetModuleIDByName (string $modName)
  • string $modName: имя модуля
GetModuleNameByID (line 362)

Проверить существует в БД CMS данный модуль

  • return: имя модуля
string GetModuleNameByID (integer $mID)
  • integer $mID: ID модуля
GetModuleProperties (line 379)

Получить свойства модуля

  • return: модуля
object объект GetModuleProperties (integer $mID, [string $modName = ''])
  • integer $mID: ID модуля
  • string $modName: имя модуля

Redefinition of:
MyModule::GetModuleProperties()
Получить свойства модуля
LoadModule (line 426)

Загрузка модуля

  • return: загруженного модуля
object объект &LoadModule (string $modName, integer $mID, bool $bStatic, mixed $bAdmin)
  • string $modName: имя модуля
  • integer $mID: ID модуля
  • bool $bStatic: очищать загружаемый модуль

Redefinition of:
MyModule::LoadModule()
Загрузка модуля
LoadModulesData (line 212)

Получить свойства загруженных в систему модулей

  • return: результат выполнения операции
bool LoadModulesData (bool $noCache)
  • bool $noCache: флаг кеширования свойств загруженных в систему модулей
OnLoad (line 119)

Функция вызываемая при загрузке модуля

void OnLoad (mixed &$oITWEB)
UnLoadModule (line 487)

Отключение модуля

  • return: результат выполнения операции
boolean UnLoadModule (mixed $mID)
__destructor (line 502)

Деструктор

void __destructor ()

Inherited Methods

Inherited From MyModule

 MyModule::MyModule()
 MyModule::AddCategoriesPropertiesTables()
 MyModule::AddCategory()
 MyModule::AddDataType()
 MyModule::AddItem()
 MyModule::AddItemsPropertiesTables()
 MyModule::AddPropertiesTables()
 MyModule::AddPropertyType()
 MyModule::BuildPropertyTypesMap()
 MyModule::CheckDelResourceProperty()
 MyModule::CheckElementResources()
 MyModule::CheckModifyResourceProperty()
 MyModule::ClearCategoriesPropertiesCache()
 MyModule::CopyCategory()
 MyModule::CopyFileProperties()
 MyModule::CopyItem()
 MyModule::CountItems()
 MyModule::CurrentCategory()
 MyModule::CurrentItem()
 MyModule::CurrentModule()
 MyModule::DelCategoriesPropertiesTables()
 MyModule::DelCategory()
 MyModule::DelDataType()
 MyModule::DelElementResources()
 MyModule::DelItem()
 MyModule::DelItemsPropertiesTables()
 MyModule::DelPropertiesTables()
 MyModule::DelPropertyType()
 MyModule::GetCachedCategories()
 MyModule::GetCacheDir()
 MyModule::GetCachedItems()
 MyModule::GetCategories()
 MyModule::GetCategoriesFilter()
 MyModule::GetCategory()
 MyModule::GetCategoryID()
 MyModule::GetCategoryLight()
 MyModule::GetCategoryProperties()
 MyModule::GetCategoryPropertiesLight()
 MyModule::GetCategoryProperty()
 MyModule::GetCategoryPropertyTypes()
 MyModule::GetCategoryPropertyTypesLight()
 MyModule::GetCurrentLevel()
 MyModule::GetCurrentModule()
 MyModule::GetDataType()
 MyModule::GetDataTypes()
 MyModule::GetFileDir()
 MyModule::GetFilter()
 MyModule::GetFirstChild()
 MyModule::GetImgDir()
 MyModule::GetItem()
 MyModule::GetItemLight()
 MyModule::GetItemPosition()
 MyModule::GetItemProperties()
 MyModule::GetItemPropertiesLight()
 MyModule::GetItemProperty()
 MyModule::GetItemPropertyEx()
 MyModule::GetItemPropertyTypes()
 MyModule::GetItemPropertyTypesLight()
 MyModule::GetItems()
 MyModule::GetItemsFilter()
 MyModule::GetItemsLimit()
 MyModule::GetItemsOffset()
 MyModule::GetItemsRange()
 MyModule::GetItemsSorting()
 MyModule::GetMaxCategory()
 MyModule::GetMaxCategoryID()
 MyModule::GetMaxItem()
 MyModule::GetMaxLevel()
 MyModule::GetMinItem()
 MyModule::GetModuleProperties()
 MyModule::GetParentCategory()
 MyModule::GetProperties()
 MyModule::GetPropertyByName()
 MyModule::GetPropertyMultipleValue()
 MyModule::GetPropertyType()
 MyModule::GetPropertyTypeGroups()
 MyModule::GetPropertyTypes()
 MyModule::GetRootCategory()
 MyModule::Init()
 MyModule::isCategoryContainsCategory()
 MyModule::isCategoryExist()
 MyModule::isCategoryLeaf()
 MyModule::isCategoryPropertyTypeExist()
 MyModule::isCategorySearch()
 MyModule::isCategorySystem()
 MyModule::isDataTypeExist()
 MyModule::isItemExist()
 MyModule::isItemPropertyTypeExist()
 MyModule::isPropertyTypeExist()
 MyModule::LoadModule()
 MyModule::LoadStatus()
 MyModule::ModifyCategory()
 MyModule::ModifyItem()
 MyModule::ModifyPropertyType()
 MyModule::MoveCategory()
 MyModule::MoveItem()
 MyModule::PopUp()
 MyModule::ResetCachedItems()
 MyModule::ResetCategoriesFilter()
 MyModule::ResetFilter()
 MyModule::ResetItemsFilter()
 MyModule::ResetItemsSorting()
 MyModule::RootCategory()
 MyModule::SaveStatus()
 MyModule::SetCachedCategories()
 MyModule::SetCachedItems()
 MyModule::SetCategoriesFilter()
 MyModule::SetFilter()
 MyModule::SetItemsFilter()
 MyModule::SetItemsLimit()
 MyModule::SetItemsOffset()
 MyModule::SetItemsRandomSorting()
 MyModule::SetItemsRange()
 MyModule::SetItemsSearchFilter()
 MyModule::SetItemsSorting()
 MyModule::SetPropertyMultipleValue()
 MyModule::ShiftCategory()
 MyModule::ShiftItem()
 MyModule::ShiftPropertyType()
 MyModule::ShowHiddenCategories()
 MyModule::ShowSystemProperties()

Documentation generated on Wed, 21 Mar 2007 17:35:10 +0300 by phpDocumentor 1.3.0RC3