Inheritance diagram for Version:

Public Member Functions
	__construct ($major, $minor, $revision, $build, $dateInstalled, $current, $productType, $product, $productClassName, $lazyLoad, $sitewide)

	compare ($version)

	getBuild ()

	getCurrent ()

	getDateInstalled ()

	getLazyLoad ()

	getMajor ()

	getMinor ()

	getProduct ()

	getProductClassName ()

	getProductType ()

	getRevision ()

	getSitewide ()

	getVersionString ($numeric=true)

	setBuild ($build)

	setCurrent ($current)

	setDateInstalled ($dateInstalled)

	setLazyLoad ($lazyLoad)

	setMajor ($major)

	setMinor ($minor)

	setProduct ($product)

	setProductClassName ($productClassName)

	setProductType ($productType)

	setRevision ($revision)

	setSitewide ($sitewide)

Public Member Functions inherited from DataObject
	__construct ()

	addSupportedMetadataAdapter ($metadataAdapter)

	extractMetadata ($metadataSchema)

	getAdditionalMetadataFieldNames ()

&	getAllData ()

	getDAO ()

&	getData ($key, $locale=null)

	getHasLoadableAdapters ()

	getId ()

	getLocaleMetadataFieldNames ()

	getLocalizedData ($key, $preferredLocale=null)

	getMetadataFieldNames ($translated=true)

	getSetMetadataFieldNames ($translated=true)

	getSupportedExtractionAdapters ()

	getSupportedInjectionAdapters ()

	getSupportedMetadataSchemas ()

	hasData ($key, $locale=null)

	injectMetadata ($metadataDescription)

	removeSupportedMetadataAdapter ($metadataSchemaName)

	setAllData (&$data)

	setData ($key, $value, $locale=null)

	setHasLoadableAdapters ($hasLoadableAdapters)

	setId ($id)

	unsetData ($key, $locale=null)

	upcastTo ($targetObject)

Static Public Member Functions
static	fromString ($versionString, $productType=null, $product=null, $productClass='', $lazyLoad=0, $sitewide=1)

Additional Inherited Members
Data Fields inherited from DataObject
	$_data = array()

	$_extractionAdaptersLoaded = false

	$_hasLoadableAdapters = false

	$_injectionAdaptersLoaded = false

	$_metadataExtractionAdapters = array()

	$_metadataInjectionAdapters = array()

Detailed Description

Describes system version history.

See also: VersionDAO

Definition at line 18 of file Version.inc.php.

Constructor & Destructor Documentation

◆ __construct()

Version::__construct	(	$major,
		$minor,
		$revision,
		$build,
		$dateInstalled,
		$current,
		$productType,
		$product,
		$productClassName,
		$lazyLoad,
		$sitewide
	)

Constructor.

Definition at line 22 of file Version.inc.php.

References setBuild(), setCurrent(), setDateInstalled(), setLazyLoad(), setMajor(), setMinor(), setProduct(), setProductClassName(), setProductType(), setRevision(), and setSitewide().

Member Function Documentation

◆ compare()

Version::compare ( $version )

Compare this version with another version. Returns: < 0 if this version is lower 0 if they are equal > 0 if this version is higher

Parameters

$version string/Version the version to compare against

Returns: int

Definition at line 50 of file Version.inc.php.

References getVersionString().

◆ fromString()

static Version::fromString	(	$versionString,
		$productType = `null`,
		$product = `null`,
		$productClass = `''`,
		$lazyLoad = `0`,
		$sitewide = `1`
	)

static

Static method to return a new version from a version string of the form "W.X.Y.Z".

Parameters

$versionString	string
$productType	string
$product	string
$productClass	string
$lazyLoad	integer
$sitewide	integer

Returns: Version

Definition at line 67 of file Version.inc.php.

References $application, PKPApplication\get(), and Core\getCurrentDate().

Referenced by Installer\parseInstaller(), VersionCheck\parseVersionXML(), and PKPInstall\preInstall().

◆ getBuild()

Version::getBuild ( )

Get build version.

Returns: int

Definition at line 149 of file Version.inc.php.

References DataObject\getData().

Referenced by getVersionString().

◆ getCurrent()

Version::getCurrent ( )

Check if current version.

Returns: int

Definition at line 181 of file Version.inc.php.

References DataObject\getData().

◆ getDateInstalled()

Version::getDateInstalled ( )

Get date installed.

Returns: date

Definition at line 165 of file Version.inc.php.

References DataObject\getData().

◆ getLazyLoad()

Version::getLazyLoad ( )

Get the lazy load flag for this product

Returns: boolean

Definition at line 245 of file Version.inc.php.

References DataObject\getData().

◆ getMajor()

Version::getMajor ( )

Get major version.

Returns: int

Definition at line 101 of file Version.inc.php.

References DataObject\getData().

Referenced by getVersionString().

◆ getMinor()

Version::getMinor ( )

Get minor version.

Returns: int

Definition at line 117 of file Version.inc.php.

References DataObject\getData().

Referenced by getVersionString().

◆ getProduct()

Version::getProduct ( )

Get product name.

Returns: string

Definition at line 213 of file Version.inc.php.

References DataObject\getData().

Referenced by getVersionString().

◆ getProductClassName()

Version::getProductClassName ( )

Get the product's class name

Returns: string

Definition at line 229 of file Version.inc.php.

References DataObject\getData().

◆ getProductType()

Version::getProductType ( )

Get product type.

Returns: string

Definition at line 197 of file Version.inc.php.

References DataObject\getData().

◆ getRevision()

Version::getRevision ( )

Get revision version.

Returns: int

Definition at line 133 of file Version.inc.php.

References DataObject\getData().

Referenced by getVersionString().

◆ getSitewide()

Version::getSitewide ( )

Get the sitewide flag for this product

Returns: boolean

Definition at line 261 of file Version.inc.php.

References DataObject\getData().

◆ getVersionString()

Version::getVersionString ( $numeric = true )

Return complete version string. @numeric boolean True (default) iff a numeric (comparable) version is to be returned.

Returns: string

Definition at line 278 of file Version.inc.php.

References getBuild(), getMajor(), getMinor(), getProduct(), and getRevision().

Referenced by compare().

◆ setBuild()

Version::setBuild ( $build )

Set build version.

Parameters

$build int

Definition at line 157 of file Version.inc.php.

References DataObject\setData().

Referenced by __construct().

◆ setCurrent()

Version::setCurrent ( $current )

Set if current version.

Parameters

$current int

Definition at line 189 of file Version.inc.php.

References DataObject\setData().

Referenced by __construct().

◆ setDateInstalled()

Version::setDateInstalled ( $dateInstalled )

Set date installed.

Parameters

$dateInstalled date

Definition at line 173 of file Version.inc.php.

References DataObject\setData().

Referenced by __construct().

◆ setLazyLoad()

Version::setLazyLoad ( $lazyLoad )

Set the lazy load flag for this product

Parameters

$lazyLoad boolean

Definition at line 253 of file Version.inc.php.

References DataObject\setData().

Referenced by __construct().

◆ setMajor()

Version::setMajor ( $major )

Set major version.

Parameters

$major int

Definition at line 109 of file Version.inc.php.

References DataObject\setData().

Referenced by __construct().

◆ setMinor()

Version::setMinor ( $minor )

Set minor version.

Parameters

$minor int

Definition at line 125 of file Version.inc.php.

References DataObject\setData().

Referenced by __construct().

◆ setProduct()

Version::setProduct ( $product )

Set product name.

Parameters

$product string

Definition at line 221 of file Version.inc.php.

References DataObject\setData().

Referenced by __construct().

◆ setProductClassName()

Version::setProductClassName ( $productClassName )

Set the product's class name

Parameters

$productClassName string

Definition at line 237 of file Version.inc.php.

References DataObject\setData().

Referenced by __construct().

◆ setProductType()

Version::setProductType ( $productType )

Set product type.

Parameters

$productType string

Definition at line 205 of file Version.inc.php.

References DataObject\setData().

Referenced by __construct().

◆ setRevision()

Version::setRevision ( $revision )

Set revision version.

Parameters

$revision int

Definition at line 141 of file Version.inc.php.

References DataObject\setData().

Referenced by __construct().

◆ setSitewide()

Version::setSitewide ( $sitewide )

Set the sitewide flag for this product

Parameters

$sitewide boolean

Definition at line 269 of file Version.inc.php.

References DataObject\setData().

Referenced by __construct().

The documentation for this class was generated from the following file:

Version.inc.php

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ compare()

◆ fromString()

◆ getBuild()

◆ getCurrent()

◆ getDateInstalled()

◆ getLazyLoad()

◆ getMajor()

◆ getMinor()

◆ getProduct()

◆ getProductClassName()

◆ getProductType()

◆ getRevision()

◆ getSitewide()

◆ getVersionString()

◆ setBuild()

◆ setCurrent()

◆ setDateInstalled()

◆ setLazyLoad()

◆ setMajor()

◆ setMinor()

◆ setProduct()

◆ setProductClassName()

◆ setProductType()

◆ setRevision()

◆ setSitewide()