Inheritance diagram for ilUpdateNewAccountMailTemplatesForMustache:

Collaboration diagram for ilUpdateNewAccountMailTemplatesForMustache:

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
	getNextLangToBeUpdated ()

	getWhere ()

	replace (string $lang, string $regex_search, string $replacement)

	replaceRemainingBrackets (string $lang)

	replaceInText (?string $text, string $regex_search, string $replacement)

Protected Attributes
ilDBInterface	$db

Detailed Description

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

Member Function Documentation

◆ getDefaultAmountOfStepsPerRun()

ilUpdateNewAccountMailTemplatesForMustache::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.ilUpdateNewAccountMailTemplatesForMustache.php.

                                                    : int
     {
         return self::NUMBER_OF_STEPS;
     }

◆ getLabel()

ilUpdateNewAccountMailTemplatesForMustache::getLabel ( )

Returns: string - a meaningful and concise description for your migration.

Implements ILIAS\Setup\Migration.

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

                               : string
     {
         return 'ilUpdateNewAccountMailTemplatesForMustache';
     }

◆ getNextLangToBeUpdated()

ilUpdateNewAccountMailTemplatesForMustache::getNextLangToBeUpdated ( )

protected

Definition at line 75 of file class.ilUpdateNewAccountMailTemplatesForMustache.php.

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

Referenced by step().

                                                : ?string
     {
         $this->db->setLimit(1);
         $q = 'SELECT lang FROM mail_template ' . PHP_EOL . $this->getWhere();
         $res = $this->db->query($q);
 
         if ($this->db->numRows($res) === 0) {
             return null;
         }
 
         $row = $this->db->fetchAssoc($res);
 
         return $row['lang'];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPreconditions()

ilUpdateNewAccountMailTemplatesForMustache::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.ilUpdateNewAccountMailTemplatesForMustache.php.

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

◆ getRemainingAmountOfSteps()

ilUpdateNewAccountMailTemplatesForMustache::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 66 of file class.ilUpdateNewAccountMailTemplatesForMustache.php.

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

                                                : int
     {
         $q = 'SELECT COUNT(*) AS open FROM mail_template ' . 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()

ilUpdateNewAccountMailTemplatesForMustache::getWhere ( )

protected

Definition at line 90 of file class.ilUpdateNewAccountMailTemplatesForMustache.php.

References ilDBConstants\T_TEXT.

Referenced by getNextLangToBeUpdated(), and getRemainingAmountOfSteps().

                                  : string
     {
         return ' WHERE (' . PHP_EOL
             . $this->db->like('body', ilDBConstants::T_TEXT, '%[%') . ' OR ' . PHP_EOL
             . $this->db->like('body', ilDBConstants::T_TEXT, '%]%') . ' OR ' . PHP_EOL
             . $this->db->like('subject', ilDBConstants::T_TEXT, '%[%') . ' OR ' . PHP_EOL
             . $this->db->like('subject', ilDBConstants::T_TEXT, '%]%') . PHP_EOL
             . ') AND type = ' . $this->db->quote('nacc', ilDBConstants::T_TEXT);
     }

Here is the caller graph for this function:

◆ prepare()

ilUpdateNewAccountMailTemplatesForMustache::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.ilUpdateNewAccountMailTemplatesForMustache.php.

References ILIAS\Setup\Environment\getResource().

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

Here is the call graph for this function:

◆ replace()

ilUpdateNewAccountMailTemplatesForMustache::replace	(	string	$lang,
		string	$regex_search,
		string	$replacement
	)

protected

Definition at line 100 of file class.ilUpdateNewAccountMailTemplatesForMustache.php.

References $res, replaceInText(), and ilDBConstants\T_TEXT.

Referenced by step().

                                                                                        : void
     {
         $res = $this->db->queryF(
             'SELECT subject, body FROM mail_template WHERE lang = %s AND type = %s',
             [ilDBConstants::T_TEXT, ilDBConstants::T_TEXT],
             [$lang, 'nacc']
         );
         if ($this->db->numRows($res) === 1) {
             $row = $this->db->fetchAssoc($res);
 
             $subject = $this->replaceInText(
                 $row['subject'],
                 $regex_search,
                 $replacement
             );
             $body = $this->replaceInText(
                 $row['body'],
                 $regex_search,
                 $replacement
             );
 
             $this->db->manipulateF(
                 'UPDATE mail_template SET subject = %s, body = %s WHERE lang = %s AND type = %s',
                 [ilDBConstants::T_TEXT, ilDBConstants::T_TEXT, ilDBConstants::T_TEXT, ilDBConstants::T_TEXT],
                 [$subject, $body, $lang, 'nacc']
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ replaceInText()

ilUpdateNewAccountMailTemplatesForMustache::replaceInText	(	?string	$text,
		string	$regex_search,
		string	$replacement
	)

protected

Definition at line 158 of file class.ilUpdateNewAccountMailTemplatesForMustache.php.

Referenced by replace(), and replaceRemainingBrackets().

      : ?string {
         if ($text === null) {
             return null;
         }
 
         return preg_replace(
             $regex_search,
             $replacement,
             $text
         );
     }

Here is the caller graph for this function:

◆ replaceRemainingBrackets()

ilUpdateNewAccountMailTemplatesForMustache::replaceRemainingBrackets ( string $lang )

protected

Definition at line 129 of file class.ilUpdateNewAccountMailTemplatesForMustache.php.

References $res, replaceInText(), and ilDBConstants\T_TEXT.

Referenced by step().

                                                              : void
     {
         $res = $this->db->queryF(
             'SELECT subject, body FROM mail_template WHERE lang = %s AND type = %s',
             [ilDBConstants::T_TEXT, ilDBConstants::T_TEXT],
             [$lang, 'nacc']
         );
         if ($this->db->numRows($res) === 1) {
             $row = $this->db->fetchAssoc($res);
 
             $subject = $this->replaceInText(
                 $row['subject'],
                 '/\[([A-Z_\/]+?)\]/',
                 '{{$1}}'
             );
             $body = $this->replaceInText(
                 $row['body'],
                 '/\[([A-Z_\/]+?)\]/',
                 '{{$1}}'
             );
 
             $this->db->manipulateF(
                 'UPDATE mail_template SET subject = %s, body = %s WHERE lang = %s AND type = %s',
                 [ilDBConstants::T_TEXT, ilDBConstants::T_TEXT, ilDBConstants::T_TEXT, ilDBConstants::T_TEXT],
                 [$subject, $body, $lang, 'nacc']
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ step()

ilUpdateNewAccountMailTemplatesForMustache::step ( Environment $environment )

Run one step of the migration.

Implements ILIAS\Setup\Migration.

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

References $lang, getNextLangToBeUpdated(), replace(), and replaceRemainingBrackets().

                                                   : void
     {
         $lang = $this->getNextLangToBeUpdated();
         if ($lang === null) {
             return;
         }
 
         $this->replace($lang, '/\[IF_PASSWORD\]/', '{{#IF_PASSWORD}}');
         $this->replace($lang, '/\[IF_NO_PASSWORD\]/', '{{#IF_NO_PASSWORD}}');
         $this->replace($lang, '/\[IF_TARGET\]/', '{{#IF_TARGET}}');
         $this->replace($lang, '/\[IF_TIMELIMIT\]/', '{{#IF_TIMELIMIT}}');
         $this->replaceRemainingBrackets($lang);
     }

Here is the call graph for this function:

Field Documentation

◆ $db

ilDBInterface ilUpdateNewAccountMailTemplatesForMustache::$db

protected

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

◆ NUMBER_OF_STEPS

const ilUpdateNewAccountMailTemplatesForMustache::NUMBER_OF_STEPS = 10000

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

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

Services/User/classes/Setup/Migration/class.ilUpdateNewAccountMailTemplatesForMustache.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ getDefaultAmountOfStepsPerRun()

◆ getLabel()

◆ getNextLangToBeUpdated()

◆ getPreconditions()

◆ getRemainingAmountOfSteps()

◆ getWhere()

◆ prepare()

◆ replace()

◆ replaceInText()

◆ replaceRemainingBrackets()

◆ step()

Field Documentation

◆ $db

◆ NUMBER_OF_STEPS