PhpMessageSource

Type
Class
Namespace
Craft
Inherits
Craft\PhpMessageSource » CPhpMessageSource » CMessageSource » CApplicationComponent » CComponent
Implements
IApplicationComponent
Since
1.0

Class PhpMessageSource

See also http://craftcms.com

View source

Public Properties

PropertyDescription
$basePathstring – The base path for all translated messages.
$behaviorsarray – The behaviors that should be attached to this component.
$cacheIDstring – The ID of the cache application component that is used to cache the messages.
$cachingDurationinteger – The time in seconds that the messages can remain valid in cache.
$extensionPathsarray – The message paths for extensions that do not have a base class to use as category prefix.
$forceTranslationboolean

$forceTranslation

Signature

public boolean $forceTranslation = true

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__unset()Sets a component property to be null.
asa()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()Evaluates a PHP expression or callback under the context of this component.
getEventHandlers()Returns the list of attached event handlers for an event.
getIsInitialized()Checks if this application component has been initialized.
getLanguage()
hasEvent()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
init()
onMissingTranslation()Raised when a message cannot be translated.
raiseEvent()Raises an event.
setLanguage()
translate()Translates a message to the specified language.

init()

Signature

public void init ( )

Protected Methods

MethodDescription
getMessageFile()Determines the message file name based on the given category and language.
loadMessages()Loads the message translation for the specified language and category.
translateMessage()Translates the specified message.

loadMessages()

Loads the message translation for the specified language and category.

View source

Arguments

  • $category (string) – The message category
  • $language (string) – The target locale

Returns

array – The loaded messages

Signature

protected array loadMessages ( $category, $language )

Constants

ConstantDescription
CACHE_KEY_PREFIX