phpDocumentor

ModuleTitleProvider
in package

Class ModuleTitleProvider

Tags
category

System

Table of Contents

$language  : LanguageTextManager
$type  : string
getStrippedTagsTitle()  : string
Returns the module title value.
getTitle()  : string
Returns the title of a module module.
title()  : mixed
_getLanguageTextManager()  : LanguageTextManager
Returns the language text manager instance.
_validateLanguageDirectoryArgument()  : mixed
Validates the language directory argument.
_validateMethodNameArgument()  : mixed
Validates the method name argument.

Properties

Methods

getStrippedTagsTitle()

Returns the module title value.

public static getStrippedTagsTitle(string $methodName[, string $languageDirectory = '' ]) : string

The value gets manipulated by the strip_tags and trim functions.

Parameters
$methodName : string

Name of module method.

$languageDirectory : string = ''

Path to language directory.

Return values
string

Stripped module title.

getTitle()

Returns the title of a module module.

public static getTitle(string $methodName[, string $languageDirectory = '' ]) : string
Parameters
$methodName : string

Name of module method.

$languageDirectory : string = ''

Path to language directory.

Return values
string

Module title.

title()

public title(mixed $methodName[, mixed $languageDirectory = '' ]) : mixed
Parameters
$methodName : mixed
$languageDirectory : mixed = ''
Return values
mixed

_getLanguageTextManager()

Returns the language text manager instance.

protected static _getLanguageTextManager() : LanguageTextManager
Return values
LanguageTextManager

_validateLanguageDirectoryArgument()

Validates the language directory argument.

protected static _validateLanguageDirectoryArgument(string &$languageDirectory) : mixed

The referenced value gets manipulated by the basename and trim functions.

Parameters
$languageDirectory : string

Path of language directory.

Return values
mixed

_validateMethodNameArgument()

Validates the method name argument.

protected static _validateMethodNameArgument(string &$methodName) : mixed

The referenced value gets manipulated by the basename and trim functions.

Parameters
$methodName : string

Name of module method.

Return values
mixed

Search results