Logging factory. More...

Collaboration diagram for ilLoggerFactory:

Public Member Functions
	initUser ($a_login)
	Init user specific log options. More...

	getSettings ()
	Get settigns. More...

	getComponentLogger ($a_component_id)
	Get component logger. More...

Static Public Member Functions
static	getInstance ()

static	newInstance (ilLoggingSettings $settings)
	get new instance More...

static	getLogger ($a_component_id)
	Get component logger. More...

static	getRootLogger ()
	The unique root logger has a fixed error level. More...

Data Fields
const	DEFAULT_FORMAT = "[%suid%] [%datetime%] %channel%.%level_name%: %message% %context% %extra%\n"

const	ROOT_LOGGER = 'root'

const	COMPONENT_ROOT = 'log_root'

const	SETUP_LOGGER = 'setup'

Protected Member Functions
	__construct (ilLoggingSettings $settings)

	isConsoleAvailable ()
	Check if console handler is available. More...

	getLoggers ()

Private Attributes
	$settings = null

	$enabled = FALSE

	$loggers = array()

Static Private Attributes
static	$instance = null

Detailed Description

Logging factory.

This class supplies an implementation for the locator. The locator will send its output to ist own frame, enabling more flexibility in the design of the desktop.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 27 of file class.ilLoggerFactory.php.

Constructor & Destructor Documentation

◆ __construct()

ilLoggerFactory::__construct ( ilLoggingSettings $settings )

protected

Definition at line 42 of file class.ilLoggerFactory.php.

References $settings, and getSettings().

         {
                 $this->settings = $settings;
                 $this->enabled = $this->getSettings()->isEnabled();
                 
         }

Here is the call graph for this function:

Member Function Documentation

◆ getComponentLogger()

ilLoggerFactory::getComponentLogger ( $a_component_id )

Get component logger.

Parameters

type $a_component_id

Returns

Definition at line 166 of file class.ilLoggerFactory.php.

References $GLOBALS, ilLogLevel\DEBUG, getSettings(), and isConsoleAvailable().

         {
                 if(isset($this->loggers[$a_component_id]))
                 {
                         return $this->loggers[$a_component_id];
                 }
                 
                 switch($a_component_id)
                 {
                         case 'root':
                                 $logger = new Logger(CLIENT_ID.'_root');
                                 break;
                                 
                         default:
                                 $logger = new Logger(CLIENT_ID.'_'.$a_component_id);
                                 break;
                                 
                 }
                 
                 if(!$this->getSettings()->isEnabled())
                 {
                         $null_handler = new NullHandler();
                         $logger->pushHandler($null_handler);
                         
                         include_once './Services/Logging/classes/class.ilComponentLogger.php';
                         return $this->loggers[$a_component_id] = new ilComponentLogger($logger);
                 }
                 
                 
                 // standard stream handler
                 $stream_handler = new StreamHandler(
                                 $this->getSettings()->getLogDir().'/'.$this->getSettings()->getLogFile(),
                                 TRUE
                 );
                 
                 if($a_component_id == self::ROOT_LOGGER)
                 {
                         $stream_handler->setLevel($this->getSettings()->getLevelByComponent(self::COMPONENT_ROOT));
                 }
                 else
                 {
                         $stream_handler->setLevel($this->getSettings()->getLevelByComponent($a_component_id));
                 }
                 
                 // format lines
                 include_once("./Services/Logging/classes/extensions/class.ilLineFormatter.php");
                 $line_formatter = new ilLineFormatter(static::DEFAULT_FORMAT, 'Y-m-d H:i:s.u',TRUE,TRUE);
                 $stream_handler->setFormatter($line_formatter);
                 
                 if($this->getSettings()->isCacheEnabled())
                 {
                         // add new finger crossed handler
                         $finger_crossed_handler = new FingersCrossedHandler(
                                         $stream_handler,
                                         new ErrorLevelActivationStrategy($this->getSettings()->getCacheLevel()),
                                         1000
                         );
                         $logger->pushHandler($finger_crossed_handler);
                 }
                 else
                 {
                         $logger->pushHandler($stream_handler);
                 }
                 
                 if($GLOBALS['ilUser'] instanceof ilObjUser)
                 {
                         if($this->getSettings()->isBrowserLogEnabledForUser($GLOBALS['ilUser']->getLogin()))
                         {
                                 if($this->isConsoleAvailable())
                                 {
                                         $browser_handler = new BrowserConsoleHandler();
                                         #$browser_handler->setLevel($this->getSettings()->getLevelByComponent($a_component_id));
                                         $browser_handler->setLevel($this->getSettings()->getLevel());
                                         $browser_handler->setFormatter($line_formatter);
                                         $logger->pushHandler($browser_handler);
                                 }
                         }
                 }
                 
 
                 // suid log
                 $logger->pushProcessor(function ($record) { 
                         $record['suid'] = substr(session_id(),0,5);
                         return $record;
                 });
 
                 // append trace 
                 include_once './Services/Logging/classes/extensions/class.ilTraceProcessor.php';
                 $logger->pushProcessor(new ilTraceProcessor(ilLogLevel::DEBUG));
                 
                                 
                 // register new logger
                 include_once './Services/Logging/classes/class.ilComponentLogger.php';
                 $this->loggers[$a_component_id] = new ilComponentLogger($logger);
                 
                 return $this->loggers[$a_component_id];
         }       

Here is the call graph for this function:

◆ getInstance()

static ilLoggerFactory::getInstance ( )

static

Returns: ilLoggerFactory

Definition at line 53 of file class.ilLoggerFactory.php.

References $settings, and ilLoggingDBSettings\getInstance().

Referenced by ilGroupAppEventListener\__construct(), ilCourseAppEventListener\__construct(), ilRbacAdmin\assignUser(), ilRbacAdmin\deassignUser(), ilGroupAppEventListener\handleUserAssignments(), ilCourseAppEventListener\handleUserAssignments(), ilInitialisation\initStyle(), and ilParticipant\updateMemberRoles().

         {
                 if(!static::$instance)
                 {
                         include_once './Services/Logging/classes/class.ilLoggingDBSettings.php';
                         $settings = ilLoggingDBSettings::getInstance();
                         static::$instance = new ilLoggerFactory($settings);
                 }
                 return static::$instance;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLogger()

static ilLoggerFactory::getLogger ( $a_component_id )

static

Get component logger.

See also: mudules.xml or service.xml

Parameters

string $a_component_id

Returns: ilLogger

Definition at line 82 of file class.ilLoggerFactory.php.

Referenced by ilMailCronOrphanedMailsDeletionProcessor\__construct(), ilMailLuceneSearcher\__construct(), ilCOPageHTMLExport\__construct(), ilWikiHTMLExport\__construct(), ilGlossaryDataSet\__construct(), ilWikiDataSet\__construct(), ilObjFileGUI\__construct(), ilImport\__construct(), ilObjFile\__construct(), ilObjLoggingSettingsGUI\__construct(), ilAdvancedMDParser\__construct(), ilStyleDataSet\__construct(), ilDataSet\__construct(), ilWikiUserHTMLExport\__construct(), ilAuthContainerLDAP\__construct(), ilPDStudyProgrammeSimpleListGUI\__construct(), ilLDAPQuery\__construct(), ilObjectCopyGUI\__construct(), ilAdvancedMDRecordParser\__construct(), ilAuthUtils\_getAuthModeOfUser(), ilAuthUtils\_initAuth(), ilDidacticTemplateLocalRoleAction\apply(), ilRbacAdmin\assignRoleToFolder(), ilMimeMail\Attach(), ilInitialisation\authenticate(), ilSearchGUI\autoComplete(), ilvCard\buildVCard(), ilObjLinkResourceGUI\callLink(), ilSoapUtils\callNextDependency(), ilSoapUtils\callNextNode(), ilContainer\cloneAllObject(), ilObjGroup\cloneAutoGeneratedRoles(), ilCourseObjectiveQuestion\cloneDependencies(), ilSoapUtils\cloneDependencies(), ilSoapUtils\cloneNode(), ilObjGroup\cloneObject(), ilAwarenessUserCollector\collectUsers(), ilDidacticTemplateGUI\confirmTemplateSwitch(), ilLORandomTestQuestionPools\copy(), ilObjectCopyGUI\copyContainer(), ilObjectCopyGUI\copyContainerToTargets(), ilObjectCopyGUI\copyMultipleNonContainer(), ilDidacticTemplateLocalPolicyAction\createLocalPolicy(), ilObjMediaObject\delete(), ilObjRole\delete(), ilPageObject\delete(), ilDidacticTemplateBlockRoleAction\deleteLocalPolicy(), ilMail\distributeMail(), ilLDAPServer\doConnectionCheck(), ilObjRoleFolderGUI\doRemoveRolePermissions(), ilRepositoryGUI\executeCommand(), ilMail\explodeRecipients(), ilAuthBase\failedLoginObserver(), ilAuthContainerMultiple\fetchData(), ilAuthContainerMDB2\fetchData(), ilChatroomServerConnector\file_get_contents(), ilLogComponentTableGUI\fillRow(), ilObjectRolePermissionTableGUI\fillRow(), ilLuceneSearchResultFilter\filter(), ilDidacticTemplateAction\filterRoles(), ilAuthContainerApache\forceCreation(), ilSkillUsage\getAllUsagesOfTemplate(), ilAuthModeDetermination\getAuthModeSequence(), ilPluginsOverviewTableGUI\getComponents(), ilLuceneAdvancedSearchFields\getFormElement(), ilAwarenessUserProviderCurrentCourse\getInitialUserSet(), ilAwarenessUserProviderMemberships\getInitialUserSet(), ilMailFormGUI\getTemplateDataById(), ilMail\getUserIds(), ilAuthContainerApache\handleLDAPDataSource(), ilWebLinkXmlParser\handlerEndTag(), ilLuceneSearcher\highlight(), ilCourseObjective\ilClone(), ilSoapUtils\ilClone(), ilSoapUtils\ilCloneDependencies(), ilContObjParser\ilContObjParser(), ilLuceneFileSearch\ilLuceneFileSearch(), ilObjContentObject\ilObjContentObject(), ilObjWikiGUI\ilObjWikiGUI(), ilPageContentGUI\ilPageContentGUI(), ilPageEditorGUI\ilPageEditorGUI(), ilPageObject\ilPageObject(), ilPageObjectGUI\ilPageObjectGUI(), ilDidacticTemplateSettingsGUI\importTemplate(), ilContainerImporter\init(), ilStyleImporter\init(), ilLearningModuleImporter\init(), ilWikiExporter\init(), ilCOPageImporter\init(), ilObjectCopyGUI\init(), ilAuthBase\initAuth(), ilObjectRolePermissionTableGUI\initColumns(), ilTree\insertNodeFromTrash(), ilRepUtil\insertSavedNodes(), ilSoapUtils\linkNode(), ilAuthBase\loginObserver(), ilAuthBase\logoutObserver(), ilStartUpGUI\migrateAccount(), ilAuthLogObserver\notify(), ilLogComponentTableGUI\parse(), ilRepositoryObjectDetailSearch\performLuceneSearch(), ilObjectSearch\performSearch(), ilLuceneSearcher\performSearch(), ilMailCronOrphanedMailsDeletionProcessor\processDeletion(), ilSystemCheckTrash\readSelectedDeleted(), ilLDAPUserSynchronisation\readUserData(), ilObjSearchSettingsGUI\refreshLuceneSettings(), ilMail\replacePlaceholders(), ilDidacticTemplateLocalPolicyAction\revertLocalPolicy(), ilObjLoggingSettingsGUI\saveComponentLevels(), ilPermissionGUI\savePermissions(), ilLPTableBaseGUI\searchObjects(), ilMailNotification\sendMail(), ilMail\sendMail(), ilRbacAdmin\setBlockedStatus(), ilFileXMLParser\setFileContents(), ilQueryParser\setMinWordLength(), ilObjectCopyGUI\showItemSelection(), ilSearchAppEventListener\storeElement(), ilLDAPUserSynchronisation\sync(), ilPermissionGUI\unblockRoles(), ilLogComponentLevel\update(), ilLuceneIndexer\updateLuceneIndex(), ilObjectCopyGUI\updateProgress(), ilDidacticTemplateExcludeFilterPattern\valid(), ilDidacticTemplateIncludeFilterPattern\valid(), ilLuceneSearchResult\valid(), ilMaterializedPathTree\validateParentRelations(), and ilNestedSetTree\validateParentRelations().

         {
                 $factory = self::getInstance();
                 return $factory->getComponentLogger($a_component_id);
         }

Here is the caller graph for this function:

◆ getLoggers()

ilLoggerFactory::getLoggers ( )

protected

Returns: ilComponentLogger[]

Definition at line 156 of file class.ilLoggerFactory.php.

References $loggers.

         {
                 return $this->loggers;
         }

◆ getRootLogger()

static ilLoggerFactory::getRootLogger ( )

static

The unique root logger has a fixed error level.

Returns: ilLogger

Definition at line 92 of file class.ilLoggerFactory.php.

Referenced by ilAssFileUploadUploadsExporter\createFileUploadCollectionZipFile(), ilECSTaskScheduler\handleEvents(), ilInitialisation\initLog(), ilInitialisation\initStyle(), and assFlashQuestion\saveAdditionalQuestionDataToDb().

         {
                 $factory = self::getInstance();
                 return $factory->getComponentLogger(self::ROOT_LOGGER);
         }

Here is the caller graph for this function:

◆ getSettings()

ilLoggerFactory::getSettings ( )

Get settigns.

Returns: ilLoggingSettings

Definition at line 147 of file class.ilLoggerFactory.php.

References $settings.

Referenced by __construct(), getComponentLogger(), and initUser().

         {
                 return $this->settings;
         }

Here is the caller graph for this function:

◆ initUser()

ilLoggerFactory::initUser ( $a_login )

Init user specific log options.

Parameters

type $a_login

Returns: boolean

Definition at line 104 of file class.ilLoggerFactory.php.

References getSettings(), and isConsoleAvailable().

         {
                 if(!$this->getSettings()->isBrowserLogEnabledForUser($a_login))
                 {
                         return TRUE;
                 }
 
                 include_once("./Services/Logging/classes/extensions/class.ilLineFormatter.php");
 
                 foreach($this->loggers as $a_component_id => $logger)
                 {
                         if($this->isConsoleAvailable())
                         {
                                 $browser_handler = new BrowserConsoleHandler();
                                 $browser_handler->setLevel($this->getSettings()->getLevelByComponent($a_component_id));
                                 $browser_handler->setFormatter(new ilLineFormatter(static::DEFAULT_FORMAT, 'Y-m-d H:i:s.u',TRUE,TRUE));
                                 $logger->getLogger()->pushHandler($browser_handler);
                         }
                 }
         }

Here is the call graph for this function:

◆ isConsoleAvailable()

ilLoggerFactory::isConsoleAvailable ( )

protected

Check if console handler is available.

Returns: boolean

Definition at line 129 of file class.ilLoggerFactory.php.

References $_GET, ilContext\CONTEXT_WEB, and ilContext\getType().

Referenced by getComponentLogger(), and initUser().

         {
                 include_once './Services/Context/classes/class.ilContext.php';
                 if(ilContext::getType() != ilContext::CONTEXT_WEB)
                 {
                         return FALSE;
                 }
                 if (isset($_GET["cmdMode"]) && $_GET["cmdMode"] == "asynch")
                 {
                         return FALSE;
                 }
                 return TRUE;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ newInstance()

static ilLoggerFactory::newInstance ( ilLoggingSettings $settings )

static

get new instance

Parameters

ilLoggingSettings $settings

Returns

Definition at line 69 of file class.ilLoggerFactory.php.

References $settings.

         {
                 return new self($settings);
         }

Field Documentation

◆ $enabled

ilLoggerFactory::$enabled = FALSE

private

Definition at line 39 of file class.ilLoggerFactory.php.

◆ $instance

ilLoggerFactory::$instance = null

staticprivate

Definition at line 35 of file class.ilLoggerFactory.php.

◆ $loggers

ilLoggerFactory::$loggers = array()

private

Definition at line 40 of file class.ilLoggerFactory.php.

Referenced by getLoggers().

◆ $settings

ilLoggerFactory::$settings = null

private

Definition at line 37 of file class.ilLoggerFactory.php.

Referenced by __construct(), getInstance(), getSettings(), and newInstance().

◆ COMPONENT_ROOT

const ilLoggerFactory::COMPONENT_ROOT = 'log_root'

Definition at line 32 of file class.ilLoggerFactory.php.

◆ DEFAULT_FORMAT

const ilLoggerFactory::DEFAULT_FORMAT = "[%suid%] [%datetime%] %channel%.%level_name%: %message% %context% %extra%\n"

Definition at line 29 of file class.ilLoggerFactory.php.

◆ ROOT_LOGGER

const ilLoggerFactory::ROOT_LOGGER = 'root'

Definition at line 31 of file class.ilLoggerFactory.php.

◆ SETUP_LOGGER

const ilLoggerFactory::SETUP_LOGGER = 'setup'

Definition at line 33 of file class.ilLoggerFactory.php.

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

Services/Logging/classes/public/class.ilLoggerFactory.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getComponentLogger()

◆ getInstance()

◆ getLogger()

◆ getLoggers()

◆ getRootLogger()

◆ getSettings()

◆ initUser()

◆ isConsoleAvailable()

◆ newInstance()

Field Documentation

◆ $enabled

◆ $instance

◆ $loggers

◆ $settings

◆ COMPONENT_ROOT

◆ DEFAULT_FORMAT

◆ ROOT_LOGGER

◆ SETUP_LOGGER