ilCronManagerTableFilterMediator Class Reference

Class ilCronManagerTableFilterMediator. More...

Collaboration diagram for ilCronManagerTableFilterMediator:

Public Member Functions
	__construct (ilCronJobCollection $repository, Factory $uiFactory, ilUIService $uiService, ilLanguage $lng)
	ilCronManagerTableFilterMediator constructor. More...
	filter (string $action)
	filteredJobs (Standard $filter)

Private Attributes
const	FILTER_PROPERTY_NAME_TITLE = 'title'
const	FILTER_PROPERTY_NAME_COMPONENT = 'component'
const	FILTER_PROPERTY_NAME_SCHEDULE = 'schedule'
const	FILTER_PROPERTY_NAME_STATUS = 'status'
const	FILTER_PROPERTY_NAME_RESULT = 'result'
const	FILTER_STATUS_ACTIVE = 1
const	FILTER_STATUS_INACTIVE = 2
	$items
	$uiFactory
	$uiService
	$lng

Detailed Description

Class ilCronManagerTableFilterMediator.

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 12 of file class.ilCronManagerTableFilterMediator.php.

Constructor & Destructor Documentation

__construct()

ilCronManagerTableFilterMediator::__construct	(	ilCronJobCollection	$repository,
		Factory	$uiFactory,
		ilUIService	$uiService,
		ilLanguage	$lng
	)

ilCronManagerTableFilterMediator constructor.

Parameters

ilCronJobCollection	$repository
Factory	$uiFactory
ilUIService	$uiService
ilLanguage	$lng

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

References $lng, $uiFactory, and $uiService.

      {
        $this->items = $repository;
        $this->uiFactory = $uiFactory;
        $this->uiService = $uiService;
        $this->lng = $lng;
    }

Member Function Documentation

filter()

ilCronManagerTableFilterMediator::filter

(

string

$action

)

Parameters

string

$action

Returns

Standard

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

References $result, ilCronJobEntity\getComponent(), ilCronJobEntity\isPlugin(), ilCronJob\SCHEDULE_TYPE_DAILY, ilCronJob\SCHEDULE_TYPE_IN_DAYS, ilCronJob\SCHEDULE_TYPE_IN_HOURS, ilCronJob\SCHEDULE_TYPE_IN_MINUTES, ilCronJob\SCHEDULE_TYPE_MONTHLY, ilCronJob\SCHEDULE_TYPE_QUARTERLY, ilCronJob\SCHEDULE_TYPE_WEEKLY, ilCronJob\SCHEDULE_TYPE_YEARLY, ilCronJobResult\STATUS_CRASHED, ilCronJobResult\STATUS_FAIL, ilCronJobResult\STATUS_INVALID_CONFIGURATION, ilCronJobResult\STATUS_NO_ACTION, ilCronJobResult\STATUS_OK, and ilCronJobResult\STATUS_RESET.

                                           : Standard
    {
        $componentOptions = array_unique(array_map(function (ilCronJobEntity $entity) : string {
            if ($entity->isPlugin()) {
                return $this->lng->txt('cmps_plugin') . '/' . $entity->getComponent();
            }

            return $entity->getComponent();
        }, $this->items->toArray()));
        asort($componentOptions);

        $title = $this->uiFactory->input()->field()->text($this->lng->txt('title'));
        $components = $this->uiFactory->input()->field()->select(
            $this->lng->txt('cron_component'),
            array_combine($componentOptions, $componentOptions)
        );
        $schedule = $this->uiFactory->input()->field()->select(
            $this->lng->txt('cron_schedule'),
            [
                ilCronJob::SCHEDULE_TYPE_DAILY => $this->lng->txt('cron_schedule_daily'),
                ilCronJob::SCHEDULE_TYPE_WEEKLY => $this->lng->txt('cron_schedule_weekly'),
                ilCronJob::SCHEDULE_TYPE_MONTHLY => $this->lng->txt('cron_schedule_monthly'),
                ilCronJob::SCHEDULE_TYPE_QUARTERLY => $this->lng->txt('cron_schedule_quarterly'),
                ilCronJob::SCHEDULE_TYPE_YEARLY => $this->lng->txt('cron_schedule_yearly'),
                ilCronJob::SCHEDULE_TYPE_IN_MINUTES => sprintf($this->lng->txt('cron_schedule_in_minutes'), 'x'),
                ilCronJob::SCHEDULE_TYPE_IN_HOURS => sprintf($this->lng->txt('cron_schedule_in_hours'), 'x'),
                ilCronJob::SCHEDULE_TYPE_IN_DAYS => sprintf($this->lng->txt('cron_schedule_in_days'), 'x')
            ]
        );
        $status = $this->uiFactory->input()->field()->select(
            $this->lng->txt('cron_status'),
            [
                self::FILTER_STATUS_ACTIVE => $this->lng->txt('cron_status_active'),
                self::FILTER_STATUS_INACTIVE => $this->lng->txt('cron_status_inactive'),
            ]
        );
        $result = $this->uiFactory->input()->field()->select(
            $this->lng->txt('cron_result'),
            [
                ilCronJobResult::STATUS_INVALID_CONFIGURATION => $this->lng->txt(
                    'cron_result_status_invalid_configuration'
                ),
                ilCronJobResult::STATUS_NO_ACTION => $this->lng->txt(
                    'cron_result_status_no_action'
                ),
                ilCronJobResult::STATUS_OK => $this->lng->txt(
                    'cron_result_status_ok'
                ),
                ilCronJobResult::STATUS_CRASHED => $this->lng->txt(
                    'cron_result_status_crashed'
                ),
                ilCronJobResult::STATUS_RESET => $this->lng->txt(
                    'cron_result_status_reset'
                ),
                ilCronJobResult::STATUS_FAIL => $this->lng->txt(
                    'cron_result_status_fail'
                ),
            ]
        );

        $fields = [
            self::FILTER_PROPERTY_NAME_TITLE => $title,
            self::FILTER_PROPERTY_NAME_COMPONENT => $components,
            self::FILTER_PROPERTY_NAME_SCHEDULE => $schedule,
            self::FILTER_PROPERTY_NAME_STATUS => $status,
            self::FILTER_PROPERTY_NAME_RESULT => $result,
        ];

        $filter = $this->uiService->filter()->standard(
            'cron_job_adm_table',
            $action,
            $fields,
            array_fill(0, count($fields), true),
            true,
            true
        );

        return $filter;
    }

Here is the call graph for this function:

filteredJobs()

ilCronManagerTableFilterMediator::filteredJobs

(

Standard

$filter

)

Parameters

Standard

$filter

Returns

ilCronJobCollection

Definition at line 139 of file class.ilCronManagerTableFilterMediator.php.

References ilCronJobCollection\filter(), ilCronJobEntity\getComponent(), ilCronJobEntity\getEffectiveScheduleType(), ilCronJobEntity\getEffectiveTitle(), ilCronJobEntity\getJobResultStatus(), ilCronJobEntity\getJobStatus(), ilCronJobEntity\isPlugin(), and ilStr\strIPos().

                                                   : ilCronJobCollection
    {
        $filterValues = $this->uiService->filter()->getData($filter);

        return $this->items->filter(function (ilCronJobEntity $entity) use ($filterValues) : bool {
            if (
                isset($filterValues[self::FILTER_PROPERTY_NAME_TITLE]) &&
                is_string($filterValues[self::FILTER_PROPERTY_NAME_TITLE]) &&
                strlen($filterValues[self::FILTER_PROPERTY_NAME_TITLE]) > 0
            ) {
                $titleFilterValue = $filterValues[self::FILTER_PROPERTY_NAME_TITLE];
                if (ilStr::strIPos($entity->getEffectiveTitle(), $titleFilterValue) === false) {
                    return false;
                }
            }

            if (
                isset($filterValues[self::FILTER_PROPERTY_NAME_COMPONENT]) &&
                is_string($filterValues[self::FILTER_PROPERTY_NAME_COMPONENT]) &&
                strlen($filterValues[self::FILTER_PROPERTY_NAME_COMPONENT]) > 0
            ) {
                $component = $entity->getComponent();
                if ($entity->isPlugin()) {
                    $component = $this->lng->txt('cmps_plugin') . '/' . $component;
                }

                if ($filterValues[self::FILTER_PROPERTY_NAME_COMPONENT] !== $component) {
                    return false;
                }
            }

            if (
                isset($filterValues[self::FILTER_PROPERTY_NAME_SCHEDULE]) &&
                is_string($filterValues[self::FILTER_PROPERTY_NAME_SCHEDULE]) &&
                strlen($filterValues[self::FILTER_PROPERTY_NAME_SCHEDULE]) > 0
            ) {
                if ((int) $filterValues[self::FILTER_PROPERTY_NAME_SCHEDULE] !== $entity->getEffectiveScheduleType()) {
                    return false;
                }
            }

            if (
                isset($filterValues[self::FILTER_PROPERTY_NAME_STATUS]) &&
                is_string($filterValues[self::FILTER_PROPERTY_NAME_STATUS]) &&
                strlen($filterValues[self::FILTER_PROPERTY_NAME_STATUS]) > 0
            ) {
                if (
                    (int) $filterValues[self::FILTER_PROPERTY_NAME_STATUS] === self::FILTER_STATUS_ACTIVE &&
                    !$entity->getJobStatus()
                ) {
                    return false;
                } elseif (
                    (int) $filterValues[self::FILTER_PROPERTY_NAME_STATUS] === self::FILTER_STATUS_INACTIVE &&
                    $entity->getJobStatus()
                ) {
                    return false;
                }
            }

            if (
                isset($filterValues[self::FILTER_PROPERTY_NAME_RESULT]) &&
                is_string($filterValues[self::FILTER_PROPERTY_NAME_RESULT]) &&
                strlen($filterValues[self::FILTER_PROPERTY_NAME_RESULT]) > 0
            ) {
                if ((int) $filterValues[self::FILTER_PROPERTY_NAME_RESULT] !== $entity->getJobResultStatus()) {
                    return false;
                }
            }

            return true;
        });
    }

Here is the call graph for this function:

Field Documentation

$items

ilCronManagerTableFilterMediator::$items

private

Definition at line 24 of file class.ilCronManagerTableFilterMediator.php.

$lng

ilCronManagerTableFilterMediator::$lng

private

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

Referenced by __construct().

$uiFactory

ilCronManagerTableFilterMediator::$uiFactory

private

Definition at line 26 of file class.ilCronManagerTableFilterMediator.php.

Referenced by __construct().

$uiService

ilCronManagerTableFilterMediator::$uiService

private

Definition at line 28 of file class.ilCronManagerTableFilterMediator.php.

Referenced by __construct().

FILTER_PROPERTY_NAME_COMPONENT

const ilCronManagerTableFilterMediator::FILTER_PROPERTY_NAME_COMPONENT = 'component'

private

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

FILTER_PROPERTY_NAME_RESULT

const ilCronManagerTableFilterMediator::FILTER_PROPERTY_NAME_RESULT = 'result'

private

Definition at line 18 of file class.ilCronManagerTableFilterMediator.php.

FILTER_PROPERTY_NAME_SCHEDULE

const ilCronManagerTableFilterMediator::FILTER_PROPERTY_NAME_SCHEDULE = 'schedule'

private

Definition at line 16 of file class.ilCronManagerTableFilterMediator.php.

FILTER_PROPERTY_NAME_STATUS

const ilCronManagerTableFilterMediator::FILTER_PROPERTY_NAME_STATUS = 'status'

private

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

FILTER_PROPERTY_NAME_TITLE

const ilCronManagerTableFilterMediator::FILTER_PROPERTY_NAME_TITLE = 'title'

private

Definition at line 14 of file class.ilCronManagerTableFilterMediator.php.

FILTER_STATUS_ACTIVE

const ilCronManagerTableFilterMediator::FILTER_STATUS_ACTIVE = 1

private

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

FILTER_STATUS_INACTIVE

const ilCronManagerTableFilterMediator::FILTER_STATUS_INACTIVE = 2

private

Definition at line 21 of file class.ilCronManagerTableFilterMediator.php.

---

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

• Services/Cron/classes/class.ilCronManagerTableFilterMediator.php