energine
[ class tree: energine ] [ index: energine ] [ all elements ]

Class: Language

Source Location: /framework/Language.class.php

Class Overview

Object
   |
   --DBWorker
      |
      --Language

Управляет языками системы.


Author(s):

  • 1m.dm

Variables

Methods


Inherited Constants

Inherited Variables

Inherited Methods

Class: DBWorker

DBWorker::__construct()
Конструктор класса.
DBWorker::dateToString()
Дата прописью Обертка над DBWorker::_dateToString
DBWorker::translate()
Нестатический метод-обёртка над DBWorker::_translate - для удобства использования внутри производных классов.
DBWorker::_dateToString()
Возвращает дату в виде строки прописью
DBWorker::_translate()
Возвращает перевод текстовой константы из таблицы переводов для указанного языка. Если язык явно не указан - используется текущий язык.

Class: Object

Object::__construct()
Пустой конструктор
Object::getConfigValue()
Нестатический метод-обёртка над Object::_getConfigValue - для удобства использования внутри производных классов.
Object::getTimer()
Возвращает значение счетчика времени выполнения.
Object::resetTimer()
Сбрасывает счетчик времени, возвращает предыдущее значение счетчика
Object::startTimer()
Запускает счетчик времени выполнения.
Object::stopTimer()
Останавливает счетчик времени выполнения.
Object::_getConfigValue()
Возвращает значение указанного параметра конфигурации.

Class Details

[line 22]
Управляет языками системы.



Tags:

author:   1m.dm
final:  


[ Top ]


Class Variables

static $instance =

[line 41]



Tags:

var:   единый для всей системы экземпляр класса Language
access:   private

Type:   Language


[ Top ]

$current =  false

[line 28]



Tags:

var:   текущий язык системы
access:   private

Type:   int


[ Top ]

$languages =

[line 34]



Tags:

var:   набор языков, определённых в системе
access:   private

Type:   array


[ Top ]



Class Methods


static method getInstance [line 72]

static Language getInstance( )

Возвращает единый для всей системы экземпляр класса Language.

См. паттерн проектирования Singleton.




Tags:

access:   public


[ Top ]

constructor __construct [line 49]

void __construct( )

Конструктор класса.



Tags:

access:   public


Overrides DBWorker::__construct() (Конструктор класса.)

[ Top ]

method getAbbrByID [line 164]

string getAbbrByID( int $id)

Возвращает аббревиатуру языка по идентификатору языка.



Tags:

access:   public


Parameters:

int   $id   идентификатор языка

[ Top ]

method getCurrent [line 85]

int getCurrent( )

Возвращает идентификатор текущего языка.



Tags:

access:   public


[ Top ]

method getDefault [line 121]

int getDefault( )

Возвращает идентификатор языка по-умолчанию.



Tags:

access:   public


[ Top ]

method getIDByAbbr [line 142]

int getIDByAbbr( string $abbr, [ $useDefaultIfEmpty = false])

Возвращает идентификатор языка по аббревиатуре азыка.



Tags:

access:   public


Parameters:

string   $abbr   аббревиатура языка
   $useDefaultIfEmpty  

[ Top ]

method getLanguages [line 205]

array getLanguages( )

Возвращает все языки, определённые в системе.



Tags:

access:   public


[ Top ]

method getNameByID [line 185]

string getNameByID( int $id)

Возвращает название языка по идентификатору языка.



Tags:

access:   public


Parameters:

int   $id  

[ Top ]

method isValidLangAbbr [line 220]

void isValidLangAbbr( $abbr)



Tags:

access:   public


Parameters:

   $abbr  

[ Top ]

method isValidLangID [line 216]

bool isValidLangID( int $id)

Проверяет, существует ли язык с указанным идентификатором.



Tags:

access:   public


Parameters:

int   $id  

[ Top ]

method setCurrent [line 96]

void setCurrent( int $currentLangID)

Устанавливает идентификатор текущнго языка.



Tags:

access:   public


Parameters:

int   $currentLangID  

[ Top ]

В создании документации нам помог: phpDocumentor