ilUpdateMailTemplatesForMustache Class Reference

Inheritance diagram for ilUpdateMailTemplatesForMustache:

Collaboration diagram for ilUpdateMailTemplatesForMustache:

Public Member Functions
	getLabel ()
	getDefaultAmountOfStepsPerRun ()
	Tell the default amount of steps to be executed for one run of the migration. More...
	getPreconditions (Environment $environment)
	Objectives the migration depend on. More...
	prepare (Environment $environment)
	Prepare the migration by means of some environment. More...
	step (Environment $environment)
	Run one step of the migration. More...
	getRemainingAmountOfSteps ()
	Count up how many "things" need to be migrated. More...

Data Fields
const	NUMBER_OF_STEPS = 10000
Data Fields inherited from ILIAS\Setup\Migration
const	INFINITE = -1

Protected Member Functions
	getNextTemplateToBeUpdated ()
	getWhere ()
	replace (int $tpl_id, string $lang)

Protected Attributes
ilDBInterface	$db

Detailed Description

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

Member Function Documentation

getDefaultAmountOfStepsPerRun()

ilUpdateMailTemplatesForMustache::getDefaultAmountOfStepsPerRun

(

)

Tell the default amount of steps to be executed for one run of the migration.

Return Migration::INFINITE if all units should be migrated at once.

Implements ILIAS\Setup\Migration.

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

                                                   : int
    {
        return self::NUMBER_OF_STEPS;
    }

getLabel()

ilUpdateMailTemplatesForMustache::getLabel

(

)

Returns

string - a meaningful and concise description for your migration.

Implements ILIAS\Setup\Migration.

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

                              : string
    {
        return 'ilUpdateMailTemplatesForMustache';
    }

getNextTemplateToBeUpdated()

ilUpdateMailTemplatesForMustache::getNextTemplateToBeUpdated ( )

protected

Returns

array{0: int, 1: string}|null

Definition at line 76 of file class.ilUpdateMailTemplatesForMustache.php.

References $q, $res, getWhere(), and ILIAS\Repository\int().

Referenced by step().

                                                   : ?array
    {
        $this->db->setLimit(1);
        $q = 'SELECT tpl_id, lang FROM mail_man_tpl ' . PHP_EOL . $this->getWhere();
        $res = $this->db->query($q);

        if ($this->db->numRows($res) === 0) {
            return null;
        }

        $row = $this->db->fetchAssoc($res);

        return [
            (int) $row['tpl_id'],
            $row['lang']
        ];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPreconditions()

ilUpdateMailTemplatesForMustache::getPreconditions

(

Environment

$environment

)

Objectives the migration depend on.

Exceptions

UnachievableException

if the objective is not achievable

Returns

Objective[]

Implements ILIAS\Setup\Migration.

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

                                                              : array
    {
        return [
            new \ilDatabaseUpdatedObjective()
        ];
    }

getRemainingAmountOfSteps()

ilUpdateMailTemplatesForMustache::getRemainingAmountOfSteps

(

)

Count up how many "things" need to be migrated.

This helps the admin to decide how big he can create the steps and also how long a migration takes

Implements ILIAS\Setup\Migration.

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

References $q, $res, and getWhere().

                                               : int
    {
        $q = 'SELECT COUNT(tpl_id) AS open FROM mail_man_tpl ' . PHP_EOL . $this->getWhere();
        $res = $this->db->query($q);
        $row = $this->db->fetchAssoc($res);

        return (int) $row['open'];
    }

Here is the call graph for this function:

getWhere()

ilUpdateMailTemplatesForMustache::getWhere ( )

protected

Definition at line 94 of file class.ilUpdateMailTemplatesForMustache.php.

Referenced by getNextTemplateToBeUpdated(), and getRemainingAmountOfSteps().

                                 : string
    {
        return " WHERE (m_subject REGEXP '\[[A-Z_]+?\]' OR m_message REGEXP '\[[A-Z_]+?\]')" . PHP_EOL;
    }

Here is the caller graph for this function:

prepare()

ilUpdateMailTemplatesForMustache::prepare

(

Environment

$environment

)

Prepare the migration by means of some environment.

This is not supposed to modify the environment, but will be run to prime the migration object to run step and getRemainingAmountOfSteps afterwards.

Implements ILIAS\Setup\Migration.

Definition at line 47 of file class.ilUpdateMailTemplatesForMustache.php.

References ILIAS\Setup\Environment\getResource().

                                                     : void
    {
        $this->db = $environment->getResource(Environment::RESOURCE_DATABASE);
    }

Here is the call graph for this function:

replace()

ilUpdateMailTemplatesForMustache::replace ( int  $tpl_id, string  $lang  )

protected

Definition at line 99 of file class.ilUpdateMailTemplatesForMustache.php.

References $message, $res, ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by step().

                                                         : void
    {
        $res = $this->db->queryF(
            'SELECT m_subject, m_message FROM mail_man_tpl WHERE tpl_id = %s AND lang = %s',
            [ilDBConstants::T_INTEGER, ilDBConstants::T_TEXT],
            [$tpl_id, $lang]
        );
        if ($this->db->numRows($res) === 1) {
            $row = $this->db->fetchAssoc($res);

            $subject = isset($row['m_subject']) ? preg_replace(
                '/\[([A-Z_]+?)\]/',
                '{{$1}}',
                $row['m_subject']
            ) : null;
            $message = isset($row['m_message']) ? preg_replace(
                '/\[([A-Z_]+?)\]/',
                '{{$1}}',
                $row['m_message']
            ) : null;

            $this->db->manipulateF(
                'UPDATE mail_man_tpl SET m_subject = %s, m_message = %s WHERE tpl_id = %s AND lang = %s',
                [ilDBConstants::T_TEXT, ilDBConstants::T_TEXT, ilDBConstants::T_INTEGER, ilDBConstants::T_TEXT],
                [$subject, $message, $tpl_id, $lang]
            );
        }
    }

Here is the caller graph for this function:

step()

ilUpdateMailTemplatesForMustache::step

(

Environment

$environment

)

Run one step of the migration.

Implements ILIAS\Setup\Migration.

Definition at line 52 of file class.ilUpdateMailTemplatesForMustache.php.

References $lang, getNextTemplateToBeUpdated(), and replace().

                                                  : void
    {
        $tpl_values = $this->getNextTemplateToBeUpdated();
        if ($tpl_values === null) {
            return;
        }

        [$tpl_id, $lang] = $tpl_values;

        $this->replace($tpl_id, $lang);
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilUpdateMailTemplatesForMustache::$db

protected

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

NUMBER_OF_STEPS

const ilUpdateMailTemplatesForMustache::NUMBER_OF_STEPS = 10000

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

---

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

• Services/Mail/classes/Setup/Migration/class.ilUpdateMailTemplatesForMustache.php