Class Module

Module

XLite\Model\Module

Namespace: XLite\Model
Since: 1.0.0
See: ____class_see____
Entity: (repositoryClass="\XLite\Model\Repo\Module")
HasLifecycleCallbacks
Index: (name="enabled", columns={"enabled"}),
Index: (name="date", columns={"date"}),
Index: (name="downloads", columns={"downloads"}),
Index: (name="rating", columns={"rating"}) } )
Table: (name="modules", uniqueConstraints={
UniqueConstraint: (name="moduleVersion", columns={"author","name","majorVersion","minorVersion","fromMarketplace"}) }, indexes={
Located at XLite/Model/Module.php

Methods summary
`public string`	# `getMainClass( )` Return main class name for current module Return main class name for current module Returns `string` Since 1.0.0 See ____func_see____
`public mixed`	# `callModuleMethod( string $method, mixed $result = null, array $args = array() )` Method to call functions from module main classes Method to call functions from module main classes Parameters `$method` `string` Method to call `$result` `mixed` Method return value for the current class (model) OPTIONAL `$args` `array` Call arguments OPTIONAL Returns `mixed` Since 1.0.0 See ____func_see____
`protected boolean`	# `checkModuleMainClass( )` Check if we can call method from the module main class Check if we can call method from the module main class Returns `boolean` Since 1.0.0 See ____func_see____
`public string`	# `getActualName( )` Compose module actual name Compose module actual name Returns `string` Since 1.0.0 See ____func_see____
`public string`	# `getVersion( )` Return module full version Return module full version Returns `string` Since 1.0.0 See ____func_see____
`public boolean`	# `hasIcon( )` Check if module has a custom icon Check if module has a custom icon Returns `boolean` Since 1.0.0 See ____func_see____
`public string`	# `getSettingsForm( )` Return link to settings form Return link to settings form Returns `string` Since 1.0.0 See ____func_see____
`public array`	# `getDependencyModules( mixed $onlyDisabled = false )` Get list of dependency modules as Doctrine entities Get list of dependency modules as Doctrine entities Parameters `$onlyDisabled` `mixed` Flag OPTIONAL Returns `array` Since 1.0.15 See ____func_see____
`public array`	# `getDependentModules( )` Get list of dependent modules as Doctrine entities Get list of dependent modules as Doctrine entities Returns `array` Since 1.0.0 See ____func_see____
`public boolean`	# `isFree( )` Check if the module is free Check if the module is free Returns `boolean` Since 1.0.0 See ____func_see____
`public boolean`	# `isPurchased( )` Check if module is already purchased Check if module is already purchased Returns `boolean` Since 1.0.0 See ____func_see____
`public boolean`	# `isCustom( )` Check for custom module Check for custom module Returns `boolean` Since 1.0.0 See ____func_see____
`public XLite\Model\ModuleKey`	# `getLicenseKey( )` Search for license key Search for license key Returns `XLite\Model\ModuleKey` Since 1.0.0 See ____func_see____
`public XLite\Model\Currency`	# `getCurrency( )` Return currency for paid modules Return currency for paid modules Returns `XLite\Model\Currency` Since 1.0.0 See ____func_see____
`public boolean`	# `isInstalled( )` Check if module is installed in LC Check if module is installed in LC Returns `boolean` Since 1.0.0 See ____func_see____
`public array`	# `getIdentityData( )` Return some data to identify module Return some data to identify module Returns `array` Since 1.0.6 See ____func_see____
`public string`	# `getMarketplaceID( )` Generate marketplace ID Generate marketplace ID Returns `string` Since 1.0.0 See ____func_see____
`public`	# `prepareBeforeUpdate( )` Lifecycle callback Lifecycle callback Since 1.0.12 See ____func_see____ PreUpdate

Methods inherited from XLite\Model\AEntity
`__call(), __construct(), __get(), __set(), __unset(), checkCache(), cloneEntity(), create(), delete(), detach(), getMethodName(), getRepository(), getUniqueIdentifier(), isPersistent(), map(), prepareEntityBeforeCommit(), update()`

Constants inherited from XLite\Model\AEntity
`ACTION_DELETE, ACTION_INSERT, ACTION_UPDATE`

Properties summary
`protected integer`	`$moduleID`		# Module ID Module ID Since 1.0.0 See ____var_see____ Column (type="integer") GeneratedValue (strategy="AUTO") Id
`protected string`	`$name`		# Name Name Since 1.0.0 See ____var_see____ Column (type="string", length="64")
`protected string`	`$author`		# Author Author Since 1.0.0 See ____var_see____ Column (type="string", length="64")
`protected boolean`	`$enabled`	`false`	# Enabled Enabled Since 1.0.0 See ____var_see____ Column (type="boolean")
`protected boolean`	`$installed`	`false`	# Installed status Installed status Since 1.0.0 See ____var_see____ Column (type="boolean")
`protected integer`	`$date`	`0`	# Order creation timestamp Order creation timestamp Since 1.0.0 See ____var_see____ Column (type="integer")
`protected float`	`$rating`	`0`	# Rating Rating Since 1.0.0 See ____var_see____ Column (type="decimal", precision=14, scale=4)
`protected integer`	`$votes`	`0`	# Votes Votes Since 1.0.0 See ____var_see____ Column (type="integer")
`protected integer`	`$downloads`	`0`	# Downloads Downloads Since 1.0.0 See ____var_see____ Column (type="integer")
`protected float`	`$price`	`0.00`	# Price Price Since 1.0.0 See ____var_see____ Column (type="decimal", precision=14, scale=2)
`protected string`	`$currency`	`'USD'`	# Currency code Currency code Since 1.0.0 See ____var_see____ Column (type="string", length=3)
`protected string`	`$majorVersion`		# Major version Major version Since 1.0.0 See ____var_see____ Column (type="string", length=8)
`protected string`	`$minorVersion`		# Minor version Minor version Since 1.0.0 See ____var_see____ Column (type="integer")
`protected integer`	`$revisionDate`	`0`	# Revision date Revision date Since 1.0.0 See ____var_see____ Column (type="integer")
`protected integer`	`$packSize`	`0`	# Module pack size (received from marketplace) Module pack size (received from marketplace) Since 1.0.0 See ____var_see____ Column (type="bigint")
`protected string`	`$moduleName`		# Module name Module name Since 1.0.0 See ____var_see____ Column (type="string", length=255)
`protected string`	`$authorName`		# Author name Author name Since 1.0.0 See ____var_see____ Column (type="string", length=255)
`protected string`	`$description`	`''`	# Description Description Since 1.0.0 See ____var_see____ Column (type="text")
`protected string`	`$iconURL`	`''`	# Icon URL Icon URL Since 1.0.0 See ____var_see____ Column (type="string", length=255)
`protected string`	`$pageURL`	`''`	# Icon URL Icon URL Since 1.0.0 See ____var_see____ Column (type="string", length=255)
`protected string`	`$authorPageURL`	`''`	# Icon URL Icon URL Since 1.0.0 See ____var_see____ Column (type="string", length=255)
`protected array`	`$dependencies`	`array()`	# Module dependencies Module dependencies Since 1.0.0 See ____var_see____ Column (type="array")
`protected boolean`	`$fromMarketplace`	`false`	# Flag Flag Since 1.0.0 See ____var_see____ Column (type="boolean")
`protected string`	`$marketplaceID`		# Public identifier (cache) Public identifier (cache) Since 1.0.0 See ____var_see____

Properties inherited from XLite\Model\AEntity
`$cacheEnabled, $methodNames`

Namespaces

Classes

Class Module

Returns

Since

See

Parameters

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Parameters

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Returns

Since

See

Since

See

PreUpdate

Since

See

Column

GeneratedValue

Id

Since

See

Column

Since

See

Column

Since

See

Column

Since

See

Column

Since

See

Column

Since