Open Journal Systems  2.4.4
 All Classes Namespaces Functions Variables Groups Pages
Version Class Reference
Inheritance diagram for Version:
DataObject

Public Member Functions

 compare ($version)
 
fromString ($versionString, $productType=null, $product=null, $productClass= '', $lazyLoad=0, $sitewide=1)
 
 getBuild ()
 
 getCurrent ()
 
 getDateInstalled ()
 
 getLazyLoad ()
 
 getMajor ()
 
 getMinor ()
 
 getProduct ()
 
 getProductClassName ()
 
 getProductType ()
 
 getRevision ()
 
 getSitewide ()
 
 getVersionString ()
 
 setBuild ($build)
 
 setCurrent ($current)
 
 setDateInstalled ($dateInstalled)
 
 setLazyLoad ($lazyLoad)
 
 setMajor ($major)
 
 setMinor ($minor)
 
 setProduct ($product)
 
 setProductClassName ($productClassName)
 
 setProductType ($productType)
 
 setRevision ($revision)
 
 setSitewide ($sitewide)
 
 Version ($major, $minor, $revision, $build, $dateInstalled, $current, $productType, $product, $productClassName, $lazyLoad, $sitewide)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter (&$metadataAdapter)
 
 DataObject ($callHooks=true)
 
extractMetadata (&$metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 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)
 
upcastTo (&$targetObject)
 

Additional Inherited Members

- Public Attributes inherited from DataObject
 $_data = array()
 

Detailed Description

Describes system version history.

See Also
VersionDAO

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

Member Function Documentation

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
$versionstring/Version the version to compare against
Returns
int

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

References getVersionString().

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

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

Parameters
$versionStringstring
$productTypestring
$productstring
$productClassstring
$lazyLoadinteger
$sitewideinteger
Returns
Version

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

References PKPApplication\getApplication(), Core\getCurrentDate(), and Version().

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

Version::getBuild ( )

Get build version.

Returns
int

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

References DataObject\getData().

Referenced by getVersionString().

Version::getCurrent ( )

Check if current version.

Returns
int

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

References DataObject\getData().

Version::getDateInstalled ( )

Get date installed.

Returns
date

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

References DataObject\getData().

Version::getLazyLoad ( )

Get the lazy load flag for this product

Returns
boolean

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

References DataObject\getData().

Version::getMajor ( )

Get major version.

Returns
int

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

References DataObject\getData().

Referenced by getVersionString().

Version::getMinor ( )

Get minor version.

Returns
int

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

References DataObject\getData().

Referenced by getVersionString().

Version::getProduct ( )

Get product name.

Returns
string

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

References DataObject\getData().

Version::getProductClassName ( )

Get the product's class name

Returns
string

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

References DataObject\getData().

Version::getProductType ( )

Get product type.

Returns
string

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

References DataObject\getData().

Version::getRevision ( )

Get revision version.

Returns
int

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

References DataObject\getData().

Referenced by getVersionString().

Version::getSitewide ( )

Get the sitewide flag for this product

Returns
boolean

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

References DataObject\getData().

Version::getVersionString ( )

Return complete version string.

Returns
string

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

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

Referenced by compare().

Version::setBuild (   $build)

Set build version.

Parameters
$buildint

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

References DataObject\setData().

Referenced by Version().

Version::setCurrent (   $current)

Set if current version.

Parameters
$currentint

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

References DataObject\setData().

Referenced by Version().

Version::setDateInstalled (   $dateInstalled)

Set date installed.

Parameters
$dateInstalleddate

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

References DataObject\setData().

Referenced by Version().

Version::setLazyLoad (   $lazyLoad)

Set the lazy load flag for this product

Parameters
$lazyLoadboolean

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

References DataObject\setData().

Referenced by Version().

Version::setMajor (   $major)

Set major version.

Parameters
$majorint

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

References DataObject\setData().

Referenced by Version().

Version::setMinor (   $minor)

Set minor version.

Parameters
$minorint

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

References DataObject\setData().

Referenced by Version().

Version::setProduct (   $product)

Set product name.

Parameters
$productstring

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

References DataObject\setData().

Referenced by Version().

Version::setProductClassName (   $productClassName)

Set the product's class name

Parameters
$productClassNamestring

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

References DataObject\setData().

Referenced by Version().

Version::setProductType (   $productType)

Set product type.

Parameters
$productstring

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

References DataObject\setData().

Referenced by Version().

Version::setRevision (   $revision)

Set revision version.

Parameters
$revisionint

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

References DataObject\setData().

Referenced by Version().

Version::setSitewide (   $sitewide)

Set the sitewide flag for this product

Parameters
$sitewideboolean

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

References DataObject\setData().

Referenced by Version().

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

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