AppWebgrind Class Reference

Inheritance diagram for AppWebgrind:

Collaboration diagram for AppWebgrind:

Public Member Functions
	__construct ($id, $type)
	getConf ()
	reload ($id=null, $type=null)
	setVersion ($version)
Public Member Functions inherited from Module
	__toString ()
	getCurrentPath ()
	getId ()
	getName ()
	getRelease ()
	getRootPath ()
	getSymlinkPath ()
	getType ()
	getVersion ()
	getVersionList ()
	isEnable ()
	update ($sub=0, $showWindow=false)

Data Fields
const	LOCAL_CFG_CONF = 'webgrindConf'
const	ROOT_CFG_VERSION = 'webgrindVersion'
Data Fields inherited from Module
const	BUNDLE_RELEASE = 'bundleRelease'

Protected Member Functions
	updateConfig ($version=null, $sub=0, $showWindow=false)
Protected Member Functions inherited from Module
	__construct ()
	replace ($key, $value)
	replaceAll ($params)

Private Attributes
	$conf

Additional Inherited Members
Protected Attributes inherited from Module
	$bearsamppConf
	$bearsamppConfRaw
	$currentPath
	$enable
	$name
	$release = 'N/A'
	$rootPath
	$symlinkPath
	$version

Detailed Description

Class AppWebgrind

This class represents the Webgrind application module within the Bearsampp application. It extends the Module class and provides functionalities specific to Webgrind, such as configuration management and version handling.

Definition at line 17 of file class.app.webgrind.php.

Constructor & Destructor Documentation

__construct()

AppWebgrind::__construct	(		$id,
			$type )

Constructor for the AppWebgrind class.

Parameters

string	$id	The ID of the module.
string	$type	The type of the module.

Definition at line 40 of file class.app.webgrind.php.

                                            {
        Util::logInitClass($this);
        $this->reload($id, $type);
    }

References Module\$id, Module\$type, Util\logInitClass(), and reload().

Member Function Documentation

getConf()

AppWebgrind::getConf

(

)

Gets the path to the Webgrind configuration file.

Returns

string The path to the Webgrind configuration file.

Definition at line 130 of file class.app.webgrind.php.

                              {
        return $this->conf;
    }

References $conf.

reload()

AppWebgrind::reload	(		$id = null,
			$type = null )

Reloads the Webgrind module configuration based on the provided ID and type.

Parameters

string | null	$id	The ID of the module. If null, the current ID is used.
string | null	$type	The type of the module. If null, the current type is used.

Reimplemented from Module.

Definition at line 51 of file class.app.webgrind.php.

                                                     {
        global $bearsamppConfig, $bearsamppLang;
        Util::logReloadClass($this);
 
        $this->name = $bearsamppLang->getValue(Lang::WEBGRIND);
        $this->version = $bearsamppConfig->getRaw(self::ROOT_CFG_VERSION);
        parent::reload($id, $type);
 
        if ($this->bearsamppConfRaw !== false) {
            $this->conf = $this->symlinkPath . '/' . $this->bearsamppConfRaw[self::LOCAL_CFG_CONF];
        }
 
        if (!$this->enable) {
            Util::logInfo($this->name . ' is not enabled!');
            return;
        }
        if (!is_dir($this->currentPath)) {
            Util::logError(sprintf($bearsamppLang->getValue(Lang::ERROR_FILE_NOT_FOUND), $this->name . ' ' . $this->version, $this->currentPath));
        }
        if (!is_dir($this->symlinkPath)) {
            Util::logError(sprintf($bearsamppLang->getValue(Lang::ERROR_FILE_NOT_FOUND), $this->name . ' ' . $this->version, $this->symlinkPath));
            return;
        }
        if (!is_file($this->bearsamppConf)) {
            Util::logError(sprintf($bearsamppLang->getValue(Lang::ERROR_CONF_NOT_FOUND), $this->name . ' ' . $this->version, $this->bearsamppConf));
        }
        if (!is_file($this->conf)) {
            Util::logError(sprintf($bearsamppLang->getValue(Lang::ERROR_CONF_NOT_FOUND), $this->name . ' ' . $this->version, $this->conf));
        }
    }

References $bearsamppConfig, $bearsamppLang, Module\$id, Module\$type, Lang\ERROR_CONF_NOT_FOUND, Lang\ERROR_FILE_NOT_FOUND, LOCAL_CFG_CONF, Util\logError(), Util\logInfo(), Util\logReloadClass(), and Lang\WEBGRIND.

Referenced by __construct(), and setVersion().

Here is the caller graph for this function:

setVersion()

AppWebgrind::setVersion

(

$version

)

Sets the version of the Webgrind module.

Parameters

string

$version

The version to set.

Reimplemented from Module.

Definition at line 118 of file class.app.webgrind.php.

                                         {
        global $bearsamppConfig;
        $this->version = $version;
        $bearsamppConfig->replace(self::ROOT_CFG_VERSION, $version);
        $this->reload();
    }

References $bearsamppConfig, Module\$version, and reload().

updateConfig()

AppWebgrind::updateConfig ( $version = null, $sub = 0, $showWindow = false )

protected

Updates the Webgrind module configuration.

Parameters

string | null	$version	The version to update to. If null, the current version is used.
int	$sub	The sub-level for logging indentation.
bool	$showWindow	Whether to show a window during the update process.

Returns

bool True if the update was successful, false otherwise.

Reimplemented from Module.

Definition at line 90 of file class.app.webgrind.php.

                                                                                    {
        global $bearsamppRoot;
 
        if (!$this->enable) {
            return true;
        }
 
        $version = $version == null ? $this->version : $version;
        Util::logDebug(($sub > 0 ? str_repeat(' ', 2 * $sub) : '') . 'Update ' . $this->name . ' ' . $version . ' config');
 
        $alias = $bearsamppRoot->getAliasPath() . '/webgrind.conf';
        if (is_file($alias)) {
            Util::replaceInFile($alias, array(
                '/^Alias\s\/webgrind\s.*/' => 'Alias /webgrind "' . $this->getSymlinkPath() . '/"',
                '/^<Directory\s.*/' => '<Directory "' . $this->getSymlinkPath() . '/">',
            ));
        } else {
            Util::logError($this->getName() . ' alias not found : ' . $alias);
        }
 
        return true;
    }

References $bearsamppRoot, Module\$version, Module\getName(), Module\getSymlinkPath(), Util\logDebug(), Util\logError(), and Util\replaceInFile().

Field Documentation

$conf

AppWebgrind::$conf

private

Definition at line 32 of file class.app.webgrind.php.

Referenced by getConf().

LOCAL_CFG_CONF

const AppWebgrind::LOCAL_CFG_CONF = 'webgrindConf'

Constant for the local configuration file key.

Definition at line 27 of file class.app.webgrind.php.

Referenced by reload().

ROOT_CFG_VERSION

const AppWebgrind::ROOT_CFG_VERSION = 'webgrindVersion'

Constant for the root configuration version key.

Definition at line 22 of file class.app.webgrind.php.

---

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

• E:/Bearsampp-development/sandbox/core/classes/apps/class.app.webgrind.php