ilLuceneIndexer Class Reference

Inheritance diagram for ilLuceneIndexer:

Collaboration diagram for ilLuceneIndexer:

Public Member Functions
	__construct ()
	getId ()
	getTitle ()
	getDescription ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...
	hasFlexibleSchedule ()
	run ()
Public Member Functions inherited from ilCronJob
	setDateTimeProvider (?Closure $date_time_provider)
	isDue (?DateTimeImmutable $last_run, ?int $schedule_type, ?int $schedule_value, bool $is_manually_executed=false)
	getScheduleType ()
	Get current schedule type (if flexible) More...
	getScheduleValue ()
	Get current schedule value (if flexible) More...
	setSchedule (?int $a_type, ?int $a_value)
	Update current schedule (if flexible) More...
	getAllScheduleTypes ()
	Get all available schedule types. More...
	getScheduleTypesWithValues ()
	getValidScheduleTypes ()
	Returns a collection of all valid schedule types for a specific job. More...
	isManuallyExecutable ()
	hasCustomSettings ()
	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	saveCustomSettings (ilPropertyFormGUI $a_form)
	addToExternalSettingsForm (int $a_form_id, array &$a_fields, bool $a_is_active)
	activationWasToggled (ilDBInterface $db, ilSetting $setting, bool $a_currently_active)
	Important: This method is (also) called from the setup process, where the constructor of an ilCronJob ist NOT executed. More...
	getId ()
	getTitle ()
	getDescription ()
	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...
	hasFlexibleSchedule ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	run ()

Static Public Member Functions
static	updateLuceneIndex (array $a_obj_ids)
	Update lucene index. More...

Protected Attributes
int	$timeout = 60
ilLanguage	$lng
ilSetting	$setting
Protected Attributes inherited from ilCronJob
int	$schedule_type = null
int	$schedule_value = null
Closure	$date_time_provider = null

Additional Inherited Members
Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1
	@depracated This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_IN_MINUTES = 2
	@depracated This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_IN_HOURS = 3
	@depracated This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_IN_DAYS = 4
	@depracated This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_WEEKLY = 5
	@depracated This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_MONTHLY = 6
	@depracated This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_QUARTERLY = 7
	@depracated This will be replaced with an ENUM in ILIAS 9 More...
const	SCHEDULE_TYPE_YEARLY = 8
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

Detailed Description

Definition at line 15 of file class.ilLuceneIndexer.php.

Constructor & Destructor Documentation

__construct()

ilLuceneIndexer::__construct

(

)

Definition at line 22 of file class.ilLuceneIndexer.php.

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->setting = $DIC->settings();
    }

References $DIC, and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

getDefaultScheduleType()

ilLuceneIndexer::getDefaultScheduleType

(

)

Reimplemented from ilCronJob.

Definition at line 45 of file class.ilLuceneIndexer.php.

                                            : int
    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

getDefaultScheduleValue()

ilLuceneIndexer::getDefaultScheduleValue

(

)

Reimplemented from ilCronJob.

Definition at line 50 of file class.ilLuceneIndexer.php.

                                             : ?int
    {
        return null;
    }

getDescription()

ilLuceneIndexer::getDescription

(

)

Reimplemented from ilCronJob.

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

                                    : string
    {
        return $this->lng->txt("cron_lucene_index_info");
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getId()

ilLuceneIndexer::getId

(

)

Reimplemented from ilCronJob.

Definition at line 30 of file class.ilLuceneIndexer.php.

                           : string
    {
        return "src_lucene_indexer";
    }

getTitle()

ilLuceneIndexer::getTitle

(

)

Reimplemented from ilCronJob.

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

                              : string
    {
        return $this->lng->txt("cron_lucene_index");
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

hasAutoActivation()

ilLuceneIndexer::hasAutoActivation

(

)

Is to be activated on "installation", does only work for ILIAS core cron jobs.

Reimplemented from ilCronJob.

Definition at line 55 of file class.ilLuceneIndexer.php.

                                       : bool
    {
        return false;
    }

hasFlexibleSchedule()

ilLuceneIndexer::hasFlexibleSchedule

(

)

Reimplemented from ilCronJob.

Definition at line 60 of file class.ilLuceneIndexer.php.

                                         : bool
    {
        return true;
    }

run()

ilLuceneIndexer::run

(

)

Reimplemented from ilCronJob.

Definition at line 65 of file class.ilLuceneIndexer.php.

                         : ilCronJobResult
    {
        $status = ilCronJobResult::STATUS_NO_ACTION;
        $error_message = null;
 
        try {
            ilRpcClientFactory::factory('RPCIndexHandler', 60)->index(
                CLIENT_ID . '_' . $this->setting->get('inst_id', "0"),
                true
            );
        } catch (Exception $e) {
            $error_message = $e->getMessage();
 
            if ($e instanceof ilRpcClientException && $e->getCode() == 28) {
                ilLoggerFactory::getLogger('src')->info('Connection timed out after ' . $this->timeout . ' seconds. ' .
                    'Indexing will continoue without a proper return message. View ilServer log if you think there are problems while indexing.');
                $error_message = null;
            }
        }
 
        $result = new ilCronJobResult();
        if ($error_message) {
            // #16035 - currently no way to discern the severity of the exception
            $result->setMessage($error_message);
            $status = ilCronJobResult::STATUS_FAIL;
        } else {
            $status = ilCronJobResult::STATUS_OK;
        }
        $result->setStatus($status);
        return $result;
    }

References Vendor\Package\$e, CLIENT_ID, ilRpcClientFactory\factory(), ilLoggerFactory\getLogger(), ilCronJobResult\STATUS_FAIL, ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

Here is the call graph for this function:

updateLuceneIndex()

static ilLuceneIndexer::updateLuceneIndex ( array  $a_obj_ids )

static

Update lucene index.

Parameters

int[]

$a_obj_ids

Returns

bool

Definition at line 103 of file class.ilLuceneIndexer.php.

                                                              : bool
    {
        global $DIC;
 
        $ilSetting = $DIC['ilSetting'];
        if (!ilSearchSettings::getInstance()->isLuceneUserSearchEnabled()) {
            return false;
        }
 
        try {
            ilLoggerFactory::getLogger('src')->info('Lucene update index call BEGIN --- ');
 
            ilRpcClientFactory::factory('RPCIndexHandler', 1)->indexObjects(
                CLIENT_ID . '_' . $ilSetting->get('inst_id', "0"),
                $a_obj_ids
            );
            ilLoggerFactory::getLogger('src')->info('Lucene update index call --- END');
        } catch (Exception $e) {
            $error_message = $e->getMessage();
            ilLoggerFactory::getLogger('src')->error($error_message);
            return false;
        }
 
        return true;
    }

References $DIC, Vendor\Package\$e, $ilSetting, CLIENT_ID, ilRpcClientFactory\factory(), ilSearchSettings\getInstance(), and ilLoggerFactory\getLogger().

Referenced by ilPersonalProfileGUI\savePublicProfile().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$lng

ilLanguage ilLuceneIndexer::$lng

protected

Definition at line 19 of file class.ilLuceneIndexer.php.

$setting

ilSetting ilLuceneIndexer::$setting

protected

Definition at line 20 of file class.ilLuceneIndexer.php.

$timeout

int ilLuceneIndexer::$timeout = 60

protected

Definition at line 17 of file class.ilLuceneIndexer.php.

---

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

• Services/Search/classes/Lucene/class.ilLuceneIndexer.php