Docs For Class NCLNameCaseCore

Class NCLNameCaseCore

Description

NCL NameCase Core

Набор основных функций, который позволяют сделать интерфейс слонения русского и украниского языка абсолютно одинаковым. Содержит все функции для внешнего взаимодействия с библиотекой.

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

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

NCL
   |
   --NCLNameCaseCore

Direct descendents

Class	Description
NCLNameCaseRu	NCL NameCase Russian Language
NCLNameCaseUa	NCL NameCase Ukranian Language

Variable Summary

array $lastResult

array $workindLastCache

string $workingWord

Method Summary

void detectNamePart (NCLNameCaseWord $word)

NCLNameCaseCore fullReset ()

int genderAutoDetect ()

void GenderByFatherName (NCLNameCaseWord $word)

void GenderByFirstName (NCLNameCaseWord $word)

void GenderBySecondName (NCLNameCaseWord $word)

int genderDetect (string $fullname)

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()])

string getFullNameFormat (string $fullname)

mixed getSecondNameCase ([int $number = null])

array getWordsArray ()

bool in (string $letter, mixed $string)

void inNames (string $nameNeedle, array $names)

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

boolean manFatherName ()

boolean manFirstName ()

boolean manSecondName ()

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)

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

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

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

NCLNameCaseCore setGender ([int $gender = 0])

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

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

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

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

void setWorkingWord (string $word)

boolean womanFatherName ()

boolean womanFirstName ()

boolean womanSecondName ()

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

Variables

array $lastResult = array() (line 71)

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

access: protected

array $workindLastCache = array() (line 61)

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

access: protected

string $workingWord = '' (line 55)

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

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

detectNamePart (line 1094)

Идетифицирует слово определяе имя это, или фамилия, или отчество

N - имя
S - фамилия
F - отчество

access: protected

void detectNamePart (NCLNameCaseWord $word)

NCLNameCaseWord $word: обьект класса слов, который необходимо идентифицировать

Redefined in descendants as:

NCLNameCaseRu::detectNamePart() : Идетифицирует слово определяе имя это, или фамилия, или отчество
NCLNameCaseUa::detectNamePart() : Ідентифікує слово визначаючи чи це ім’я, чи це прізвище, чи це побатькові

fullReset (line 95)

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

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

access: public

NCLNameCaseCore fullReset ()

genderAutoDetect (line 498)

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

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

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

int genderAutoDetect ()

GenderByFatherName (line 1082)

Определение пола по правилам отчеств

access: protected

void GenderByFatherName (NCLNameCaseWord $word)

NCLNameCaseWord $word: обьект класса слов, для которого нужно определить пол

Redefined in descendants as:

NCLNameCaseRu::GenderByFatherName() : Определение пола по правилам отчеств
NCLNameCaseUa::GenderByFatherName() : Визначення статі, за правилами по-батькові

GenderByFirstName (line 1064)

Определение пола по правилам имен

access: protected

void GenderByFirstName (NCLNameCaseWord $word)

NCLNameCaseWord $word: обьект класса слов, для которого нужно определить пол

Redefined in descendants as:

NCLNameCaseRu::GenderByFirstName() : Определение пола по правилам имен
NCLNameCaseUa::GenderByFirstName() : Визначення статі, за правилами імені

GenderBySecondName (line 1073)

Определение пола по правилам фамилий

access: protected

void GenderBySecondName (NCLNameCaseWord $word)

NCLNameCaseWord $word: обьект класса слов, для которого нужно определить пол

Redefined in descendants as:

NCLNameCaseRu::GenderBySecondName() : Определение пола по правилам фамилий
NCLNameCaseUa::GenderBySecondName() : Визначення статі, за правилами прізвища

genderDetect (line 990)

Определяет пол человека по ФИО

return: пол человека
access: public

int genderDetect (string $fullname)

string $fullname: ФИО

getFatherNameCase (line 713)

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

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

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

mixed getFatherNameCase ([int $number = null])

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

getFirstNameCase (line 683)

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

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

mixed getFirstNameCase ([int $number = null])

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

getFormatted (line 895)

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

Формат:

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

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

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

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

getFormattedArray (line 793)

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

Формат:

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

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

array getFormattedArray (string $format)

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

getFormattedArrayHard (line 844)

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

Формат:

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

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

array getFormattedArrayHard (array $format)

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

getFormattedHard (line 875)

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

Формат:

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

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

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

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

getFullNameFormat (line 548)

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

Формат:

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

return: формат в котором записано имя
access: public

string getFullNameFormat (string $fullname)

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

getSecondNameCase (line 698)

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

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

mixed getSecondNameCase ([int $number = null])

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

getWordsArray (line 1001)

Возвращает внутренний массив $this->words каждая запись имеет тип NCLNameCaseWord

return: Массив всех слов в системе
access: public

array getWordsArray ()

in (line 190)

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

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

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

bool in (string $letter, mixed $string)

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

inNames (line 215)

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

access: protected

void inNames (string $nameNeedle, array $names)

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

Last (line 143)

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

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

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

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

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

manFatherName (line 1046)

Функция склоняет мужский отчества

return: true - если слово было успешно изменено, false - если не получилось этого сделать
access: protected

boolean manFatherName ()

Redefined in descendants as:

NCLNameCaseRu::manFatherName() : Функция склоняет мужский отчества
NCLNameCaseUa::manFatherName() : Фунція відмінює чоловічі по-батькові

manFirstName (line 1010)

Функция пытается применить цепочку правил для мужских имен

return: true - если было использовано правило из списка, false - если правило не было найденым
access: protected

boolean manFirstName ()

Redefined in descendants as:

NCLNameCaseRu::manFirstName() : Функция пытается применить цепочку правил для мужских имен
NCLNameCaseUa::manFirstName() : Функція намагається застосувати ланцюг правил для чоловічих імен

manSecondName (line 1028)

Функция пытается применить цепочку правил для мужских фамилий

return: true - если было использовано правило из списка, false - если правило не было найденым
access: protected

boolean manSecondName ()

Redefined in descendants as:

NCLNameCaseRu::manSecondName() : Функция пытается применить цепочку правил для мужских фамилий
NCLNameCaseUa::manSecondName() : Функція намагається застосувати ланцюг правил для чоловічих прізвищ

q (line 973)

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

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

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

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

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

qFatherName (line 773)

Функция ставит отчество $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 730)

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

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

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

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

qFullName (line 951)

Склоняет фамилию $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 751)

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

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

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

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

Rule (line 117)

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

access: protected

void Rule (int $index)

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

RulesChain (line 170)

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

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

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

boolean RulesChain (string $gender, array $rulesArray)

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

setFatherName (line 297)

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

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

access: public

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

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

setFirstName (line 261)

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

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

access: public

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

string $firstname: имя

setFullName (line 333)

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

access: public

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

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

setGender (line 317)

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

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

access: public

NCLNameCaseCore setGender ([int $gender = 0])

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

setLastName (line 358)

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

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

access: public

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

string $secondname: фамилия

setName (line 347)

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

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

access: public

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

string $firstname: имя

setSecondName (line 279)

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

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

access: public

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

string $secondname: фамилия

setSirName (line 369)

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

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

access: public

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

string $secondname: фамилия

setWorkingWord (line 126)

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

access: protected

void setWorkingWord (string $word)

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

womanFatherName (line 1055)

Функция склоняет женские отчества

return: true - если слово было успешно изменено, false - если не получилось этого сделать
access: protected

boolean womanFatherName ()

Redefined in descendants as:

NCLNameCaseRu::womanFatherName() : Функция склоняет женские отчества
NCLNameCaseUa::womanFatherName() : Фунція відмінює жіночі по-батькові

womanFirstName (line 1019)

Функция пытается применить цепочку правил для женских имен

return: true - если было использовано правило из списка, false - если правило не было найденым
access: protected

boolean womanFirstName ()

Redefined in descendants as:

NCLNameCaseRu::womanFirstName() : Функция пытается применить цепочку правил для женских имен
NCLNameCaseUa::womanFirstName() : Функція намагається застосувати ланцюг правил для жіночих імен

womanSecondName (line 1037)

Функция пытается применить цепочку правил для женских фамилий

return: true - если было использовано правило из списка, false - если правило не было найденым
access: protected

boolean womanSecondName ()

Redefined in descendants as:

NCLNameCaseRu::womanSecondName() : Функция пытается применить цепочку правил для женских фамилий
NCLNameCaseUa::womanSecondName() : Функція намагається застосувати ланцюг правил для жіночих прізвищ

wordForms (line 239)

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

access: protected

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

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

Documentation generated on Sat, 09 Jul 2011 17:55:19 +0300 by phpDocumentor 1.4.3