gy-doc-code
[ class tree: gy-doc-code ] [ index: gy-doc-code ] [ all elements ]

Class: Module

Source Location: /Gy/Core/Module.php

''

Class Overview


Module - работа с модулями фреймворка


Variables

Methods


''

Class Details

[line 10]
Module - работа с модулями фреймворка

Module - работа с модулями фреймворка




[ Top ]


Class Variables

static $module =

[line 38]



Tags:

access:  private

Type:   mixed


[ Top ]

$arrayIncludeModules = array()

[line 14]



Tags:

access:  public

Type:   mixed


[ Top ]

$arrayIncludeModulesAndVersion = array()

[line 17]



Tags:

access:  public

Type:   mixed


[ Top ]

$buttonMenuAdminPanel = array()

[line 29]



Tags:

access:  public

Type:   mixed


[ Top ]

$isShowButtonsMenuAdminPanelModules = array()

[line 32]



Tags:

access:  public

Type:   mixed


[ Top ]

$nameClassModuleByNameModule = array()

[line 23]



Tags:

access:  public

Type:   mixed


[ Top ]

$nameModuleByComponentName = array()

[line 20]



Tags:

access:  public

Type:   mixed


[ Top ]

$nameModuleByNameAdminPage = array()

[line 26]



Tags:

access:  public

Type:   mixed


[ Top ]

$urlGyCore =  false

[line 35]



Tags:

access:  private

Type:   mixed


[ Top ]



Class Methods


constructor __construct [line 40]

Module __construct( )



Tags:

access:  private


'' ''
[ Top ]

method getButtonsMenuAllModules [line 279]

array getButtonsMenuAllModules( )

getButtonsMenuAllModules

getButtonsMenuAllModules

  • вернуть все пункты меню админки всех подключённых модулей




Tags:

return:  - массив с кнопками где ключ это код модуля, а значения как результат getButtonsMenuByModule
access:  public


'' ''
[ Top ]

method getButtonsMenuByModule [line 267]

array getButtonsMenuByModule( string $nameModule)

getButtonsMenuByModule

getButtonsMenuByModule

  • вернуть кнопки меню панели администратора определённые в указанном модуле




Tags:

return:  - массив с кнопками где ключ это название пункта меню а значение url
access:  public


'' ''

Parameters:

string   $nameModule   - код модуля

[ Top ]

method getFlagShowButtonsAdminPanelByModule [line 294]

string getFlagShowButtonsAdminPanelByModule( string $nameModule)

getFlagShowButtonsAdminPanelByModule

getFlagShowButtonsAdminPanelByModule

  • вернуть условие показа кнопок в админке,
это код для метода Gy\Core\User\AccessUserGroup::accessThisUserByAction т.е. действие и если оно разрешено пользователю то покажется пункты меню в админке




Tags:

return:  - код действия
access:  public


'' ''

Parameters:

string   $nameModule   - код модуля

[ Top ]

method getInfoAllIncludeModules [line 299]

void getInfoAllIncludeModules( )



Tags:

access:  public


'' ''
[ Top ]

method getInstance [line 56]

jbject getInstance( )

getInstance

getInstance

  • получение объекта класса (всегда один обьект)
реализация singleton




Tags:

return:  this class
access:  public


'' ''
[ Top ]

method getModulesComponent [line 165]

string getModulesComponent( string $nameComponent)

getModulesComponent

getModulesComponent

  • получить по имени компонента данные о компоненте из подключённых модулей




Tags:

access:  public


'' ''

Parameters:

string   $nameComponent  

[ Top ]

method getUrlModuleClassByNameClass [line 183]

string getUrlModuleClassByNameClass( string $nameClass)

getUrlModuleClassByNameClass

getUrlModuleClassByNameClass

  • по имени класса, если он есть в одном из подключённых модулей выдать урл на класс




Tags:

access:  public


'' ''

Parameters:

string   $nameClass  

[ Top ]

method includeAllModules [line 217]

void includeAllModules( )

includeAllModules()

includeAllModules()

  • подключить все имеющиеся модули




Tags:

access:  public


'' ''
[ Top ]

method includeModule [line 78]

bool includeModule( string $nameModule)

IncludeModule

IncludeModule

  • подключить указанный модуль
(т.е. ядро узнает о классах, компонентах модуля и прочем)




Tags:

return:  - вернёт true если модуль найден и подключен или false если нет
access:  public


'' ''

Parameters:

string   $nameModule   - имя модуля

[ Top ]

method includeModuleByUrl [line 95]

boolean includeModuleByUrl( string $urlModule)

includeModuleByUrl

includeModuleByUrl

  • подключить модуль по указанному урлу




Tags:

access:  public


'' ''

Parameters:

string   $urlModule  

[ Top ]

method installBdAllModules [line 250]

void installBdAllModules( )

installBdAllModules

installBdAllModules

  • установить части БД для всех модулей




Tags:

access:  public


'' ''
[ Top ]

method installDbModuleByNameModule [line 234]

boolean installDbModuleByNameModule( string $nameModule)

installDbModuleByNameModule

installDbModuleByNameModule

  • установить часть БД связанную с этим модулем




Tags:

access:  public


'' ''

Parameters:

string   $nameModule   - имя модуля

[ Top ]

method searchAllModules [line 198]

array searchAllModules( )

searchAllModules()

searchAllModules()

  • найти все разделы из раздела /gy/modules , т.е. все имеющиеся модули




Tags:

access:  public


'' ''
[ Top ]

method setUrlGyCore [line 64]

void setUrlGyCore( $urlGyCore)



Tags:

access:  public


'' ''

Parameters:

   $urlGyCore  

[ Top ]


Documentation generated on Sat, 27 Apr 2024 11:17:29 +0300 by phpDocumentor 1.4.3