| access |
public |
| package |
kocuj_internal_lib |
| inherited_from |
\KocujIL\V12a\Classes\ComponentObject |
Methods
Constructor
__construct(object $projectObj) : void
Inherited
Parameters
$projectObj
object\KocujIL\V12a\Classes\Project object for current project
Action for updating version number
actionPluginsLoaded() : void
Get object of class type from component
getComponent(string $type, integer $projectCategory = \KocujIL\V12a\Enums\ProjectCategory::CORE, string $fragment = '') : object
Inherited
Parameters
$type
stringComponent type
$projectCategory
integerComponent category; must be one of the following constants from \KocujIL\V12a\Enums\ProjectCategory: CORE (for "core" category), ALL (for "all" category), FRONTEND (for "frontend" category) or BACKEND (for "backend" category) - default: \KocujIL\V12a\Enums\ProjectCategory::CORE
$fragment
stringComponent fragment - default: empty
Returns
objectObject of class type from component
Get current version of project
getCurrentVersion() : string
Returns
stringCurrent version of project
Get old version number from database
getOldVersionOptionValue() : array
Returns
arrayOld version number from database
Get old version number for site from database
getOldVersionSiteOptionValue() : array
Returns
arrayOld version number for site from database
Get option name for old version number
getOptionNameOldVersion() : string
Static
Returns
stringOption name for old version number
Get option name for version
getOptionNameVersion() : string
Static
Returns
stringOption name for version
Get object of type \KocujIL\V12a\Classes\Project
getProjectObj() : object
Inherited
Returns
objectObject of type \KocujIL\V12a\Classes\Project
Get object of class type for strings from component
getStrings(string $type, integer $projectCategory = \KocujIL\V12a\Enums\ProjectCategory::CORE) : object
Inherited
Parameters
$type
stringComponent type
$projectCategory
integerComponent category; must be one of the following constants from \KocujIL\V12a\Enums\ProjectCategory: CORE (for "core" category), ALL (for "all" category), FRONTEND (for "frontend" category) or BACKEND (for "backend" category) - default: \KocujIL\V12a\Enums\ProjectCategory::CORE
Returns
objectObject of class type for strings from component
Get update callbacks
getUpdateCallbacks() : array
Returns
arrayUpdate callbacks
Get version number from database
getVersionOptionValue() : string
Returns
stringVersion number from database
Get version number for site from database
getVersionSiteOptionValue() : string
Returns
stringVersion number for site from database
Set current version of project
setCurrentVersion($currentVersion) : void
Parameters
$currentVersion
Set update callbacks
setUpdateCallbacks(array|string $updateCallback, array|string $siteUpdateCallback = NULL) : void
Parameters
$updateCallback
arraystringCallback function or method name for update; can be global function or method from any class
$siteUpdateCallback
arraystringCallback function or method name for site update; can be global function or method from any class - default: NULL
Update project version
update(boolean|string $version, string $updateCallbackType, integer $metaType) : void
Parameters
$version
booleanstringVersion number or false if cannot be retrieved
$updateCallbackType
stringUpdate callback type
$metaType
integerMeta type; must be one of the following constants from \KocujIL\V12a\Enums\Project\Components\Core\Meta\Type: AUTO (for automatic meta type) or SITE (for site meta type)
Properties
Current version of project
$currentVersion : string
\KocujIL\V12a\Classes\Project object for current project
$projectObj : object
Update callbacks
$updateCallbacks : array