CPhpMessageSource

CPhpMessageSource represents a message source that stores translated messages in PHP scripts.

CPhpMessageSource uses PHP files and arrays to keep message translations.

• All translations are saved under the {@link basePath} directory.
• Translations in one language are kept as PHP files under an individual subdirectory whose name is the same as the language ID. Each PHP file contains messages belonging to the same category, and the file name is the same as the category name.
• Within a PHP file, an array of (source, translation) pairs is returned. For example:

  return array(
      'original message 1' => 'translated message 1',
      'original message 2' => 'translated message 2',
  );
  

When {@link cachingDuration} is set as a positive number, message translations will be cached. Messages for an extension class (e.g. a widget, a module) can be specially managed and used. In particular, if a message belongs to an extension whose class name is Xyz, then the message category can be specified in the format of 'Xyz.categoryName'. And the corresponding message file is assumed to be 'BasePath/messages/LanguageID/categoryName.php', where 'BasePath' refers to the directory that contains the extension class file. When using Yii::t() to translate an extension message, the category name should be set as 'Xyz.categoryName'.