CrontabManager Class Reference

Inheritance diagram for CrontabManager:

Public Member Functions
	__construct (ShellInterface $shell, Filesystem $filesystem)
	getTasks ()
	saveTasks (array $tasks)
	removeTasks ()

Additional Inherited Members
Data Fields inherited from CrontabManagerInterface
const	TASKS_BLOCK_START = '#~ MAGENTO START'
const	TASKS_BLOCK_END = '#~ MAGENTO END'

Detailed Description

Manager works with cron tasks

Definition at line 18 of file CrontabManager.php.

Constructor & Destructor Documentation

__construct()

__construct	(	ShellInterface	$shell,
		Filesystem	$filesystem
	)

Parameters

ShellInterface	$shell
Filesystem	$filesystem

Definition at line 34 of file CrontabManager.php.

      {
        $this->shell = $shell;
        $this->filesystem = $filesystem;
    }

Member Function Documentation

getTasks()

getTasks

(

)

{#- Get list of Magento Tasks

Returns

array

Exceptions

LocalizedException

}

Implements CrontabManagerInterface.

Definition at line 69 of file CrontabManager.php.

    {
        $this->checkSupportedOs();
        $content = $this->getCrontabContent();
        $pattern = '!(' . $this->getTasksBlockStart() . ')(.*?)(' . $this->getTasksBlockEnd() . ')!s';

        if (preg_match($pattern, $content, $matches)) {
            $tasks = trim($matches[2], PHP_EOL);
            $tasks = explode(PHP_EOL, $tasks);
            return $tasks;
        }

        return [];
    }

removeTasks()

removeTasks

(

)

{Remove Magento Tasks form crontab

Returns

void

Exceptions

LocalizedException

}

Exceptions

LocalizedException

Implements CrontabManagerInterface.

Definition at line 124 of file CrontabManager.php.

    {
        $this->checkSupportedOs();
        $content = $this->getCrontabContent();
        $content = $this->cleanMagentoSection($content);
        $this->save($content);
    }

saveTasks()

saveTasks

(

array

$tasks

)

{Save Magento Tasks to crontab

Parameters

array

$tasks

Returns

void

Exceptions

LocalizedException

}

Implements CrontabManagerInterface.

Definition at line 87 of file CrontabManager.php.

    {
        if (!$tasks) {
            throw new LocalizedException(new Phrase('The list of tasks is empty. Add tasks and try again.'));
        }

        $this->checkSupportedOs();
        $baseDir = $this->filesystem->getDirectoryRead(DirectoryList::ROOT)->getAbsolutePath();
        $logDir = $this->filesystem->getDirectoryRead(DirectoryList::LOG)->getAbsolutePath();

        foreach ($tasks as $key => $task) {
            if (empty($task['expression'])) {
                $tasks[$key]['expression'] = '* * * * *';
            }

            if (empty($task['command'])) {
                throw new LocalizedException(new Phrase("The command shouldn't be empty. Enter and try again."));
            }

            $tasks[$key]['command'] = str_replace(
                ['{magentoRoot}', '{magentoLog}'],
                [$baseDir, $logDir],
                $task['command']
            );
        }

        $content = $this->getCrontabContent();
        $content = $this->cleanMagentoSection($content);
        $content = $this->generateSection($content, $tasks);

        $this->save($content);
    }

---

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

• vendor/magento/framework/Crontab/CrontabManager.php