Docs For Class NCLNameCaseCore

Class NCLNameCaseCore

Description

Класс, который содержит основные константы библиотеки:

индексы мужского и женского пола
индексы всех падежей

author: Андрей Чайка <bymer3@gmail.com>
version: 0.4.1

Located in /NCL/NCLNameCaseCore.php (line 13)

NCL
   |
   --NCLNameCaseCore

Direct descendents

Class	Description
NCLNameCaseRu	Класс, который содержит основные константы библиотеки:
NCLNameCaseUa	Класс, который содержит основные константы библиотеки:

Variable Summary

array $lastResult

array $workindLastCache

string $workingWord

Method Summary

void fullReset ()

int genderAutoDetect ()

mixed getFatherNameCase ([int $number = null])

mixed getFirstNameCase ([int $number = null])

string getFormatted ([ $caseNum = 0], [string $format = "S N F"])

array getFormattedArray (string $format)

array getFormattedArrayHard (array $format)

string getFormattedHard ([ $caseNum = 0], [array $format = array()])

mixed getSecondNameCase ([int $number = null])

bool in (string $letter, mixed $string)

void inNames (string $nameNeedle, array $names)

string Last ([int $length = 1], [int $stopAfter = 0])

mixed q (string $fullname, [int $caseNum = null], [int $gender = null])

mixed qFatherName (string $fatherName, [int $CaseNumber = null], [int $gender = 0])

mixed qFirstName (string $firstName, [int $CaseNumber = null], [int $gender = 0])

mixed qFullName ([string $secondName = ""], [string $firstName = ""], [string $fatherName = ""], [int $gender = 0], [int $caseNum = 0], [string $format = "S N F"])

mixed qSecondName (string $secondName, [int $CaseNumber = null], [int $gender = 0])

void Rule (int $index)

boolean RulesChain (string $gender, array $rulesArray)

void setFatherName ([string $fathername = ""])

void setFirstName ([string $firstname = ""])

void setFullName ([string $secondName = ""], [string $firstName = ""], [string $fatherName = ""])

void setGender ([int $gender = 0])

void setLastName ([string $secondname = ""])

void setName ([string $firstname = ""])

void setSecondName ([string $secondname = ""])

void setSirName ([string $secondname = ""])

void setWorkingWord (string $word)

string splitFullName (string $fullname)

void wordForms (string $word, array $endings, [int $replaceLast = 0])

Variables

array $lastResult = array() (line 61)

Массив содержит результат склонения слова - слово во всех падежах

access: protected

array $workindLastCache = array() (line 49)

Метод Last() вырезает подстроки разной длины. Посколько одинаковых вызовов бывает несколько, то все результаты выполнения кешируются в этом массиве.

access: protected

string $workingWord = '' (line 42)

Переменная, в которую заносится слово с которым сейчас идет работа

access: protected

Inherited Variables

Inherited from NCL

NCL::$DATELN
NCL::$IMENITLN
NCL::$MAN
NCL::$PREDLOGN
NCL::$RODITLN
NCL::$TVORITELN
NCL::$UaDavalnyi
NCL::$UaKlychnyi
NCL::$UaMiszevyi
NCL::$UaNazyvnyi
NCL::$UaOrudnyi
NCL::$UaRodovyi
NCL::$UaZnahidnyi
NCL::$VINITELN
NCL::$WOMAN

Methods

fullReset (line 85)

Сбрасывает все информацию на начальную. Очищает все слова добавленые в систему.

После выполнения система готова работать с начала.

access: public

void fullReset ()

genderAutoDetect (line 475)

По указаным словам определяется пол человека:

0 - не определено
NCL::$MAN - мужчина
NCL::$WOMAN - женщина

return: текущий пол человека
access: public

int genderAutoDetect ()

getFatherNameCase (line 666)

Функция ставит отчество в нужный падеж.

Если указан номер падежа $number, тогда возвращается строка с таким номером падежа, если нет, тогда возвращается массив со всеми падежами текущего слова.

return: массив или строка с нужным падежом
access: public

mixed getFatherNameCase ([int $number = null])

int $number: номер падежа

getFirstNameCase (line 636)

Функция ставит имя в нужный падеж.

return: массив или строка с нужным падежом
access: public

mixed getFirstNameCase ([int $number = null])

int $number: номер падежа

getFormatted (line 903)

Склоняет текущие слова в падеж $caseNum и форматирует слово по шаблону $format

Формат:

S - Фамилия
N - Имя
F - Отчество

return: строка в нужном падеже
access: public

string getFormatted ([ $caseNum = 0], [string $format = "S N F"])

string $format: строка с форматом
$caseNum

getFormattedArray (line 746)

Склоняет текущие слова во все падежи и форматирует слово по шаблону $format

Формат:

S - Фамилия
N - Имя
F - Отчество

return: массив со всеми падежами
access: public

array getFormattedArray (string $format)

string $format: строка формат

getFormattedArrayHard (line 810)

Склоняет текущие слова во все падежи и форматирует слово по шаблону $format

Формат:

S - Фамилия
N - Имя
F - Отчество

return: массив со всеми падежами
access: public

array getFormattedArrayHard (array $format)

array $format: массив с форматом

getFormattedHard (line 869)

Склоняет текущие слова в падеж $caseNum и форматирует слово по шаблону $format

Формат:

S - Фамилия
N - Имя
F - Отчество

return: строка в нужном падеже
access: public

string getFormattedHard ([ $caseNum = 0], [array $format = array()])

array $format: массив с форматом
$caseNum

getSecondNameCase (line 651)

Функция ставит фамилию в нужный падеж.

return: массив или строка с нужным падежом
access: public

mixed getSecondNameCase ([int $number = null])

int $number: номер падежа

in (line 180)

Если $string строка, тогда проверяется входит ли буква $letter в строку $string

Если $string массив, тогда проверяется входит ли строка $letter в массив $string

return: true если искомое значение найдено
access: protected

bool in (string $letter, mixed $string)

string $letter: буква или строка, которую нужно искать
mixed $string: строка или массив, в котором нужно искать

inNames (line 205)

Функция проверяет, входит ли имя $nameNeedle в перечень имен $names.

access: protected

void inNames (string $nameNeedle, array $names)

string $nameNeedle: - имя которое нужно найти
array $names: - перечень имен в котором нужно найти имя

Last (line 133)

Если $stopAfter = 0, тогда вырезает $length последних букв с текущего слова ($this->workingWord)

Если нет, тогда вырезает $stopAfter букв начиная от $length с конца

return: требуемая подстрока
access: protected

string Last ([int $length = 1], [int $stopAfter = 0])

int $length: количество букв с конца
int $stopAfter: количество букв которые нужно вырезать (0 - все)

q (line 980)

Склоняет ФИО $fullname в падеж $caseNum по правилам пола $gender.

Возвращает результат в таком же формате, как он и был.

return: либо массив со всеми падежами, либо строка
access: public

mixed q (string $fullname, [int $caseNum = null], [int $gender = null])

string $fullname: ФИО
int $caseNum: номер падежа
int $gender: пол человека

qFatherName (line 726)

Функция ставит отчество $fatherName в нужный падеж $CaseNumber по правилам пола $gender.

Если указан номер падежа $CaseNumber, тогда возвращается строка с таким номером падежа, если нет, тогда возвращается массив со всеми падежами текущего слова.

return: массив или строка с нужным падежом
access: public

mixed qFatherName (string $fatherName, [int $CaseNumber = null], [int $gender = 0])

string $fatherName: отчество, которое нужно просклонять
int $CaseNumber: номер падежа
int $gender: пол, который нужно использовать

qFirstName (line 683)

Функция ставит имя $firstName в нужный падеж $CaseNumber по правилам пола $gender.

return: массив или строка с нужным падежом
access: public

mixed qFirstName (string $firstName, [int $CaseNumber = null], [int $gender = 0])

string $firstName: имя, которое нужно просклонять
int $CaseNumber: номер падежа
int $gender: пол, который нужно использовать

qFullName (line 958)

Склоняет фамилию $secondName, имя $firstName, отчество $fatherName

в падеж $caseNum по правилам пола $gender и форматирует результат по шаблону $format Формат:

S - Фамилия
N - Имя
F - Отчество

return: либо массив со всеми падежами, либо строка
access: public

mixed qFullName ([string $secondName = ""], [string $firstName = ""], [string $fatherName = ""], [int $gender = 0], [int $caseNum = 0], [string $format = "S N F"])

string $secondName: фамилия
string $firstName: имя
string $fatherName: отчество
int $gender: пол
int $caseNum: номер падежа
string $format: формат

qSecondName (line 704)

Функция ставит фамилию $secondName в нужный падеж $CaseNumber по правилам пола $gender.

return: массив или строка с нужным падежом
access: public

mixed qSecondName (string $secondName, [int $CaseNumber = null], [int $gender = 0])

string $secondName: фамилия, которую нужно просклонять
int $CaseNumber: номер падежа
int $gender: пол, который нужно использовать

Rule (line 106)

Устанавливает номер последнего правила

access: protected

void Rule (int $index)

int $index: номер правила которое нужно установить

RulesChain (line 160)

Над текущим словом ($this->workingWord) выполняются правила в порядке указаном в $rulesArray.

$gender служит для указания какие правила использовать мужские ('man') или женские ('woman')

return: если правило было задествовано, тогда true, если нет - тогда false
access: protected

boolean RulesChain (string $gender, array $rulesArray)

string $gender: - префикс мужских/женских правил
array $rulesArray: - массив, порядок выполнения правил

setFatherName (line 282)

В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord

со словом $fathername и пометкой, что это отчество

access: public

void setFatherName ([string $fathername = ""])

string $fathername: отчество

setFirstName (line 250)

В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord

со словом $firstname и пометкой, что это имя

access: public

void setFirstName ([string $firstname = ""])

string $firstname: имя

setFullName (line 314)

В система заносится сразу фамилия, имя, отчество

access: public

void setFullName ([string $secondName = ""], [string $firstName = ""], [string $fatherName = ""])

string $secondName: фамилия
string $firstName: имя
string $fatherName: отчество

setGender (line 300)

Всем словам устанавливается пол, который может иметь следующие значения

0 - не определено
NCL::$MAN - мужчина
NCL::$WOMAN - женщина

access: public

void setGender ([int $gender = 0])

int $gender: пол, который нужно установить

setLastName (line 336)

В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord

со словом $secondname и пометкой, что это фамилия

access: public

void setLastName ([string $secondname = ""])

string $secondname: фамилия

setName (line 326)

В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord

со словом $firstname и пометкой, что это имя

access: public

void setName ([string $firstname = ""])

string $firstname: имя

setSecondName (line 266)

В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord

со словом $secondname и пометкой, что это фамилия

access: public

void setSecondName ([string $secondname = ""])

string $secondname: фамилия

setSirName (line 346)

В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord

со словом $secondname и пометкой, что это фамилия

access: public

void setSirName ([string $secondname = ""])

string $secondname: фамилия

setWorkingWord (line 116)

Устанавливает слово текущим для работы системы. Очищает кеш слова.

access: protected

void setWorkingWord (string $word)

string $word: слово, которое нужно установить

splitFullName (line 494)

Разбивает строку $fullname на слова и возвращает формат в котором записано имя

Формат:

S - Фамилия
N - Имя
F - Отчество

return: формат в котором записано имя например 'N F S'
access: public

string splitFullName (string $fullname)

string $fullname: строка, для которой необходимо определить формат

wordForms (line 229)

Склоняет слово $word, удаляя из него $replaceLast последних букв и добавляя в каждый падеж окончание из массива $endings.

access: protected

void wordForms (string $word, array $endings, [int $replaceLast = 0])

string $word: слово, к которому нужно добавить окончания
array $endings: массив окончаний
int $replaceLast: сколько последних букв нужно убрать с начального слова

Documentation generated on Wed, 06 Jul 2011 13:46:17 +0300 by phpDocumentor 1.4.3