ilLuceneIndexer Class Reference

Inheritance diagram for ilLuceneIndexer:

Collaboration diagram for ilLuceneIndexer:

Public Member Functions
	getId ()
	Get id. More...
	getTitle ()
	Get title. More...
	getDescription ()
	Get description. More...
	getDefaultScheduleType ()
	Get schedule type. More...
	getDefaultScheduleValue ()
	Get schedule value. More...
	hasAutoActivation ()
	Is to be activated on "installation". More...
	hasFlexibleSchedule ()
	Can the schedule be configured? More...
	run ()
	Run job. More...
Public Member Functions inherited from ilCronJob
	isActive ($a_ts_last_run, $a_schedule_type, $a_schedule_value, $a_manual=false)
	Is job currently active? More...
	getScheduleType ()
	Get current schedule type (if flexible) More...
	getScheduleValue ()
	Get current schedule value (if flexible) More...
	setSchedule ($a_type, $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...
	getTitle ()
	Get title. More...
	getDescription ()
	Get description. More...
	isManuallyExecutable ()
	Defines whether or not a cron job can be started manually. More...
	hasCustomSettings ()
	Has cron job any custom setting which can be edited? More...
	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	Add custom settings to form. More...
	saveCustomSettings (ilPropertyFormGUI $a_form)
	Save custom settings. More...
	addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active)
	Add external settings to form. More...
	activationWasToggled ($a_currently_active)
	Cron job status was changed. More...
	getId ()
	Get id. More...
	hasAutoActivation ()
	Is to be activated on "installation". More...
	hasFlexibleSchedule ()
	Can the schedule be configured? More...
	getDefaultScheduleType ()
	Get schedule type. More...
	getDefaultScheduleValue ()
	Get schedule value. More...
	run ()
	Run job. More...

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

Protected Attributes
	$timeout = 60

Additional Inherited Members
Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1
const	SCHEDULE_TYPE_IN_MINUTES = 2
const	SCHEDULE_TYPE_IN_HOURS = 3
const	SCHEDULE_TYPE_IN_DAYS = 4
const	SCHEDULE_TYPE_WEEKLY = 5
const	SCHEDULE_TYPE_MONTHLY = 6
const	SCHEDULE_TYPE_QUARTERLY = 7
const	SCHEDULE_TYPE_YEARLY = 8
Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

Detailed Description

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

Member Function Documentation

getDefaultScheduleType()

ilLuceneIndexer::getDefaultScheduleType

(

)

Get schedule type.

Returns

int

Reimplemented from ilCronJob.

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

    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

getDefaultScheduleValue()

ilLuceneIndexer::getDefaultScheduleValue

(

)

Get schedule value.

Returns

int|array

Reimplemented from ilCronJob.

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

    {
        return;
    }

getDescription()

ilLuceneIndexer::getDescription

(

)

Get description.

Returns

string

Reimplemented from ilCronJob.

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

    {
        global $DIC;
 
        $lng = $DIC['lng'];
        
        return $lng->txt("cron_lucene_index_info");
    }

References $DIC, and $lng.

getId()

ilLuceneIndexer::getId

(

)

Get id.

Returns

string

Reimplemented from ilCronJob.

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

    {
        return "src_lucene_indexer";
    }

getTitle()

ilLuceneIndexer::getTitle

(

)

Get title.

Returns

string

Reimplemented from ilCronJob.

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

    {
        global $DIC;
 
        $lng = $DIC['lng'];
        
        return $lng->txt("cron_lucene_index");
    }

References $DIC, and $lng.

hasAutoActivation()

ilLuceneIndexer::hasAutoActivation

(

)

Is to be activated on "installation".

Returns

boolean

Reimplemented from ilCronJob.

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

    {
        return false;
    }

hasFlexibleSchedule()

ilLuceneIndexer::hasFlexibleSchedule

(

)

Can the schedule be configured?

Returns

boolean

Reimplemented from ilCronJob.

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

    {
        return true;
    }

run()

ilLuceneIndexer::run

(

)

Run job.

Returns

ilCronJobResult

Reimplemented from ilCronJob.

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

    {
        global $DIC;
 
        $ilSetting = $DIC['ilSetting'];
        
        $status = ilCronJobResult::STATUS_NO_ACTION;
        $error_message = null;
        
        try {
            include_once './Services/WebServices/RPC/classes/class.ilRpcClientFactory.php';
            ilRpcClientFactory::factory('RPCIndexHandler', 60)->index(
                CLIENT_ID . '_' . $ilSetting->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 $DIC, Vendor\Package\$e, $ilSetting, $result, 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 (   $a_obj_ids )

static

Update lucene index.

Parameters

int[]

$a_obj_ids

Returns

bool

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

    {
        global $DIC;
 
        $ilSetting = $DIC['ilSetting'];
        include_once './Services/Search/classes/class.ilSearchSettings.php';
        if (!ilSearchSettings::getInstance()->isLuceneUserSearchEnabled()) {
            return false;
        }
        
        try {
            ilLoggerFactory::getLogger('src')->info('Lucene update index call BEGIN --- ');
 
            include_once './Services/WebServices/RPC/classes/class.ilRpcClientFactory.php';
            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\saveProfile(), and ilPersonalProfileGUI\savePublicProfile().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$timeout

ilLuceneIndexer::$timeout = 60

protected

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

---

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

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