Class we_app_Common

Description

class for administrating webEdition applications (formerly known as "tools")

Located in /app/Common.php (line 25)


	
			
Method Summary
static void activate ([ $appname = ""])
static void addAppToTOC ( $appname)
static object SimpleXMLElement createAppTOCEntry (string $appname, [bool $checkInstallation = true])
static void deactivate ([ $appname = ""])
static void getActiveApplications ()
static void getAllApplications ()
static string getAppTOCAttribute ([string $appname = ""], [string $attribute = ""], [string $element = ""])
static string getAppTOCElement ([string $appname = ""], [string $element = ""])
static object SimpleXMLElement getAppTOCEntry ([string $appname = ""])
static void getConfigElement ([ $element = ""])
static void getDefaultManifest ()
static object Zend_Config getManifest (string $application)
static void getManifestAttribute ([ $appname = ""], [ $attribute = ""])
static object SimpleXMLElement getManifestElement ([ $source = ""], [string $query = ""], string $appname)
static object SimpleXML getManifestXml ([ $source = ""], string $filename)
static string getVersion ([string $version = ""], [bool $nodots = false])
static void isActive ([ $appname = ""])
static void isInstalled ([ $appname = ""])
static void readAppTOC ([bool $overwrite = false])
static void readConfig ()
static void rebuildAppTOC ()
static bool saveAppTOC ([object SimpleXMLElement $toc = null])
static void setManifestAttribute ([ $appname = ""], [ $attribute = ""], [ $value = ""])
static void setManifestElement ([string $appname = ""], [string $query = ""], [ $value = ""])
Methods
static method activate (line 654)

activate a previoulsy deactivated application

  • set attribute in manifest.xml
  • set attribute of the application's toc.xml entry

  • access: public
static void activate ([ $appname = ""])
  • $appname
static method addAppToTOC (line 492)

adds an entry for a specified application into toc.

  • access: public
static void addAppToTOC ( $appname)
  • $appname
static method createAppTOCEntry (line 185)

this method creates a new application toc entry with all needed elements.

  • return: with application data or false (on failure)
  • access: public
static object SimpleXMLElement createAppTOCEntry (string $appname, [bool $checkInstallation = true])
  • string $appname: name of the application for which the application toc entry has to be created the attribute "active" will be set to "true" by default
  • bool $checkInstallation: flag for a check if the specified application is installed
static method deactivate (line 687)

deactivate an application

  • set attribute in manifest.xml
  • set attribute of the application's toc.xml entry

  • access: public
static void deactivate ([ $appname = ""])
  • $appname
static method getActiveApplications (line 65)

returns an array with all currently activated applications

  • access: public
static void getActiveApplications ()
static method getAllApplications (line 52)

returns an array with the name of all installed applications

  • access: public
static void getAllApplications ()
static method getAppTOCAttribute (line 368)

fetches the attribute's value of a specified application's toc entry element

  • return: value of the requested attribute
  • access: public
static string getAppTOCAttribute ([string $appname = ""], [string $attribute = ""], [string $element = ""])
  • string $appname: name of the application
  • string $attribute: name of the requested attribute
  • string $element: name of the requested element leave it empty to request an attribute of the <application> element
static method getAppTOCElement (line 345)

fetches the value of a specified application's toc entry element

  • return: value of the requested element
  • access: public
static string getAppTOCElement ([string $appname = ""], [string $element = ""])
  • string $appname: name of the application
  • string $element: name of the requested element
static method getAppTOCEntry (line 635)

fetches informations for a specified application from the application toc

  • return: object of the requested application toc entry
  • access: public
static object SimpleXMLElement getAppTOCEntry ([string $appname = ""])
  • string $appname: application name for the requested toc entry
static method getConfigElement (line 718)

returns a specified config value or false

  • access: public
static void getConfigElement ([ $element = ""])
  • $element
static method getDefaultManifest (line 553)

get default value for an application's property from webEdition/lib/we/app/defaults/manifest.xml The default values are used if an application does not have a manifest file.

  • access: public
static void getDefaultManifest ()
static method getManifest (line 581)

Reads the application's manifest file via Zend_Config and merges it with the default manifest.

this internal method merges the two SimpleXML objects for default properties and the application's manifest.

  • return: object containing the merge result
  • access: public
static object Zend_Config getManifest (string $application)
  • string $application: name of the application
static method getManifestAttribute (line 468)
  • access: public
static void getManifestAttribute ([ $appname = ""], [ $attribute = ""])
  • $appname
  • $attribute
static method getManifestElement (line 423)

reads an element from a specified manifest file (application name)

static object SimpleXMLElement getManifestElement ([ $source = ""], [string $query = ""], string $appname)
  • string $appname: name of the application
  • string $query: xpath query
  • $source
static method getManifestXml (line 390)

reads the manifest file via SimpleXML from a specified path (absolute path)

  • return: object of manifest file contents
  • access: public
static object SimpleXML getManifestXml ([ $source = ""], string $filename)
  • string $filename: path and filename to the manifest.xml file
  • $source
static method getVersion (line 84)

checks version number of an application for special variables and returns it to the caller

WE_VERSION version of the currently used webEdition installation

  • return: version number
  • access: public
static string getVersion ([string $version = ""], [bool $nodots = false])
  • string $version: version number
  • bool $nodots: nodots eliminates all dots
static method isActive (line 322)

checks if the application with the name $name is currently active

  • access: public
static void isActive ([ $appname = ""])
  • $appname
static method isInstalled (line 295)

checks if there is already an application with the name $name installed on this system

  • access: public
static void isInstalled ([ $appname = ""])
  • $appname
static method readAppTOC (line 106)

reads the application toc file from webEdition/apps/toc.xml

  • access: public
static void readAppTOC ([bool $overwrite = false])
  • bool $overwrite: switch to read the toc file independently of self::$toc
static method readConfig (line 259)

loads the general configuration file from webEdition/lib/we/app/defaults/config.xml

it contains general confiruration settings for handling webEdition applications

  • access: public
static void readConfig ()
static method rebuildAppTOC (line 136)

rebuilds the application toc file from webEdition/apps/toc.xml

searches in all subdirectories of webEdition/apps/ for conf/manifest.xml and builds a new webEdition/apps/toc.xml

  • access: public
static void rebuildAppTOC ()
static method saveAppTOC (line 236)

saves the parameter $toc to the toc file used for changing single values

  • return: true/false
  • access: public
static bool saveAppTOC ([object SimpleXMLElement $toc = null])
  • object SimpleXMLElement $toc: object of the complete toc.xml file
static method setManifestAttribute (line 478)
  • access: public
static void setManifestAttribute ([ $appname = ""], [ $attribute = ""], [ $value = ""])
  • $appname
  • $attribute
  • $value
static method setManifestElement (line 458)

changes the value of a specified element from an application's manifest file (via application name)

  • access: public
  • example: example not found
static void setManifestElement ([string $appname = ""], [string $query = ""], [ $value = ""])
  • string $appname: name of the application
  • string $query: xpath query
  • $value

Documentation generated on Mon, 01 Sep 2008 11:35:35 +0200 by phpDocumentor 1.4.0