WebLogger Class Reference

Inheritance diagram for WebLogger:

Public Member Functions
	__construct (Filesystem $filesystem, $logFile=null)
	logSuccess ($message)
	logError (\Exception $e)
	log ($message)
	logInline ($message)
	logMeta ($message)
	get ()
	clear ()
	logfileExists ()
Public Member Functions inherited from LoggerInterface
	logError (\Exception $e)

Protected Attributes
	$logFile = 'install.log'
	$filesystem
	$directory

Detailed Description

Definition at line 18 of file WebLogger.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Filesystem	$filesystem,
			$logFile = null
	)

Constructor

Parameters

Filesystem	$filesystem
string	$logFile

Definition at line 53 of file WebLogger.php.

    {
        $this->directory = $filesystem->getDirectoryWrite(DirectoryList::LOG);
        if ($logFile) {
            $this->logFile = $logFile;
        }
    }

Member Function Documentation

clear()

clear

(

)

Clears contents of the log

Returns

void

Definition at line 133 of file WebLogger.php.

    {
        if ($this->directory->isExist($this->logFile)) {
            $this->directory->delete($this->logFile);
        }
    }

get()

get

(

)

Gets contents of the log

Returns

array

Definition at line 122 of file WebLogger.php.

    {
        $fileContents = explode(PHP_EOL, $this->directory->readFile($this->logFile));
        return $fileContents;
    }

log()

log

(

$message

)

{Logs a message

Parameters

string

$message

Returns

void

}

Implements LoggerInterface.

Definition at line 82 of file WebLogger.php.

    {
        $this->terminateLine();
        $this->writeToFile('<span class="text-info">' . $message . '</span><br>');
    }

logError()

logError

(

\Exception

$e

)

{}

Definition at line 73 of file WebLogger.php.

    {
        $this->terminateLine();
        $this->writeToFile('<span class="text-danger">[ERROR] ' . $e . '<span><br>');
    }

logfileExists()

logfileExists

(

)

Checks existence of install.log file

Returns

bool

Definition at line 145 of file WebLogger.php.

    {
        return ($this->directory->isExist($this->logFile));
    }

logInline()

logInline

(

$message

)

{Logs a message in the current line

Parameters

string

$message

Returns

void

}

Implements LoggerInterface.

Definition at line 91 of file WebLogger.php.

    {
        $this->isInline = true;
        $this->writeToFile('<span class="text-info">' . $message . '</span>');
    }

logMeta()

logMeta

(

$message

)

{Logs meta information

Parameters

string

$message

Returns

void

}

Implements LoggerInterface.

Definition at line 100 of file WebLogger.php.

    {
        $this->terminateLine();
        $this->writeToFile('<span class="hidden">' . $message . '</span><br>');
    }

logSuccess()

logSuccess

(

$message

)

{Logs success message

Parameters

string

$message

Returns

void

}

Implements LoggerInterface.

Definition at line 64 of file WebLogger.php.

    {
        $this->terminateLine();
        $this->writeToFile('<span class="text-success">[SUCCESS] ' . $message . '</span><br>');
    }

Field Documentation

$directory

$directory

protected

Definition at line 39 of file WebLogger.php.

$filesystem

$filesystem

protected

Definition at line 32 of file WebLogger.php.

$logFile

$logFile = 'install.log'

protected

Definition at line 25 of file WebLogger.php.

---

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

• vendor/magento/magento2-base/setup/src/Magento/Setup/Model/WebLogger.php