ilWOPICrawler Class Reference

Inheritance diagram for ilWOPICrawler:

Collaboration diagram for ilWOPICrawler:

Public Member Functions
	__construct ()
	getId ()
	getTitle ()
	getDescription ()
	hasAutoActivation ()
	hasFlexibleSchedule ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	run ()
Public Member Functions inherited from ILIAS\Cron\CronJob
	setDateTimeProvider (?\Closure $date_time_provider)
	isDue (?\DateTimeImmutable $last_run, ?JobScheduleType $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 (?JobScheduleType $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 ()
	usesLegacyForms ()
	getCustomConfigurationInput (\ILIAS\UI\Factory $ui_factory, \ILIAS\Refinery\Factory $factory, \ilLanguage $lng)
	addCustomSettingsToForm (\ilPropertyFormGUI $a_form)
	saveCustomConfiguration (mixed $form_data)
	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 ()

Private Attributes
ilLanguage	$language
ilSetting	$settings
Crawler	$crawler
AppRepository	$app_repository
ActionRepository	$action_repository

Additional Inherited Members
Protected Attributes inherited from ILIAS\Cron\CronJob
JobScheduleType	$schedule_type = null
int	$schedule_value = null
Closure	$date_time_provider = null

Detailed Description

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 34 of file class.ilWOPICrawler.php.

Constructor & Destructor Documentation

__construct()

ilWOPICrawler::__construct

(

)

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

References $DIC, ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ILIAS\Repository\settings().

    {
        global $DIC;
        $this->language = $DIC->language();
        $this->language->loadLanguageModule('wopi');
        $this->settings = $DIC->settings();
        $this->crawler = new Crawler();

        $this->app_repository = new AppDBRepository($DIC->database());
        $this->action_repository = new ActionDBRepository($DIC->database());
    }

Here is the call graph for this function:

Member Function Documentation

getDefaultScheduleType()

ilWOPICrawler::getDefaultScheduleType

(

)

Definition at line 79 of file class.ilWOPICrawler.php.

                                            : JobScheduleType
    {
        return JobScheduleType::WEEKLY;
    }

getDefaultScheduleValue()

ilWOPICrawler::getDefaultScheduleValue

(

)

Definition at line 84 of file class.ilWOPICrawler.php.

                                             : ?int
    {
        return 1;
    }

getDescription()

ilWOPICrawler::getDescription

(

)

Definition at line 64 of file class.ilWOPICrawler.php.

References ILIAS\UI\examples\Symbol\Glyph\Language\language().

                                    : string
    {
        return $this->language->txt('wopi_crawler_cronjob_description');
    }

Here is the call graph for this function:

getId()

ilWOPICrawler::getId

(

)

Definition at line 54 of file class.ilWOPICrawler.php.

                           : string
    {
        return 'wopi_crawler';
    }

getTitle()

ilWOPICrawler::getTitle

(

)

Definition at line 59 of file class.ilWOPICrawler.php.

References ILIAS\UI\examples\Symbol\Glyph\Language\language().

                              : string
    {
        return $this->language->txt('wopi_crawler_cronjob_title');
    }

Here is the call graph for this function:

hasAutoActivation()

ilWOPICrawler::hasAutoActivation

(

)

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

                                       : bool
    {
        return true;
    }

hasFlexibleSchedule()

ilWOPICrawler::hasFlexibleSchedule

(

)

Definition at line 74 of file class.ilWOPICrawler.php.

                                         : bool
    {
        return true;
    }

run()

ilWOPICrawler::run

(

)

Definition at line 89 of file class.ilWOPICrawler.php.

References ILIAS\UI\examples\Symbol\Glyph\Language\language(), null, and ILIAS\Repository\settings().

                         : JobResult
    {
        $result = new JobResult();
        if (!(bool) $this->settings->get('wopi_activated', '0')) {
            $result->setMessage($this->language->txt('wopi_crawler_cronjob_not_activated'));
            return $result;
        }
        $discovery_url = $this->settings->get('wopi_discovery_url');

        if (!$this->crawler->validate(new URI($discovery_url))) {
            $result->setStatus(JobResult::STATUS_FAIL);
            $result->setMessage($this->language->txt('msg_error_wopi_invalid_discorvery_url'));
            return $result;
        }

        $apps = $this->crawler->crawl(new URI($discovery_url));
        if ($apps === null) {
            $result->setStatus(JobResult::STATUS_FAIL);
            $result->setMessage($this->language->txt('wopi_crawler_cronjob_no_apps'));
            return $result;
        }
        $result->setMessage($this->language->txt('wopi_crawler_cronjob_success'));
        $this->app_repository->storeCollection($apps, $this->action_repository);

        return $result;
    }

Here is the call graph for this function:

Field Documentation

$action_repository

ActionRepository ilWOPICrawler::$action_repository

private

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

$app_repository

AppRepository ilWOPICrawler::$app_repository

private

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

$crawler

Crawler ilWOPICrawler::$crawler

private

Definition at line 38 of file class.ilWOPICrawler.php.

$language

ilLanguage ilWOPICrawler::$language

private

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

$settings

ilSetting ilWOPICrawler::$settings

private

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

---

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

• components/ILIAS/WOPI/classes/Cron/class.ilWOPICrawler.php