Docs For Class JVersion

Description

Version information class for the Joomla CMS.

since: 1.0

Located in /libraries/cms/version/version.php (line 19)

Variable Summary

string $BUILD

string $CODENAME

string $COPYRIGHT

string $DEV_LEVEL

string $DEV_STATUS

string $PRODUCT

string $RELDATE

string $RELEASE

string $RELTIME

string $RELTZ

string $URL

Method Summary

string generateMediaVersion ()

string getHelpVersion ()

string getLongVersion ()

string getMediaVersion ()

string getShortVersion ()

string getUserAgent ([string $component = null], [bool $mask = false], [bool $add_version = true])

bool isCompatible (string $minimum)

JVersion refreshMediaVersion ()

JVersion setMediaVersion (string $mediaVersion)

Variables

string $BUILD = '' (line 34)

var: Build number.
access: public

string $CODENAME = 'Ember' (line 37)

var: Code name.
access: public

var: Copyright Notice.
access: public

string $DEV_LEVEL = '0.rc' (line 28)

var: Maintenance version.
access: public

string $DEV_STATUS = 'Release Candidate' (line 31)

var: Development STATUS.
access: public

string $PRODUCT = 'Joomla!' (line 22)

var: Product name.
access: public

string $RELDATE = '24-October-2013' (line 40)

var: Release date.
access: public

string $RELEASE = '3.2' (line 25)

var: Release version.
access: public

string $RELTIME = '14:00' (line 43)

var: Release time.
access: public

string $RELTZ = 'GMT' (line 46)

var: Release timezone.
access: public

string $URL = '<a href="http://www.joomla.org">Joomla!</a> is Free Software released under the GNU General Public License.' (line 52)

var: Link text.
access: public

Methods

generateMediaVersion (line 149)

Generate a media version string for assets Public to allow third party developers to use it

since: 3.2
access: public

string generateMediaVersion ()

getHelpVersion (line 76)

Method to get the help file version.

return: Version suffix for help files.
since: 1.0
access: public

string getHelpVersion ()

getLongVersion (line 100)

Gets a version string for the current Joomla with all release information.

return: Complete version string.
since: 1.5
access: public

string getLongVersion ()

getMediaVersion (line 168)

Gets a media version which is used to append to Joomla core media files.

This media version is used to append to Joomla core media in order to trick browsers into reloading the CSS and JavaScript, because they think the files are renewed. The media version is renewed after Joomla core update, install, discover_install and uninstallation.

return: The media version.
since: 3.2
access: public

string getMediaVersion ()

getShortVersion (line 88)

Gets a "PHP standardized" version string for the current Joomla.

return: Version string.
since: 1.5
access: public

string getShortVersion ()

getUserAgent (line 118)

Returns the user agent.

return: User Agent.
since: 1.0
access: public

string getUserAgent ([string $component = null], [bool $mask = false], [bool $add_version = true])

string $component: Name of the component.
bool $mask: Mask as Mozilla/5.0 or not.
bool $add_version: Add version afterwards to component.

isCompatible (line 64)

Compares two a "PHP standardized" version number against the current Joomla version.

return: True if the version is compatible.
see: http://www.php.net/version_compare
since: 1.0
access: public

bool isCompatible (string $minimum)

string $minimum: The minimum version of the Joomla which is compatible.

refreshMediaVersion (line 203)

Function to refresh the media version

return: Instance of $this to allow chaining.
since: 3.2
access: public

JVersion refreshMediaVersion ()

setMediaVersion (line 219)

Sets the media version which is used to append to Joomla core media files.

return: Instance of $this to allow chaining.
since: 3.2
access: public

JVersion setMediaVersion (string $mediaVersion)

string $mediaVersion: The media version.