diff --git a/Docs/NameCaseLib/NCL.html b/Docs/NameCaseLib/NCL.html new file mode 100644 index 0000000..288a2ac --- /dev/null +++ b/Docs/NameCaseLib/NCL.html @@ -0,0 +1,445 @@ + + + + + + Docs For Class NCL + + + + +
+

Class NCL

+ + +
+
Description
+ +
+ +

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

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

+ +

+ Located in /NCL/NCL.php (line 16) +

+ + +

+	
+			
+
+ + +
+
Direct descendents
+ +
+ + + + + + + + + +
ClassDescription
NCLNameCaseCore + NCL NameCase Core +
+
+
+ + + +
+
Variable Summary
+ +
+
+
+ static mixed + $DATELN +
+
+ static mixed + $IMENITLN +
+
+ static mixed + $MAN +
+
+ static mixed + $PREDLOGN +
+
+ static mixed + $RODITLN +
+
+ static mixed + $TVORITELN +
+
+ static mixed + $UaDavalnyi +
+
+ static mixed + $UaKlychnyi +
+
+ static mixed + $UaMiszevyi +
+
+ static mixed + $UaNazyvnyi +
+
+ static mixed + $UaOrudnyi +
+
+ static mixed + $UaRodovyi +
+
+ static mixed + $UaZnahidnyi +
+
+ static mixed + $VINITELN +
+
+ static mixed + $WOMAN +
+
+
+
+ + + +
+
Variables
+ +
+ +
+ +
+ + static mixed + $DATELN + = 2 (line 46) + +
+ + +

Дательный падеж

+ + + + + +
+ +
+ +
+ + static mixed + $IMENITLN + = 0 (line 34) + +
+ + +

Именительный падеж

+ + + + + +
+ +
+ +
+ + static mixed + $MAN + = 1 (line 22) + +
+ + +

Мужской пол

+ + + + + +
+ +
+ +
+ + static mixed + $PREDLOGN + = 5 (line 64) + +
+ + +

Предложный падеж

+ + + + + +
+ +
+ +
+ + static mixed + $RODITLN + = 1 (line 40) + +
+ + +

Родительный падеж

+ + + + + +
+ +
+ +
+ + static mixed + $TVORITELN + = 4 (line 58) + +
+ + +

Творительный падеж

+ + + + + +
+ +
+ +
+ + static mixed + $UaDavalnyi + = 2 (line 82) + +
+ + +

Давальний відмінок

+ + + + + +
+ +
+ +
+ + static mixed + $UaKlychnyi + = 6 (line 106) + +
+ + +

Кличний відмінок

+ + + + + +
+ +
+ +
+ + static mixed + $UaMiszevyi + = 5 (line 100) + +
+ + +

Місцевий відмінок

+ + + + + +
+ +
+ +
+ + static mixed + $UaNazyvnyi + = 0 (line 70) + +
+ + +

Назвиний відмінок

+ + + + + +
+ +
+ +
+ + static mixed + $UaOrudnyi + = 4 (line 94) + +
+ + +

Орудний відмінок

+ + + + + +
+ +
+ +
+ + static mixed + $UaRodovyi + = 1 (line 76) + +
+ + +

Родовий відмінок

+ + + + + +
+ +
+ +
+ + static mixed + $UaZnahidnyi + = 3 (line 88) + +
+ + +

Знахідний відмінок

+ + + + + +
+ +
+ +
+ + static mixed + $VINITELN + = 3 (line 52) + +
+ + +

Винительный падеж

+ + + + + +
+ +
+ +
+ + static mixed + $WOMAN + = 2 (line 28) + +
+ + +

Женский пол

+ + + + + +
+ +
+
+ + + +

+ Documentation generated on Wed, 06 Jul 2011 14:04:07 +0300 by phpDocumentor 1.4.3 +

+
+ \ No newline at end of file diff --git a/Docs/NameCaseLib/NCLNameCaseCore.html b/Docs/NameCaseLib/NCLNameCaseCore.html new file mode 100644 index 0000000..c51f123 --- /dev/null +++ b/Docs/NameCaseLib/NCLNameCaseCore.html @@ -0,0 +1,1401 @@ + + + + + + Docs For Class NCLNameCaseCore + + + + +
+

Class NCLNameCaseCore

+ + +
+
Description
+ +
+ +

NCL NameCase Core

+

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

+ +

+ Located in /NCL/NCLNameCaseCore.php (line 32) +

+ + +
NCL
+   |
+   --NCLNameCaseCore
+ +
+
+ + +
+
Direct descendents
+ +
+ + + + + + + + + + + + + +
ClassDescription
NCLNameCaseRu + NCL NameCase Russian Language +
NCLNameCaseUa + NCL NameCase Ukranian Language +
+
+
+ + + +
+
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 80) + +
+ + +

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

+
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + array + $workindLastCache + = array() (line 68) + +
+ + +

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

+
    +
  • access: protected
  • +
+ + + + + +
+ +
+ +
+ + string + $workingWord + = '' (line 61) + +
+ + +

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

+
    +
  • 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 104) +
+ + +

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

+

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

+
    +
  • access: public
  • +
+ +
+ void + + fullReset + + () +
+ + + +
+ +
+ +
+ genderAutoDetect (line 494) +
+ + +

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

+

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

+
    +
  • return: текущий пол человека
  • +
  • access: public
  • +
+ +
+ int + + genderAutoDetect + + () +
+ + + +
+ +
+ +
+ getFatherNameCase (line 685) +
+ + +

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

+

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

+
    +
  • return: массив или строка с нужным падежом
  • +
  • access: public
  • +
+ +
+ mixed + + getFatherNameCase + + ([int $number = null]) +
+ +
    +
  • + int + $number: номер падежа
  • +
+ + +
+ +
+ +
+ getFirstNameCase (line 655) +
+ + +

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

+

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

+
    +
  • return: массив или строка с нужным падежом
  • +
  • access: public
  • +
+ +
+ mixed + + getFirstNameCase + + ([int $number = null]) +
+ +
    +
  • + int + $number: номер падежа
  • +
+ + +
+ +
+ +
+ getFormatted (line 922) +
+ + +

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

+

Формат:

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

+
    +
  • return: строка в нужном падеже
  • +
  • access: public
  • +
+ +
+ string + + getFormatted + + ([ $caseNum = 0], [string $format = "S N F"]) +
+ +
    +
  • + string + $format: строка с форматом
  • +
  • + + $caseNum
  • +
+ + +
+ +
+ +
+ getFormattedArray (line 765) +
+ + +

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

+

Формат:

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

+
    +
  • return: массив со всеми падежами
  • +
  • access: public
  • +
+ +
+ array + + getFormattedArray + + (string $format) +
+ +
    +
  • + string + $format: строка формат
  • +
+ + +
+ +
+ +
+ getFormattedArrayHard (line 829) +
+ + +

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

+

Формат:

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

+
    +
  • return: массив со всеми падежами
  • +
  • access: public
  • +
+ +
+ array + + getFormattedArrayHard + + (array $format) +
+ +
    +
  • + array + $format: массив с форматом
  • +
+ + +
+ +
+ +
+ getFormattedHard (line 888) +
+ + +

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

+

Формат:

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

+
    +
  • return: строка в нужном падеже
  • +
  • access: public
  • +
+ +
+ string + + getFormattedHard + + ([ $caseNum = 0], [array $format = array()]) +
+ +
    +
  • + array + $format: массив с форматом
  • +
  • + + $caseNum
  • +
+ + +
+ +
+ +
+ getSecondNameCase (line 670) +
+ + +

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

+

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

+
    +
  • return: массив или строка с нужным падежом
  • +
  • access: public
  • +
+ +
+ mixed + + getSecondNameCase + + ([int $number = null]) +
+ +
    +
  • + int + $number: номер падежа
  • +
+ + +
+ +
+ +
+ in (line 199) +
+ + +

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

+

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

+
    +
  • return: true если искомое значение найдено
  • +
  • access: protected
  • +
+ +
+ bool + + in + + (string $letter, mixed $string) +
+ +
    +
  • + string + $letter: буква или строка, которую нужно искать
  • +
  • + mixed + $string: строка или массив, в котором нужно искать
  • +
+ + +
+ +
+ +
+ inNames (line 224) +
+ + +

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

+
    +
  • access: protected
  • +
+ +
+ void + + inNames + + (string $nameNeedle, array $names) +
+ +
    +
  • + string + $nameNeedle: - имя которое нужно найти
  • +
  • + array + $names: - перечень имен в котором нужно найти имя
  • +
+ + +
+ +
+ +
+ Last (line 152) +
+ + +

Если $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 999) +
+ + +

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

+

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

+
    +
  • return: либо массив со всеми падежами, либо строка
  • +
  • access: public
  • +
+ +
+ mixed + + q + + (string $fullname, [int $caseNum = null], [int $gender = null]) +
+ +
    +
  • + string + $fullname: ФИО
  • +
  • + int + $caseNum: номер падежа
  • +
  • + int + $gender: пол человека
  • +
+ + +
+ +
+ +
+ qFatherName (line 745) +
+ + +

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

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

+

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

+
    +
  • return: массив или строка с нужным падежом
  • +
  • access: public
  • +
+ +
+ mixed + + qFirstName + + (string $firstName, [int $CaseNumber = null], [int $gender = 0]) +
+ +
    +
  • + string + $firstName: имя, которое нужно просклонять
  • +
  • + int + $CaseNumber: номер падежа
  • +
  • + int + $gender: пол, который нужно использовать
  • +
+ + +
+ +
+ +
+ qFullName (line 977) +
+ + +

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

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

+

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

+
    +
  • return: массив или строка с нужным падежом
  • +
  • access: public
  • +
+ +
+ mixed + + qSecondName + + (string $secondName, [int $CaseNumber = null], [int $gender = 0]) +
+ +
    +
  • + string + $secondName: фамилия, которую нужно просклонять
  • +
  • + int + $CaseNumber: номер падежа
  • +
  • + int + $gender: пол, который нужно использовать
  • +
+ + +
+ +
+ +
+ Rule (line 125) +
+ + +

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

+
    +
  • access: protected
  • +
+ +
+ void + + Rule + + (int $index) +
+ +
    +
  • + int + $index: номер правила которое нужно установить
  • +
+ + +
+ +
+ +
+ RulesChain (line 179) +
+ + +

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

+

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

+
    +
  • return: если правило было задествовано, тогда true, если нет - тогда false
  • +
  • access: protected
  • +
+ +
+ boolean + + RulesChain + + (string $gender, array $rulesArray) +
+ +
    +
  • + string + $gender: - префикс мужских/женских правил
  • +
  • + array + $rulesArray: - массив, порядок выполнения правил
  • +
+ + +
+ +
+ +
+ setFatherName (line 301) +
+ + +

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

+

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

+
    +
  • access: public
  • +
+ +
+ void + + setFatherName + + ([string $fathername = ""]) +
+ +
    +
  • + string + $fathername: отчество
  • +
+ + +
+ +
+ +
+ setFirstName (line 269) +
+ + +

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

+

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

+
    +
  • access: public
  • +
+ +
+ void + + setFirstName + + ([string $firstname = ""]) +
+ +
    +
  • + string + $firstname: имя
  • +
+ + +
+ +
+ +
+ setFullName (line 333) +
+ + +

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

+
    +
  • access: public
  • +
+ +
+ void + + setFullName + + ([string $secondName = ""], [string $firstName = ""], [string $fatherName = ""]) +
+ +
    +
  • + string + $secondName: фамилия
  • +
  • + string + $firstName: имя
  • +
  • + string + $fatherName: отчество
  • +
+ + +
+ +
+ +
+ setGender (line 319) +
+ + +

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

+

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

+
    +
  • access: public
  • +
+ +
+ void + + setGender + + ([int $gender = 0]) +
+ +
    +
  • + int + $gender: пол, который нужно установить
  • +
+ + +
+ +
+ +
+ setLastName (line 355) +
+ + +

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

+

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

+
    +
  • access: public
  • +
+ +
+ void + + setLastName + + ([string $secondname = ""]) +
+ +
    +
  • + string + $secondname: фамилия
  • +
+ + +
+ +
+ +
+ setName (line 345) +
+ + +

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

+

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

+
    +
  • access: public
  • +
+ +
+ void + + setName + + ([string $firstname = ""]) +
+ +
    +
  • + string + $firstname: имя
  • +
+ + +
+ +
+ +
+ setSecondName (line 285) +
+ + +

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

+

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

+
    +
  • access: public
  • +
+ +
+ void + + setSecondName + + ([string $secondname = ""]) +
+ +
    +
  • + string + $secondname: фамилия
  • +
+ + +
+ +
+ +
+ setSirName (line 365) +
+ + +

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

+

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

+
    +
  • access: public
  • +
+ +
+ void + + setSirName + + ([string $secondname = ""]) +
+ +
    +
  • + string + $secondname: фамилия
  • +
+ + +
+ +
+ +
+ setWorkingWord (line 135) +
+ + +

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

+
    +
  • access: protected
  • +
+ +
+ void + + setWorkingWord + + (string $word) +
+ +
    +
  • + string + $word: слово, которое нужно установить
  • +
+ + +
+ +
+ +
+ splitFullName (line 513) +
+ + +

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

+

Формат:

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

+
    +
  • return: формат в котором записано имя например 'N F S'
  • +
  • access: public
  • +
+ +
+ string + + splitFullName + + (string $fullname) +
+ +
    +
  • + string + $fullname: строка, для которой необходимо определить формат
  • +
+ + +
+ +
+ +
+ wordForms (line 248) +
+ + +

Склоняет слово $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 14:04:07 +0300 by phpDocumentor 1.4.3 +

+
+ \ No newline at end of file diff --git a/Docs/NameCaseLib/NCLNameCaseInterface.html b/Docs/NameCaseLib/NCLNameCaseInterface.html new file mode 100644 index 0000000..7e2ff55 --- /dev/null +++ b/Docs/NameCaseLib/NCLNameCaseInterface.html @@ -0,0 +1,780 @@ + + + + + + Docs For Class NCLNameCaseInterface + + + + +
+

Interface NCLNameCaseInterface

+ + +
+
Description
+ +
+ +

Интерфейс для русского и украинского языка

+ +

+ Located in /NCL/NCLNameCaseInterface.php (line 14) +

+ + +

+	
+			
+
+ + + + + +
+
Method Summary
+ +
+
+ +
+ void + genderAutoDetect + () +
+
+ void + getFatherNameCase + ([ $number = null]) +
+
+ void + getFirstNameCase + ([ $number = null]) +
+
+ void + getFormatted + ([ $caseNum = 0], [ $format = "S N F"]) +
+
+ void + getFormattedArray + ( $format) +
+
+ void + getSecondNameCase + ([ $number = null]) +
+
+ void + q + ( $fullname, [ $caseNum = null], [ $gender = null]) +
+
+ void + qFatherName + ( $fatherName, [ $CaseNumber = null], [ $gender = 0]) +
+
+ void + qFirstName + ( $firstName, [ $CaseNumber = null], [ $gender = 0]) +
+
+ void + qFullName + ([ $secondName = ""], [ $firstName = ""], [ $fatherName = ""], [ $gender = 0], [ $caseNum = 0], [ $format = "S N F"]) +
+
+ void + qSecondName + ( $secondName, [ $CaseNumber = null], [ $gender = 0]) +
+
+ void + setFatherName + ([ $fathername = ""]) +
+
+ void + setFirstName + ([ $firstname = ""]) +
+
+ void + setFullName + ([ $secondName = ""], [ $firstName = ""], [ $fatherName = ""]) +
+
+ void + setGender + ([ $gender = 0]) +
+
+ void + setLastName + ([ $secondname = ""]) +
+
+ void + setName + ([ $firstname = ""]) +
+
+ void + setSecondName + ([ $secondname = ""]) +
+
+ void + setSirname + ([ $secondname = ""]) +
+
+ void + splitFullName + ( $fullname) +
+
+
+
+ + + +
+
Methods
+ +
+ + + +
+ +
+ genderAutoDetect (line 33) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + genderAutoDetect + + () +
+ + + +
+ +
+ +
+ getFatherNameCase (line 41) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + getFatherNameCase + + ([ $number = null]) +
+ +
    +
  • + + $number
  • +
+ + +
+ +
+ +
+ getFirstNameCase (line 37) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + getFirstNameCase + + ([ $number = null]) +
+ +
    +
  • + + $number
  • +
+ + +
+ +
+ +
+ getFormatted (line 51) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + getFormatted + + ([ $caseNum = 0], [ $format = "S N F"]) +
+ +
    +
  • + + $caseNum
  • +
  • + + $format
  • +
+ + +
+ +
+ +
+ getFormattedArray (line 49) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + getFormattedArray + + ( $format) +
+ +
    +
  • + + $format
  • +
+ + +
+ +
+ +
+ getSecondNameCase (line 39) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + getSecondNameCase + + ([ $number = null]) +
+ +
    +
  • + + $number
  • +
+ + +
+ +
+ +
+ q (line 55) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + q + + ( $fullname, [ $caseNum = null], [ $gender = null]) +
+ +
    +
  • + + $fullname
  • +
  • + + $caseNum
  • +
  • + + $gender
  • +
+ + +
+ +
+ +
+ qFatherName (line 47) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + qFatherName + + ( $fatherName, [ $CaseNumber = null], [ $gender = 0]) +
+ +
    +
  • + + $fatherName
  • +
  • + + $CaseNumber
  • +
  • + + $gender
  • +
+ + +
+ +
+ +
+ qFirstName (line 43) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + qFirstName + + ( $firstName, [ $CaseNumber = null], [ $gender = 0]) +
+ +
    +
  • + + $firstName
  • +
  • + + $CaseNumber
  • +
  • + + $gender
  • +
+ + +
+ +
+ +
+ qFullName (line 53) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + qFullName + + ([ $secondName = ""], [ $firstName = ""], [ $fatherName = ""], [ $gender = 0], [ $caseNum = 0], [ $format = "S N F"]) +
+ +
    +
  • + + $secondName
  • +
  • + + $firstName
  • +
  • + + $fatherName
  • +
  • + + $gender
  • +
  • + + $caseNum
  • +
  • + + $format
  • +
+ + +
+ +
+ +
+ qSecondName (line 45) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + qSecondName + + ( $secondName, [ $CaseNumber = null], [ $gender = 0]) +
+ +
    +
  • + + $secondName
  • +
  • + + $CaseNumber
  • +
  • + + $gender
  • +
+ + +
+ +
+ +
+ setFatherName (line 21) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + setFatherName + + ([ $fathername = ""]) +
+ +
    +
  • + + $fathername
  • +
+ + +
+ +
+ +
+ setFirstName (line 17) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + setFirstName + + ([ $firstname = ""]) +
+ +
    +
  • + + $firstname
  • +
+ + +
+ +
+ +
+ setFullName (line 25) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + setFullName + + ([ $secondName = ""], [ $firstName = ""], [ $fatherName = ""]) +
+ +
    +
  • + + $secondName
  • +
  • + + $firstName
  • +
  • + + $fatherName
  • +
+ + +
+ +
+ +
+ setGender (line 23) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + setGender + + ([ $gender = 0]) +
+ +
    +
  • + + $gender
  • +
+ + +
+ +
+ +
+ setLastName (line 29) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + setLastName + + ([ $secondname = ""]) +
+ +
    +
  • + + $secondname
  • +
+ + +
+ +
+ +
+ setName (line 27) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + setName + + ([ $firstname = ""]) +
+ +
    +
  • + + $firstname
  • +
+ + +
+ +
+ +
+ setSecondName (line 19) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + setSecondName + + ([ $secondname = ""]) +
+ +
    +
  • + + $secondname
  • +
+ + +
+ +
+ +
+ setSirname (line 31) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + setSirname + + ([ $secondname = ""]) +
+ +
    +
  • + + $secondname
  • +
+ + +
+ +
+ +
+ splitFullName (line 35) +
+ + +
    +
  • access: public
  • +
+ +
+ void + + splitFullName + + ( $fullname) +
+ +
    +
  • + + $fullname
  • +
+ + +
+ +
+
+ + +

+ Documentation generated on Wed, 06 Jul 2011 14:04:07 +0300 by phpDocumentor 1.4.3 +

+
+ \ No newline at end of file diff --git a/Docs/NameCaseLib/NCLNameCaseRu.html b/Docs/NameCaseLib/NCLNameCaseRu.html new file mode 100644 index 0000000..90c7b42 --- /dev/null +++ b/Docs/NameCaseLib/NCLNameCaseRu.html @@ -0,0 +1,932 @@ + + + + + + Docs For Class NCLNameCaseRu + + + + +
+

Class NCLNameCaseRu

+ + +
+
Description
+ +
+

+ Implements interfaces: +

+

+ +

NCL NameCase Russian Language

+

Русские правила склонения ФИО Правила определения пола человека по ФИО для русского языка Система разделения фамилий имен и отчеств для русского языка

+ +

+ Located in /NCL.NameCase.ru.php (line 23) +

+ + +
NCL
+   |
+   --NCLNameCaseCore
+      |
+      --NCLNameCaseRu
+ +
+
+ + + + +
+
Variable Summary
+ +
+
+
+ int + $CaseCount +
+
+
+
+ + +
+
Method Summary
+ +
+
+ +
+ void + detectNamePart + (NCLNameCaseWord $word) +
+
+ void + GenderByFatherName + (NCLNameCaseWord $word) +
+
+ void + GenderByFirstName + (NCLNameCaseWord $word) +
+
+ void + GenderBySecondName + (NCLNameCaseWord $word) +
+
+ boolean + manFatherName + () +
+
+ boolean + manFirstName + () +
+
+ bool + manRule1 + () +
+
+ bool + manRule2 + () +
+
+ bool + manRule3 + () +
+
+ bool + manRule4 + () +
+
+ bool + manRule5 + () +
+
+ bool + manRule6 + () +
+
+ bool + manRule7 + () +
+
+ bool + manRule8 + () +
+
+ boolean + manSecondName + () +
+
+ boolean + womanFatherName + () +
+
+ boolean + womanFirstName + () +
+
+ bool + womanRule1 + () +
+
+ bool + womanRule2 + () +
+
+ bool + womanRule3 + () +
+
+ bool + womanRule4 + () +
+
+ boolean + womanSecondName + () +
+
+
+
+ + +
+
Variables
+ +
+ +
+ +
+ + int + $CaseCount + = 6 (line 29) + +
+ + +

Количество падежей в языке

+
    +
  • access: protected
  • +
+ + + + + +
+

Inherited Variables

+ +

Inherited from NCLNameCaseCore

+
+ + NCLNameCaseCore::$lastResult
+
+ + NCLNameCaseCore::$workindLastCache
+
+ + NCLNameCaseCore::$workingWord
+
+
+

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 600) +
+ + +

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

+

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

+
    +
  • access: protected
  • +
+ +
+ void + + detectNamePart + + (NCLNameCaseWord $word) +
+ +
    +
  • + NCLNameCaseWord + $word: обьект класса слов, который необходимо идентифицировать
  • +
+ + +
+ +
+ +
+ GenderByFatherName (line 579) +
+ + +

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

+
    +
  • access: protected
  • +
+ +
+ void + + GenderByFatherName + + (NCLNameCaseWord $word) +
+ +
    +
  • + NCLNameCaseWord + $word: обьект класса слов, для которого нужно определить пол
  • +
+ + +
+ +
+ +
+ GenderByFirstName (line 483) +
+ + +

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

+
    +
  • access: protected
  • +
+ +
+ void + + GenderByFirstName + + (NCLNameCaseWord $word) +
+ +
    +
  • + NCLNameCaseWord + $word: обьект класса слов, для которого нужно определить пол
  • +
+ + +
+ +
+ +
+ GenderBySecondName (line 550) +
+ + +

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

+
    +
  • access: protected
  • +
+ +
+ void + + GenderBySecondName + + (NCLNameCaseWord $word) +
+ +
    +
  • + NCLNameCaseWord + $word: обьект класса слов, для которого нужно определить пол
  • +
+ + +
+ +
+ +
+ manFatherName (line 448) +
+ + +

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

+
    +
  • return: true - если слово было успешно изменено, false - если не получилось этого сделать
  • +
  • access: protected
  • +
+ +
+ boolean + + manFatherName + + () +
+ + + +
+ +
+ +
+ manFirstName (line 412) +
+ + +

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

+
    +
  • return: true - если было использовано правило из списка, false - если правило не было найденым
  • +
  • access: protected
  • +
+ +
+ boolean + + manFirstName + + () +
+ + + +
+ +
+ +
+ manRule1 (line 60) +
+ + +

Мужские имена, оканчивающиеся на любой ь и -й,

+

скло­няются так же, как обычные существительные мужского рода

+
    +
  • return: true если правило было задействовано и false если нет.
  • +
  • access: protected
  • +
+ +
+ bool + + manRule1 + + () +
+ + + +
+ +
+ +
+ manRule2 (line 85) +
+ + +

Мужские имена, оканчивающиеся на любой твердый согласный,

+

склоняются так же, как обычные существительные мужского рода

+
    +
  • return: true если правило было задействовано и false если нет.
  • +
  • access: protected
  • +
+ +
+ bool + + manRule2 + + () +
+ + + +
+ +
+ +
+ manRule3 (line 118) +
+ + +

Мужские и женские имена, оканчивающиеся на -а, склоняются, как и любые

+

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

+
    +
  • return: true если правило было задействовано и false если нет.
  • +
  • access: protected
  • +
+ +
+ bool + + manRule3 + + () +
+ + + +
+ +
+ +
+ manRule4 (line 149) +
+ + +

Мужские фамилии, оканчивающиеся на -ь -й, склоняются так же,

+

как обычные существительные мужского рода

+
    +
  • return: true если правило было задействовано и false если нет.
  • +
  • access: protected
  • +
+ +
+ bool + + manRule4 + + () +
+ + + +
+ +
+ +
+ manRule5 (line 188) +
+ + +

Мужские фамилии, оканчивающиеся на -к

+
    +
  • return: true если правило было задействовано и false если нет.
  • +
  • access: protected
  • +
+ +
+ bool + + manRule5 + + () +
+ + + +
+ +
+ +
+ manRule6 (line 219) +
+ + +

Мужские фамили на согласный выбираем ем/ом/ым

+
    +
  • return: true если правило было задействовано и false если нет.
  • +
  • access: protected
  • +
+ +
+ bool + + manRule6 + + () +
+ + + +
+ +
+ +
+ manRule7 (line 246) +
+ + +

Мужские фамили на -а -я

+
    +
  • return: true если правило было задействовано и false если нет.
  • +
  • access: protected
  • +
+ +
+ bool + + manRule7 + + () +
+ + + +
+ +
+ +
+ manRule8 (line 283) +
+ + +

Не склоняются мужский фамилии

+
    +
  • return: true если правило было задействовано и false если нет.
  • +
  • access: protected
  • +
+ +
+ bool + + manRule8 + + () +
+ + + +
+ +
+ +
+ manSecondName (line 430) +
+ + +

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

+
    +
  • return: true - если было использовано правило из списка, false - если правило не было найденым
  • +
  • access: protected
  • +
+ +
+ boolean + + manSecondName + + () +
+ + + +
+ +
+ +
+ womanFatherName (line 468) +
+ + +

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

+
    +
  • return: true - если слово было успешно изменено, false - если не получилось этого сделать
  • +
  • access: protected
  • +
+ +
+ boolean + + womanFatherName + + () +
+ + + +
+ +
+ +
+ womanFirstName (line 421) +
+ + +

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

+
    +
  • return: true - если было использовано правило из списка, false - если правило не было найденым
  • +
  • access: protected
  • +
+ +
+ boolean + + womanFirstName + + () +
+ + + +
+ +
+ +
+ womanRule1 (line 299) +
+ + +

Мужские и женские имена, оканчивающиеся на -а, склоняются,

+

как и любые существительные с таким же окончанием

+
    +
  • return: true если правило было задействовано и false если нет.
  • +
  • access: protected
  • +
+ +
+ bool + + womanRule1 + + () +
+ + + +
+ +
+ +
+ womanRule2 (line 334) +
+ + +

Мужские и женские имена, оканчивающиеся иа -я, -ья, -ия, -ея, независимо от языка,

+

из которого они происходят, склоняются как сущест­вительные с соответствующими окончаниями

+
    +
  • return: true если правило было задействовано и false если нет.
  • +
  • access: protected
  • +
+ +
+ bool + + womanRule2 + + () +
+ + + +
+ +
+ +
+ womanRule3 (line 359) +
+ + +

Русские женские имена, оканчивающиеся на мягкий согласный, склоняются,

+

как существительные женского рода типа дочь, тень

+
    +
  • return: true если правило было задействовано и false если нет.
  • +
  • access: protected
  • +
+ +
+ bool + + womanRule3 + + () +
+ + + +
+ +
+ +
+ womanRule4 (line 375) +
+ + +

Женские фамилия, оканчивающиеся на -а -я, склоняются,

+

как и любые существительные с таким же окончанием

+
    +
  • return: true если правило было задействовано и false если нет.
  • +
  • access: protected
  • +
+ +
+ bool + + womanRule4 + + () +
+ + + +
+ +
+ +
+ womanSecondName (line 439) +
+ + +

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

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

Inherited Methods

+ + +

Inherited From NCLNameCaseCore

+
+ NCLNameCaseCore::fullReset()
+ NCLNameCaseCore::genderAutoDetect()
+ NCLNameCaseCore::getFatherNameCase()
+ NCLNameCaseCore::getFirstNameCase()
+ NCLNameCaseCore::getFormatted()
+ NCLNameCaseCore::getFormattedArray()
+ NCLNameCaseCore::getFormattedArrayHard()
+ NCLNameCaseCore::getFormattedHard()
+ NCLNameCaseCore::getSecondNameCase()
+ NCLNameCaseCore::in()
+ NCLNameCaseCore::inNames()
+ NCLNameCaseCore::Last()
+ NCLNameCaseCore::q()
+ NCLNameCaseCore::qFatherName()
+ NCLNameCaseCore::qFirstName()
+ NCLNameCaseCore::qFullName()
+ NCLNameCaseCore::qSecondName()
+ NCLNameCaseCore::Rule()
+ NCLNameCaseCore::RulesChain()
+ NCLNameCaseCore::setFatherName()
+ NCLNameCaseCore::setFirstName()
+ NCLNameCaseCore::setFullName()
+ NCLNameCaseCore::setGender()
+ NCLNameCaseCore::setLastName()
+ NCLNameCaseCore::setName()
+ NCLNameCaseCore::setSecondName()
+ NCLNameCaseCore::setSirName()
+ NCLNameCaseCore::setWorkingWord()
+ NCLNameCaseCore::splitFullName()
+ NCLNameCaseCore::wordForms()
+
+ +
+
+ + +

+ Documentation generated on Wed, 06 Jul 2011 14:04:05 +0300 by phpDocumentor 1.4.3 +

+
+ \ No newline at end of file diff --git a/Docs/NameCaseLib/NCLNameCaseUa.html b/Docs/NameCaseLib/NCLNameCaseUa.html index d6bc119..62dc042 100644 --- a/Docs/NameCaseLib/NCLNameCaseUa.html +++ b/Docs/NameCaseLib/NCLNameCaseUa.html @@ -24,23 +24,23 @@

Implements interfaces:

+
  • NCLNameCaseInterface
  • -

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

    -

    +

    NCL NameCase Ukranian Language

    +

    Украинские правила склонений ФИО. Правила определения пола человека по ФИО для украинского языка Система разделения фамилий имен и отчеств для украинского языка

    - Located in /NCL.NameCase.ua.php (line 18) + Located in /NCL.NameCase.ua.php (line 23)

    -
    NCL
    +		
    NCL
        |
    -   --NCLNameCaseCore
    +   --NCLNameCaseCore
           |
           --NCLNameCaseUa
    @@ -85,22 +85,22 @@
    void detectNamePart - ( $word) + (NCLNameCaseWord $word)
    void GenderByFatherName - ( $word) + (NCLNameCaseWord $word)
    void GenderByFirstName - ( $word) + (NCLNameCaseWord $word)
    void GenderBySecondName - ( $word) + (NCLNameCaseWord $word)
    boolean @@ -196,13 +196,13 @@ int $CaseCount - = 7 (line 24) + = 7 (line 30)
    +

    Количество падежей в языке

    @@ -213,79 +213,64 @@

    Inherited Variables

    -

    Inherited from NCLNameCaseCore

    +

    Inherited from NCLNameCaseCore

    - NCLNameCaseCore::$finished
    + NCLNameCaseCore::$lastResult
    - NCLNameCaseCore::$index
    + NCLNameCaseCore::$workindLastCache
    - NCLNameCaseCore::$lastResult
    -
    - - NCLNameCaseCore::$lastRule
    -
    - - NCLNameCaseCore::$ready
    -
    - - NCLNameCaseCore::$words
    -
    - - NCLNameCaseCore::$workindLastCache
    -
    - - NCLNameCaseCore::$workingWord
    + NCLNameCaseCore::$workingWord
    -

    Inherited from NCL

    +

    Inherited from NCL

    - NCL::$DATELN
    + NCL::$DATELN
    - NCL::$IMENITLN
    + NCL::$IMENITLN
    - NCL::$MAN
    + NCL::$MAN
    - NCL::$PREDLOGN
    + NCL::$PREDLOGN
    - NCL::$RODITLN
    + NCL::$RODITLN
    - NCL::$TVORITELN
    + NCL::$TVORITELN
    - NCL::$UaDavalnyi
    + NCL::$UaDavalnyi
    - NCL::$UaKlychnyi
    + NCL::$UaKlychnyi
    - NCL::$UaMiszevyi
    + NCL::$UaMiszevyi
    - NCL::$UaNazyvnyi
    + NCL::$UaNazyvnyi
    - NCL::$UaOrudnyi
    + NCL::$UaOrudnyi
    - NCL::$UaRodovyi
    + NCL::$UaRodovyi
    - NCL::$UaZnahidnyi
    + NCL::$UaZnahidnyi
    - NCL::$VINITELN
    + NCL::$VINITELN
    - NCL::$WOMAN
    + NCL::$WOMAN
    @@ -308,7 +293,7 @@
    - detectNamePart (line 684) + detectNamePart (line 696)
    @@ -323,12 +308,12 @@ detectNamePart - ( $word) + (NCLNameCaseWord $word)
    @@ -338,7 +323,7 @@
    - GenderByFatherName (line 663) + GenderByFatherName (line 675)
    @@ -352,12 +337,12 @@ GenderByFatherName - ( $word) + (NCLNameCaseWord $word)
    @@ -367,7 +352,7 @@
    - GenderByFirstName (line 584) + GenderByFirstName (line 596)
    @@ -381,12 +366,12 @@ GenderByFirstName - ( $word) + (NCLNameCaseWord $word)
    @@ -396,7 +381,7 @@
    - GenderBySecondName (line 634) + GenderBySecondName (line 646)
    @@ -410,12 +395,12 @@ GenderBySecondName - ( $word) + (NCLNameCaseWord $word)
    @@ -425,7 +410,7 @@
    - manFatherName (line 556) + manFatherName (line 568)
    @@ -450,7 +435,7 @@
    - manFirstName (line 519) + manFirstName (line 531)
    @@ -475,7 +460,7 @@
    - manRule1 (line 187) + manRule1 (line 199)
    @@ -504,7 +489,7 @@
    - manRule2 (line 224) + manRule2 (line 236)
    @@ -529,7 +514,7 @@
    - manRule3 (line 254) + manRule3 (line 266)
    @@ -554,7 +539,7 @@
    - manRule4 (line 365) + manRule4 (line 377)
    @@ -579,7 +564,7 @@
    - manRule5 (line 380) + manRule5 (line 392)
    @@ -604,7 +589,7 @@
    - manSecondName (line 538) + manSecondName (line 550)
    @@ -629,7 +614,7 @@
    - womanFatherName (line 570) + womanFatherName (line 582)
    @@ -654,7 +639,7 @@
    - womanFirstName (line 528) + womanFirstName (line 540)
    @@ -679,7 +664,7 @@
    - womanRule1 (line 401) + womanRule1 (line 413)
    @@ -708,7 +693,7 @@
    - womanRule2 (line 447) + womanRule2 (line 459)
    @@ -734,7 +719,7 @@
    - womanRule3 (line 491) + womanRule3 (line 503)
    @@ -759,7 +744,7 @@
    - womanSecondName (line 547) + womanSecondName (line 559)
    @@ -783,48 +768,38 @@

    Inherited Methods

    -

    Inherited From NCLNameCaseCore

    +

    Inherited From NCLNameCaseCore

    - NCLNameCaseCore::AllWordCases()
    - NCLNameCaseCore::fullReset()
    - NCLNameCaseCore::genderAutoDetect()
    - NCLNameCaseCore::generateIndex()
    - NCLNameCaseCore::getFatherNameCase()
    - NCLNameCaseCore::getFirstNameCase()
    - NCLNameCaseCore::getFormatted()
    - NCLNameCaseCore::getFormattedArray()
    - NCLNameCaseCore::getFormattedArrayHard()
    - NCLNameCaseCore::getFormattedHard()
    - NCLNameCaseCore::getSecondNameCase()
    - NCLNameCaseCore::in()
    - NCLNameCaseCore::inNames()
    - NCLNameCaseCore::Last()
    - NCLNameCaseCore::notReady()
    - NCLNameCaseCore::prepareAllNameParts()
    - NCLNameCaseCore::prepareEverything()
    - NCLNameCaseCore::prepareGender()
    - NCLNameCaseCore::prepareNamePart()
    - NCLNameCaseCore::q()
    - NCLNameCaseCore::qFatherName()
    - NCLNameCaseCore::qFirstName()
    - NCLNameCaseCore::qFullName()
    - NCLNameCaseCore::qSecondName()
    - NCLNameCaseCore::reset()
    - NCLNameCaseCore::Rule()
    - NCLNameCaseCore::RulesChain()
    - NCLNameCaseCore::setFatherName()
    - NCLNameCaseCore::setFirstName()
    - NCLNameCaseCore::setFullName()
    - NCLNameCaseCore::setGender()
    - NCLNameCaseCore::setLastName()
    - NCLNameCaseCore::setName()
    - NCLNameCaseCore::setSecondName()
    - NCLNameCaseCore::setSirname()
    - NCLNameCaseCore::setWorkingWord()
    - NCLNameCaseCore::solveGender()
    - NCLNameCaseCore::splitFullName()
    - NCLNameCaseCore::WordCase()
    - NCLNameCaseCore::wordForms()
    + NCLNameCaseCore::fullReset()
    + NCLNameCaseCore::genderAutoDetect()
    + NCLNameCaseCore::getFatherNameCase()
    + NCLNameCaseCore::getFirstNameCase()
    + NCLNameCaseCore::getFormatted()
    + NCLNameCaseCore::getFormattedArray()
    + NCLNameCaseCore::getFormattedArrayHard()
    + NCLNameCaseCore::getFormattedHard()
    + NCLNameCaseCore::getSecondNameCase()
    + NCLNameCaseCore::in()
    + NCLNameCaseCore::inNames()
    + NCLNameCaseCore::Last()
    + NCLNameCaseCore::q()
    + NCLNameCaseCore::qFatherName()
    + NCLNameCaseCore::qFirstName()
    + NCLNameCaseCore::qFullName()
    + NCLNameCaseCore::qSecondName()
    + NCLNameCaseCore::Rule()
    + NCLNameCaseCore::RulesChain()
    + NCLNameCaseCore::setFatherName()
    + NCLNameCaseCore::setFirstName()
    + NCLNameCaseCore::setFullName()
    + NCLNameCaseCore::setGender()
    + NCLNameCaseCore::setLastName()
    + NCLNameCaseCore::setName()
    + NCLNameCaseCore::setSecondName()
    + NCLNameCaseCore::setSirName()
    + NCLNameCaseCore::setWorkingWord()
    + NCLNameCaseCore::splitFullName()
    + NCLNameCaseCore::wordForms()
    @@ -832,7 +807,7 @@

    - Documentation generated on Wed, 06 Jul 2011 00:04:56 +0300 by phpDocumentor 1.4.3 + Documentation generated on Wed, 06 Jul 2011 14:04:06 +0300 by phpDocumentor 1.4.3

    \ No newline at end of file diff --git a/Docs/NameCaseLib/NCLNameCaseWord.html b/Docs/NameCaseLib/NCLNameCaseWord.html new file mode 100644 index 0000000..1d65b36 --- /dev/null +++ b/Docs/NameCaseLib/NCLNameCaseWord.html @@ -0,0 +1,467 @@ + + + + + + Docs For Class NCLNameCaseWord + + + + +
    +

    Class NCLNameCaseWord

    + + +
    +
    Description
    + +
    + +

    NCLNameCaseWord - класс, который служит для хранения всей информации о каждом слове

    + +

    + Located in /NCL/NCLNameCaseWord.php (line 14) +

    + + +
    
    +	
    +			
    +
    + + + + + +
    +
    Method Summary
    + +
    +
    + +
    + NCLNameCaseWord + __construct + (string $word) +
    +
    + int + gender + () +
    +
    + array + getGender + () +
    +
    + array + getNameCases + () +
    +
    + string + getNamePart + () +
    +
    + string + getWord + () +
    +
    + bool + isGenderSolved + () +
    +
    + void + setGender + (int $man, int $woman) +
    +
    + void + setNameCases + (array $nameCases) +
    +
    + void + setNamePart + (string $namePart) +
    +
    + void + setRule + (int $ruleID) +
    +
    + void + setTrueGender + (int $gender) +
    +
    +
    +
    + + + +
    +
    Methods
    + +
    + + + +
    + +
    + Constructor __construct (line 85) +
    + + +

    Создание нового обьекта со словом $word

    +
      +
    • access: public
    • +
    + +
    + NCLNameCaseWord + + __construct + + (string $word) +
    + +
      +
    • + string + $word: слово
    • +
    + + +
    + +
    + +
    + gender (line 178) +
    + + +

    Расчитывает и возвращает пол текущего слова

    +
      +
    • return: пол текущего слова
    • +
    • access: public
    • +
    + +
    + int + + gender + + () +
    + + + +
    + +
    + +
    + getGender (line 221) +
    + + +

    Возвращает массив вероятности того, что даное слово является мужчиной или женщиной

    +
      +
    • return: массив вероятностей
    • +
    • access: public
    • +
    + +
    + array + + getGender + + () +
    + + + +
    + +
    + +
    + getNameCases (line 169) +
    + + +

    Возвращает массив со всеми падежами текущего слова

    +
      +
    • return: массив со всеми падежами
    • +
    • access: public
    • +
    + +
    + array + + getNameCases + + () +
    + + + +
    + +
    + +
    + getNamePart (line 247) +
    + + +

    Возвращает тип текущего слова

    +

    Тип слова:

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

    +
      +
    • return: тип слова
    • +
    • access: public
    • +
    + +
    + string + + getNamePart + + () +
    + + + +
    + +
    + +
    + getWord (line 256) +
    + + +

    Возвращает текущее слово.

    +
      +
    • return: текущее слово
    • +
    • access: public
    • +
    + +
    + string + + getWord + + () +
    + + + +
    + +
    + +
    + isGenderSolved (line 266) +
    + + +

    Если уже был расчитан пол для всех слов системы, тогда каждому слову предается окончательное решение. Эта функция определяет было ли принято окончательное решение.

    +
      +
    • return: было ли принято окончательное решение по поводу пола текущего слова
    • +
    • access: public
    • +
    + +
    + bool + + isGenderSolved + + () +
    + + + +
    + +
    + +
    + setGender (line 199) +
    + + +

    Устанавливает вероятности того, что даное слово является мужчиной или женщиной

    +
      +
    • access: public
    • +
    + +
    + void + + setGender + + (int $man, int $woman) +
    + +
      +
    • + int + $man: вероятность того, что слово мужчина
    • +
    • + int + $woman: верятность того, что слово женщина
    • +
    + + +
    + +
    + +
    + setNameCases (line 159) +
    + + +

    Сохраняет результат склонения текущего слова

    +
      +
    • access: public
    • +
    + +
    + void + + setNameCases + + (array $nameCases) +
    + +
      +
    • + array + $nameCases: массив со всеми падежами
    • +
    + + +
    + +
    + +
    + setNamePart (line 234) +
    + + +

    Устанавливает тип текущего слова

    +

    Тип слова:

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

    +
      +
    • access: public
    • +
    + +
    + void + + setNamePart + + (string $namePart) +
    + +
      +
    • + string + $namePart: тип слова
    • +
    + + +
    + +
    + +
    + setRule (line 275) +
    + + +

    Устанавливает номер правила по которому склонялось текущее слово.

    +
      +
    • access: public
    • +
    + +
    + void + + setRule + + (int $ruleID) +
    + +
      +
    • + int + $ruleID: номер правила
    • +
    + + +
    + +
    + +
    + setTrueGender (line 212) +
    + + +

    Окончательно устанавливает пол человека

    +

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

    +
      +
    • access: public
    • +
    + +
    + void + + setTrueGender + + (int $gender) +
    + +
      +
    • + int + $gender: пол человека
    • +
    + + +
    + +
    +
    + + +

    + Documentation generated on Wed, 06 Jul 2011 14:04:08 +0300 by phpDocumentor 1.4.3 +

    +
    + \ No newline at end of file diff --git a/Docs/NameCaseLib/NCLStr.html b/Docs/NameCaseLib/NCLStr.html new file mode 100644 index 0000000..cb8c759 --- /dev/null +++ b/Docs/NameCaseLib/NCLStr.html @@ -0,0 +1,542 @@ + + + + + + Docs For Class NCLStr + + + + +
    +

    Class NCLStr

    + + +
    +
    Description
    + +
    + +

    Класс содержит функции для работы со строками, которые используются в NCLNameCaseLib

    + +

    + Located in /NCL/NCLStr.php (line 14) +

    + + +
    
    +	
    +			
    +
    + + + + +
    +
    Variable Summary
    + +
    +
    +
    + static string + $charset +
    +
    +
    +
    + + +
    +
    Method Summary
    + +
    +
    +
    + static string + connectLetters + (array $lettersArr) +
    +
    + static array + explode + (string $pattern, string $string) +
    +
    + static bool + isLowerCase + (string $phrase) +
    +
    + static bool + isUpperCase + (string $phrase) +
    +
    + static array + splitLetters + (string $phrase) +
    +
    + static int + strlen + (string $str) +
    +
    + static int + strpos + (string $haystack, string $needle, [int $offset = 0]) +
    +
    + static int + strrpos + (string $haystack, string $needle, [int $offset = null]) +
    +
    + static string + strtolower + (string $str) +
    +
    + static string + strtoupper + (string $str) +
    +
    + static int + substr + (string $str, int $start, [int $length = null]) +
    + +
    +
    +
    + + +
    +
    Variables
    + +
    + +
    + +
    + + static string + $charset + = 'utf-8' (line 20) + +
    + + +

    Кодировка, в котороя работает система

    + + + + + +
    + +
    +
    + + +
    +
    Methods
    + +
    + + +
    + +
    + static method connectLetters (line 129) +
    + + +

    Соединяет массив букв в строку

    +
      +
    • return: строка
    • +
    + +
    + static + string + + connectLetters + + (array $lettersArr) +
    + +
      +
    • + array + $lettersArr: массив букв
    • +
    + + +
    + +
    + +
    + static method explode (line 140) +
    + + +

    Разбивает строку на части использую шаблон

    +
      +
    • return: разбитый массив
    • +
    + +
    + static + array + + explode + + (string $pattern, string $string) +
    + +
      +
    • + string + $pattern: шаблон разбития
    • +
    • + string + $string: строка, которую нужно разбить
    • +
    + + +
    + +
    + +
    + static method isLowerCase (line 93) +
    + + +

    Проверяет в нижнем ли регистре находится строка

    +
      +
    • return: в нижнем ли регистре строка
    • +
    + +
    + static + bool + + isLowerCase + + (string $phrase) +
    + +
      +
    • + string + $phrase: строка
    • +
    + + +
    + +
    + +
    + static method isUpperCase (line 103) +
    + + +

    Проверяет в верхнем ли регистре находится строка

    +
      +
    • return: в верхнем ли регистре строка
    • +
    + +
    + static + bool + + isUpperCase + + (string $phrase) +
    + +
      +
    • + string + $phrase: строка
    • +
    + + +
    + +
    + +
    + static method splitLetters (line 113) +
    + + +

    Превращает строку в массив букв

    +
      +
    • return: массив букв
    • +
    + +
    + static + array + + splitLetters + + (string $phrase) +
    + +
      +
    • + string + $phrase: строка
    • +
    + + +
    + +
    + +
    + static method strlen (line 51) +
    + + +

    Определение длины строки

    +
      +
    • return: длина строки
    • +
    + +
    + static + int + + strlen + + (string $str) +
    + +
      +
    • + string + $str: строка
    • +
    + + +
    + +
    + +
    + static method strpos (line 41) +
    + + +

    Поиск подстроки в строке

    +
      +
    • return: позиция подстроки в строке
    • +
    + +
    + static + int + + strpos + + (string $haystack, string $needle, [int $offset = 0]) +
    + +
      +
    • + string + $haystack: строка, в которой искать
    • +
    • + string + $needle: подстрока, которую нужно найти
    • +
    • + int + $offset: начало поиска
    • +
    + + +
    + +
    + +
    + static method strrpos (line 83) +
    + + +

    Поиск подстроки в строке справа

    +
      +
    • return: позиция подстроки в строке
    • +
    + +
    + static + int + + strrpos + + (string $haystack, string $needle, [int $offset = null]) +
    + +
      +
    • + string + $haystack: строка, в которой искать
    • +
    • + string + $needle: подстрока, которую нужно найти
    • +
    • + int + $offset: начало поиска
    • +
    + + +
    + +
    + +
    + static method strtolower (line 61) +
    + + +

    Переводит строку в нижний регистр

    +
      +
    • return: строка в нижнем регистре
    • +
    + +
    + static + string + + strtolower + + (string $str) +
    + +
      +
    • + string + $str: строка
    • +
    + + +
    + +
    + +
    + static method strtoupper (line 71) +
    + + +

    Переводит строку в верхний регистр

    +
      +
    • return: строка в верхнем регистре
    • +
    + +
    + static + string + + strtoupper + + (string $str) +
    + +
      +
    • + string + $str: строка
    • +
    + + +
    + +
    + +
    + static method substr (line 29) +
    + + +

    Получить подстроку из строки

    +
      +
    • return: подстрока
    • +
    + +
    + static + int + + substr + + (string $str, int $start, [int $length = null]) +
    + +
      +
    • + string + $str: строка
    • +
    • + int + $start: начало подстроки
    • +
    • + int + $length: длина подстроки
    • +
    + + +
    + + +
    +
    + + +

    + Documentation generated on Wed, 06 Jul 2011 14:04:08 +0300 by phpDocumentor 1.4.3 +

    +
    + \ No newline at end of file diff --git a/Docs/NameCaseLib/_NCL---NCL.php.html b/Docs/NameCaseLib/_NCL---NCL.php.html new file mode 100644 index 0000000..377dc69 --- /dev/null +++ b/Docs/NameCaseLib/_NCL---NCL.php.html @@ -0,0 +1,63 @@ + + + + + + Docs for page NCL.php + + + + +
    +

    /NCL/NCL.php

    + + +
    +
    Description
    + +
    + +
      +
    • license: Dual
    • +
    + +
    +
    + + +
    +
    Classes
    + +
    + + + + + + + + + +
    ClassDescription
    + NCL + + Класс, который содержит основные константы библиотеки:
    • индексы мужского и женского пола
    • индексы всех падежей
    +
    +
    +
    + + + + + +

    + Documentation generated on Wed, 06 Jul 2011 14:04:07 +0300 by phpDocumentor 1.4.3 +

    +
    + \ No newline at end of file diff --git a/Docs/NameCaseLib/_NCL---NCLNameCaseCore.php.html b/Docs/NameCaseLib/_NCL---NCLNameCaseCore.php.html new file mode 100644 index 0000000..4b92eba --- /dev/null +++ b/Docs/NameCaseLib/_NCL---NCLNameCaseCore.php.html @@ -0,0 +1,161 @@ + + + + + + Docs for page NCLNameCaseCore.php + + + + +
    +

    /NCL/NCLNameCaseCore.php

    + + +
    +
    Description
    + +
    + +
      +
    • license: Dual
    • +
    + +
    +
    + + +
    +
    Classes
    + +
    + + + + + + + + + +
    ClassDescription
    + NCLNameCaseCore + + NCL NameCase Core +
    +
    +
    + + +
    +
    Includes
    + +
    + +
    + +
    + + require_once + (NCL_DIR.'/NCL.php') + (line 15) + +
    + + + +
    + +
    + +
    + + require_once + (NCL_DIR.'/NCLStr.php') + (line 16) + +
    + + + +
    + +
    + +
    + + require_once + (NCL_DIR.'/NCLNameCaseInterface.php') + (line 17) + +
    + + + +
    + +
    + +
    + + require_once + (NCL_DIR.'/NCLNameCaseWord.php') + (line 18) + +
    + + + +
    +
    +
    + + +
    +
    Constants
    + +
    + +
    + +
    + + NCL_DIR = dirname(__FILE__) + (line 12) + +
    + + + + +
    +
    +
    + + + +

    + Documentation generated on Wed, 06 Jul 2011 14:04:07 +0300 by phpDocumentor 1.4.3 +

    +
    + \ No newline at end of file diff --git a/Docs/NameCaseLib/_NCL---NCLNameCaseInterface.php.html b/Docs/NameCaseLib/_NCL---NCLNameCaseInterface.php.html new file mode 100644 index 0000000..f93df6c --- /dev/null +++ b/Docs/NameCaseLib/_NCL---NCLNameCaseInterface.php.html @@ -0,0 +1,63 @@ + + + + + + Docs for page NCLNameCaseInterface.php + + + + +
    +

    /NCL/NCLNameCaseInterface.php

    + + +
    +
    Description
    + +
    + +
      +
    • license: Dual
    • +
    + +
    +
    + + +
    +
    Classes
    + +
    + + + + + + + + + +
    ClassDescription
    + NCLNameCaseInterface + + Интерфейс для русского и украинского языка +
    +
    +
    + + + + + +

    + Documentation generated on Wed, 06 Jul 2011 14:04:07 +0300 by phpDocumentor 1.4.3 +

    +
    + \ No newline at end of file diff --git a/Docs/NameCaseLib/_NCL---NCLNameCaseWord.php.html b/Docs/NameCaseLib/_NCL---NCLNameCaseWord.php.html new file mode 100644 index 0000000..750ff3d --- /dev/null +++ b/Docs/NameCaseLib/_NCL---NCLNameCaseWord.php.html @@ -0,0 +1,63 @@ + + + + + + Docs for page NCLNameCaseWord.php + + + + +
    +

    /NCL/NCLNameCaseWord.php

    + + +
    +
    Description
    + +
    + +
      +
    • license: Dual
    • +
    + +
    +
    + + +
    +
    Classes
    + +
    + + + + + + + + + +
    ClassDescription
    + NCLNameCaseWord + + NCLNameCaseWord - класс, который служит для хранения всей информации о каждом слове +
    +
    +
    + + + + + +

    + Documentation generated on Wed, 06 Jul 2011 14:04:08 +0300 by phpDocumentor 1.4.3 +

    +
    + \ No newline at end of file diff --git a/Docs/NameCaseLib/_NCL---NCLStr.php.html b/Docs/NameCaseLib/_NCL---NCLStr.php.html new file mode 100644 index 0000000..4613aff --- /dev/null +++ b/Docs/NameCaseLib/_NCL---NCLStr.php.html @@ -0,0 +1,63 @@ + + + + + + Docs for page NCLStr.php + + + + +
    +

    /NCL/NCLStr.php

    + + +
    +
    Description
    + +
    + +
      +
    • license: Dual
    • +
    + +
    +
    + + +
    +
    Classes
    + +
    + + + + + + + + + +
    ClassDescription
    + NCLStr + + Класс содержит функции для работы со строками, которые используются в NCLNameCaseLib +
    +
    +
    + + + + + +

    + Documentation generated on Wed, 06 Jul 2011 14:04:08 +0300 by phpDocumentor 1.4.3 +

    +
    + \ No newline at end of file diff --git a/Docs/NameCaseLib/_NCL.NameCase.ru.php.html b/Docs/NameCaseLib/_NCL.NameCase.ru.php.html new file mode 100644 index 0000000..ffc76d3 --- /dev/null +++ b/Docs/NameCaseLib/_NCL.NameCase.ru.php.html @@ -0,0 +1,90 @@ + + + + + + Docs for page NCL.NameCase.ru.php + + + + +
    +

    /NCL.NameCase.ru.php

    + + +
    +
    Description
    + +
    + +
      +
    • license: Dual
    • +
    + +
    +
    + + +
    +
    Classes
    + +
    + + + + + + + + + +
    ClassDescription
    + NCLNameCaseRu + + NCL NameCase Russian Language +
    +
    +
    + + +
    +
    Includes
    + +
    + +
    + +
    + + require_once + (dirname(__FILE__).'/NCL/NCLNameCaseCore.php') + (line 10) + +
    + + + +
    +
    +
    + + + + +

    + Documentation generated on Wed, 06 Jul 2011 14:04:05 +0300 by phpDocumentor 1.4.3 +

    +
    + \ No newline at end of file diff --git a/Docs/NameCaseLib/_NCL.NameCase.ua.php.html b/Docs/NameCaseLib/_NCL.NameCase.ua.php.html index 05da173..877d1b8 100644 --- a/Docs/NameCaseLib/_NCL.NameCase.ua.php.html +++ b/Docs/NameCaseLib/_NCL.NameCase.ua.php.html @@ -21,11 +21,7 @@
    -

    NCL NameCase Ukranian Language

    -

    Украинские правила склонений ФИО. Правила определения пола человека по ФИО для украинского языка Система разделения фамилий имен и отчеств для украинского языка

      -
    • author: Андрей Чайка http://seagull.net.ua/ bymer3@gmail.com
    • -
    • version: 0.4 05.07.2011
    • license: Dual
    @@ -51,7 +47,7 @@ NCLNameCaseUa - Класс, который содержит основные константы библиотеки: + NCL NameCase Ukranian Language @@ -74,7 +70,7 @@ require_once (dirname(__FILE__).'/NCL/NCLNameCaseCore.php') - (line 16) + (line 10)
    @@ -88,7 +84,7 @@

    - Documentation generated on Wed, 06 Jul 2011 00:04:56 +0300 by phpDocumentor 1.4.3 + Documentation generated on Wed, 06 Jul 2011 14:04:06 +0300 by phpDocumentor 1.4.3

    \ No newline at end of file diff --git a/Docs/blank.html b/Docs/blank.html index 923c8ef..3c8644d 100644 --- a/Docs/blank.html +++ b/Docs/blank.html @@ -6,7 +6,7 @@

    Generated Documentation

    -Welcome to default!
    +Welcome to NameCaseLib!

    This documentation was generated by phpDocumentor v1.4.3
    diff --git a/Docs/classtrees_NameCaseLib.html b/Docs/classtrees_NameCaseLib.html index 798714a..7dfbd75 100644 --- a/Docs/classtrees_NameCaseLib.html +++ b/Docs/classtrees_NameCaseLib.html @@ -13,12 +13,28 @@

    -

    Root class NCLNameCaseUa

    +

    Root interface NCLNameCaseInterface

    +
  • NCLNameCaseInterface
  • + +

    Root class NCL

    + + +

    Root class NCLNameCaseWord

    + + +

    Root class NCLStr

    +

    - Documentation generated on Wed, 06 Jul 2011 00:04:55 +0300 by phpDocumentor 1.4.3 + Documentation generated on Wed, 06 Jul 2011 14:04:05 +0300 by phpDocumentor 1.4.3

    \ No newline at end of file diff --git a/Docs/classtrees_default.html b/Docs/classtrees_default.html index 2dffa31..17710d5 100644 --- a/Docs/classtrees_default.html +++ b/Docs/classtrees_default.html @@ -34,7 +34,7 @@
  • NCLStr
  • - Documentation generated on Wed, 06 Jul 2011 00:21:03 +0300 by phpDocumentor 1.4.3 + Documentation generated on Wed, 06 Jul 2011 13:46:15 +0300 by phpDocumentor 1.4.3

    \ No newline at end of file diff --git a/Docs/default/NCL.html b/Docs/default/NCL.html index 1600629..5b359d6 100644 --- a/Docs/default/NCL.html +++ b/Docs/default/NCL.html @@ -440,7 +440,7 @@

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

    \ No newline at end of file diff --git a/Docs/default/NCLNameCaseCore.html b/Docs/default/NCLNameCaseCore.html index 95056fe..4d6eb11 100644 --- a/Docs/default/NCLNameCaseCore.html +++ b/Docs/default/NCLNameCaseCore.html @@ -87,36 +87,16 @@
    -
    - bool - $finished -
    -
    - mixed - $index -
    -
    +
    array $lastResult -
    -
    - int - $lastRule -
    -
    - bool - $ready
    array - $words -
    -
    - mixed + string $workingWord
    @@ -136,131 +116,91 @@
    - +
    void - AllWordCases - () -
    -
    - void fullReset ()
    - void + int genderAutoDetect ()
    - void - generateIndex - () -
    -
    - void + mixed getFatherNameCase - ([ $number = null]) + ([int $number = null])
    - void + mixed getFirstNameCase - ([ $number = null]) + ([int $number = null])
    - void + string getFormatted - ([ $caseNum = 0], [ $format = "S N F"]) + ([ $caseNum = 0], [string $format = "S N F"])
    - void + array getFormattedArray - ( $format) + (string $format)
    - void + array getFormattedArrayHard - ( $format) + (array $format)
    - void + string getFormattedHard - ([ $caseNum = 0], [ $format = array()]) + ([ $caseNum = 0], [array $format = array()])
    - void + mixed getSecondNameCase - ([ $number = null]) + ([int $number = null])
    - void + bool in - ( $letter,  $string) + (string $letter, mixed $string)
    void inNames - (string $nameNeedle, string $names) + (string $nameNeedle, array $names)
    - void + string Last - ([ $length = 1], [ $stopAfter = 0]) + ([int $length = 1], [int $stopAfter = 0])
    - void - notReady - () -
    -
    - void - prepareAllNameParts - () -
    -
    - void - prepareEverything - () -
    -
    - void - prepareGender - (NCLNameCaseWord $word) -
    -
    - void - prepareNamePart - (NCLNameCaseWord $word) -
    -
    - void + mixed q - ( $fullname, [ $caseNum = null], [ $gender = null]) + (string $fullname, [int $caseNum = null], [int $gender = null])
    - void + mixed qFatherName - ( $fatherName, [ $CaseNumber = null], [ $gender = 0]) + (string $fatherName, [int $CaseNumber = null], [int $gender = 0])
    - void + mixed qFirstName - ( $firstName, [ $CaseNumber = null], [ $gender = 0]) + (string $firstName, [int $CaseNumber = null], [int $gender = 0])
    - void + mixed qFullName - ([ $secondName = ""], [ $firstName = ""], [ $fatherName = ""], [ $gender = 0], [ $caseNum = 0], [ $format = "S N F"]) + ([string $secondName = ""], [string $firstName = ""], [string $fatherName = ""], [int $gender = 0], [int $caseNum = 0], [string $format = "S N F"])
    - void + mixed qSecondName - ( $secondName, [ $CaseNumber = null], [ $gender = 0]) -
    -
    - void - reset - () + (string $secondName, [int $CaseNumber = null], [int $gender = 0])
    void @@ -270,72 +210,62 @@
    boolean RulesChain - (string $gender, type $rulesArray) + (string $gender, array $rulesArray)
    void setFatherName - ([ $fathername = ""]) + ([string $fathername = ""])
    void setFirstName - ([ $firstname = ""]) + ([string $firstname = ""])
    void setFullName - ([ $secondName = ""], [ $firstName = ""], [ $fatherName = ""]) + ([string $secondName = ""], [string $firstName = ""], [string $fatherName = ""])
    void setGender - ([ $gender = 0]) + ([int $gender = 0])
    void setLastName - ([ $secondname = ""]) + ([string $secondname = ""])
    void setName - ([ $firstname = ""]) + ([string $firstname = ""])
    void setSecondName - ([ $secondname = ""]) + ([string $secondname = ""])
    void - setSirname - ([ $secondname = ""]) + setSirName + ([string $secondname = ""])
    void setWorkingWord - ( $word) + (string $word)
    - void - solveGender - () -
    -
    - void + string splitFullName - ( $fullname) -
    -
    - void - WordCase - (NCLNameCaseWord $word) + (string $fullname)
    void wordForms - ( $word,  $endings, [ $replaceLast = 0]) + (string $word, array $endings, [int $replaceLast = 0])
    @@ -355,128 +285,19 @@
    - -
    - -
    - - bool - $finished - = false (line 25) - -
    - - -

    Все слова уже просклонялись

    -
      -
    • access: protected
    • -
    - - - - - -
    - -
    - -
    - - mixed - $index - = array() (line 53) - -
    - - -
      -
    • access: protected
    • -
    - - - - - -
    - +
    array $lastResult - = array() (line 52) + = array() (line 61)
    -

    Просклоненое слово

    -
      -
    • access: protected
    • -
    - - - - - -
    - -
    - -
    - - int - $lastRule - = 0 (line 47) - -
    - - -

    Последние правило

    -
      -
    • access: protected
    • -
    - - - - - -
    - -
    - -
    - - bool - $ready - = false (line 20) - -
    - - -

    Система уже готово к склонению или нет

    -
      -
    • access: protected
    • -
    - - - - - -
    - -
    - -
    - - array - $words - = array() (line 30) - -
    - - -

    Список всех слов

    +

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

    • access: protected
    @@ -487,17 +308,18 @@
    -
    +
    - mixed + array $workindLastCache - = array() (line 42) + = array() (line 49)
    +

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

    • access: protected
    @@ -508,17 +330,18 @@
    -
    +
    - mixed + string $workingWord - = '' (line 36) + = '' (line 42)
    +

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

    • access: protected
    @@ -595,39 +418,18 @@
    - -
    - -
    - AllWordCases (line 516) -
    - - -
      -
    • access: protected
    • -
    - -
    - void - - AllWordCases - - () -
    - - - -
    - fullReset (line 64) + fullReset (line 85)
    +

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

    +

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

      -
    • access: protected
    • +
    • access: public
    @@ -645,16 +447,19 @@
    - genderAutoDetect (line 450) + genderAutoDetect (line 475)
    +

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

    +

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

      +
    • return: текущий пол человека
    • access: public
    - void + int genderAutoDetect @@ -664,271 +469,272 @@
    - +
    - generateIndex (line 423) -
    - - -
      -
    • access: protected
    • -
    - -
    - void - - generateIndex - - () -
    - - - -
    - -
    - -
    - getFatherNameCase (line 615) + getFatherNameCase (line 666)
    +

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

    +

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

      +
    • return: массив или строка с нужным падежом
    • access: public
    - void + mixed getFatherNameCase - ([ $number = null]) + ([int $number = null])
    • - - $number
    • + int + $number: номер падежа
    -
    +
    - getFirstNameCase (line 589) + getFirstNameCase (line 636)
    +

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

    +

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

      +
    • return: массив или строка с нужным падежом
    • access: public
    - void + mixed getFirstNameCase - ([ $number = null]) + ([int $number = null])
    • - - $number
    • + int + $number: номер падежа
    -
    +
    - getFormatted (line 827) + getFormatted (line 903)
    +

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

    +

    Формат:

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

      +
    • return: строка в нужном падеже
    • access: public
    - void + string getFormatted - ([ $caseNum = 0], [ $format = "S N F"]) + ([ $caseNum = 0], [string $format = "S N F"])
    • - - $caseNum
    • + string + $format: строка с форматом
    • - $format
    • + $caseNum
    -
    +
    - getFormattedArray (line 684) + getFormattedArray (line 746)
    +

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

    +

    Формат:

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

      +
    • return: массив со всеми падежами
    • access: public
    - void + array getFormattedArray - ( $format) + (string $format)
    • - - $format
    • + string + $format: строка формат
    -
    +
    - getFormattedArrayHard (line 739) + getFormattedArrayHard (line 810)
    +

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

    +

    Формат:

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

      +
    • return: массив со всеми падежами
    • access: public
    - void + array getFormattedArrayHard - ( $format) + (array $format)
    • - - $format
    • + array + $format: массив с форматом
    -
    +
    - getFormattedHard (line 789) + getFormattedHard (line 869)
    +

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

    +

    Формат:

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

      +
    • return: строка в нужном падеже
    • access: public
    - void + string getFormattedHard - ([ $caseNum = 0], [ $format = array()]) + ([ $caseNum = 0], [array $format = array()])
    • - - $caseNum
    • + array + $format: массив с форматом
    • - $format
    • + $caseNum
    -
    +
    - getSecondNameCase (line 602) + getSecondNameCase (line 651)
    +

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

    +

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

      +
    • return: массив или строка с нужным падежом
    • access: public
    - void + mixed getSecondNameCase - ([ $number = null]) + ([int $number = null])
    • - - $number
    • + int + $number: номер падежа
    -
    +
    - in (line 154) + in (line 180)
    +

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

    +

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

      +
    • return: true если искомое значение найдено
    • access: protected
    - void + bool in - ( $letter,  $string) + (string $letter, mixed $string)
    • - - $letter
    • + string + $letter: буква или строка, которую нужно искать
    • - - $string
    • + mixed + $string: строка или массив, в котором нужно искать
    -
    +
    - inNames (line 180) + inNames (line 205)
    -

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

    +

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

    • access: protected
    @@ -938,172 +744,50 @@ inNames - (string $nameNeedle, string $names) + (string $nameNeedle, array $names)
    • string - $nameNeedle: - имя
    • + $nameNeedle: - имя которое нужно найти
    • - string - $names: - перечень имен
    • + array + $names: - перечень имен в котором нужно найти имя
    -
    +
    - Last (line 106) + Last (line 133)
    +

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

    +

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

      +
    • return: требуемая подстрока
    • access: protected
    - void + string Last - ([ $length = 1], [ $stopAfter = 0]) + ([int $length = 1], [int $stopAfter = 0])
    • - - $length
    • + int + $length: количество букв с конца
    • - - $stopAfter
    • -
    - - -
    - -
    - -
    - notReady (line 72) -
    - - -
      -
    • access: protected
    • -
    - -
    - void - - notReady - - () -
    - - - -
    - -
    - -
    - prepareAllNameParts (line 362) -
    - - -
      -
    • access: protected
    • -
    - -
    - void - - prepareAllNameParts - - () -
    - - - -
    - -
    - -
    - prepareEverything (line 433) -
    - - -
      -
    • access: protected
    • -
    - -
    - void - - prepareEverything - - () -
    - - - -
    - -
    - -
    - prepareGender (line 370) -
    - - -
      -
    • access: protected
    • -
    - -
    - void - - prepareGender - - (NCLNameCaseWord $word) -
    - - - - -
    - -
    - -
    - prepareNamePart (line 354) -
    - - -
      -
    • access: protected
    • -
    - -
    - void - - prepareNamePart - - (NCLNameCaseWord $word) -
    - -
      -
    • - NCLNameCaseWord - $word
    • + int + $stopAfter: количество букв которые нужно вырезать (0 - все)
    @@ -1112,32 +796,35 @@
    - q (line 897) + q (line 980)
    +

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

    +

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

      +
    • return: либо массив со всеми падежами, либо строка
    • access: public
    - void + mixed q - ( $fullname, [ $caseNum = null], [ $gender = null]) + (string $fullname, [int $caseNum = null], [int $gender = null])
    • - - $fullname
    • + string + $fullname: ФИО
    • - - $caseNum
    • + int + $caseNum: номер падежа
    • - - $gender
    • + int + $gender: пол человека
    @@ -1146,32 +833,35 @@
    - qFatherName (line 663) + qFatherName (line 726)
    +

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

    +

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

      +
    • return: массив или строка с нужным падежом
    • access: public
    - void + mixed qFatherName - ( $fatherName, [ $CaseNumber = null], [ $gender = 0]) + (string $fatherName, [int $CaseNumber = null], [int $gender = 0])
    • - - $fatherName
    • + string + $fatherName: отчество, которое нужно просклонять
    • - - $CaseNumber
    • + int + $CaseNumber: номер падежа
    • - - $gender
    • + int + $gender: пол, который нужно использовать
    @@ -1180,32 +870,35 @@
    - qFirstName (line 628) + qFirstName (line 683)
    +

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

    +

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

      +
    • return: массив или строка с нужным падежом
    • access: public
    - void + mixed qFirstName - ( $firstName, [ $CaseNumber = null], [ $gender = 0]) + (string $firstName, [int $CaseNumber = null], [int $gender = 0])
    • - - $firstName
    • + string + $firstName: имя, которое нужно просклонять
    • - - $CaseNumber
    • + int + $CaseNumber: номер падежа
    • - - $gender
    • + int + $gender: пол, который нужно использовать
    @@ -1214,41 +907,44 @@
    - qFullName (line 877) + qFullName (line 958)
    +

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

    +

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

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

      +
    • return: либо массив со всеми падежами, либо строка
    • access: public
    - void + mixed qFullName - ([ $secondName = ""], [ $firstName = ""], [ $fatherName = ""], [ $gender = 0], [ $caseNum = 0], [ $format = "S N F"]) + ([string $secondName = ""], [string $firstName = ""], [string $fatherName = ""], [int $gender = 0], [int $caseNum = 0], [string $format = "S N F"])
    • - - $secondName
    • + string + $secondName: фамилия
    • - - $firstName
    • + string + $firstName: имя
    • - - $fatherName
    • + string + $fatherName: отчество
    • - - $gender
    • + int + $gender: пол
    • - - $caseNum
    • + int + $caseNum: номер падежа
    • - - $format
    • + string + $format: формат
    @@ -1257,69 +953,48 @@
    - qSecondName (line 645) + qSecondName (line 704)
    +

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

    +

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

      +
    • return: массив или строка с нужным падежом
    • access: public
    - void + mixed qSecondName - ( $secondName, [ $CaseNumber = null], [ $gender = 0]) + (string $secondName, [int $CaseNumber = null], [int $gender = 0])
    • - - $secondName
    • + string + $secondName: фамилия, которую нужно просклонять
    • - - $CaseNumber
    • + int + $CaseNumber: номер падежа
    • - - $gender
    • + int + $gender: пол, который нужно использовать
    - +
    - reset (line 58) + Rule (line 106)
    -

    Сброс всех настроек

    -
      -
    • access: protected
    • -
    - -
    - void - - reset - - () -
    - - - -
    - -
    - -
    - Rule (line 82) -
    - - -

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

    +

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

    • access: protected
    @@ -1335,21 +1010,23 @@
    • int - $index
    • + $index: номер правила которое нужно установить
    -
    +
    - RulesChain (line 132) + RulesChain (line 160)
    -

    Выполняет над словом типа $gender (man / woman) в порядке указанов в $rulesArray

    +

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

    +

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

      +
    • return: если правило было задествовано, тогда true, если нет - тогда false
    • access: protected
    @@ -1358,28 +1035,30 @@ RulesChain - (string $gender, type $rulesArray) + (string $gender, array $rulesArray)
    • string - $gender: - мужские/женский правила
    • + $gender: - префикс мужских/женских правил
    • - type + array $rulesArray: - массив, порядок выполнения правил
    -
    +
    - setFatherName (line 269) + setFatherName (line 282)
    +

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

    +

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

    • access: public
    @@ -1389,25 +1068,27 @@ setFatherName - ([ $fathername = ""]) + ([string $fathername = ""])
    • - - $fathername
    • + string + $fathername: отчество
    -
    +
    - setFirstName (line 231) + setFirstName (line 250)
    +

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

    +

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

    • access: public
    @@ -1417,25 +1098,26 @@ setFirstName - ([ $firstname = ""]) + ([string $firstname = ""])
    • - - $firstname
    • + string + $firstname: имя
    -
    +
    - setFullName (line 308) + setFullName (line 314)
    +

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

    • access: public
    @@ -1445,31 +1127,33 @@ setFullName - ([ $secondName = ""], [ $firstName = ""], [ $fatherName = ""]) + ([string $secondName = ""], [string $firstName = ""], [string $fatherName = ""])
    • - - $secondName
    • + string + $secondName: фамилия
    • - - $firstName
    • + string + $firstName: имя
    • - - $fatherName
    • + string + $fatherName: отчество
    -
    +
    - setGender (line 290) + setGender (line 300)
    +

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

    +

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

    • access: public
    @@ -1479,25 +1163,27 @@ setGender - ([ $gender = 0]) + ([int $gender = 0])
    • - - $gender
    • + int + $gender: пол, который нужно установить
    -
    +
    setLastName (line 336)
    +

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

    +

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

    • access: public
    @@ -1507,25 +1193,27 @@ setLastName - ([ $secondname = ""]) + ([string $secondname = ""])
    • - - $secondname
    • + string + $secondname: фамилия
    -
    +
    - setName (line 323) + setName (line 326)
    +

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

    +

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

    • access: public
    @@ -1535,25 +1223,27 @@ setName - ([ $firstname = ""]) + ([string $firstname = ""])
    • - - $firstname
    • + string + $firstname: имя
    -
    +
    - setSecondName (line 250) + setSecondName (line 266)
    +

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

    +

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

    • access: public
    @@ -1563,25 +1253,27 @@ setSecondName - ([ $secondname = ""]) + ([string $secondname = ""])
    • - - $secondname
    • + string + $secondname: фамилия
    - -
    + +
    - setSirname (line 349) + setSirName (line 346)
    +

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

    +

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

    • access: public
    @@ -1589,27 +1281,28 @@
    void - setSirname + setSirName - ([ $secondname = ""]) + ([string $secondname = ""])
    • - - $secondname
    • + string + $secondname: фамилия
    -
    +
    - setWorkingWord (line 91) + setWorkingWord (line 116)
    +

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

    • access: protected
    @@ -1619,104 +1312,57 @@ setWorkingWord - ( $word) + (string $word)
    • - - $word
    • + string + $word: слово, которое нужно установить
    -
    - -
    - -
    - solveGender (line 387) -
    - - -
      -
    • access: protected
    • -
    - -
    - void - - solveGender - - () -
    - - -
    - splitFullName (line 465) + splitFullName (line 494)
    +

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

    +

    Формат:

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

      +
    • return: формат в котором записано имя например 'N F S'
    • access: public
    - void + string splitFullName - ( $fullname) + (string $fullname)
    • - - $fullname
    • -
    - - -
    - -
    - -
    - WordCase (line 487) -
    - - -
      -
    • access: protected
    • -
    - -
    - void - - WordCase - - (NCLNameCaseWord $word) -
    - -
      -
    • - NCLNameCaseWord - $word
    • + string + $fullname: строка, для которой необходимо определить формат
    -
    +
    - wordForms (line 207) + wordForms (line 229)
    +

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

    • access: protected
    @@ -1726,19 +1372,19 @@ wordForms - ( $word,  $endings, [ $replaceLast = 0]) + (string $word, array $endings, [int $replaceLast = 0])
    • - - $word
    • + string + $word: слово, к которому нужно добавить окончания
    • - - $endings
    • + array + $endings: массив окончаний
    • - - $replaceLast
    • + int + $replaceLast: сколько последних букв нужно убрать с начального слова
    @@ -1749,7 +1395,7 @@

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

    \ No newline at end of file diff --git a/Docs/default/NCLNameCaseInterface.html b/Docs/default/NCLNameCaseInterface.html index a635e34..7280264 100644 --- a/Docs/default/NCLNameCaseInterface.html +++ b/Docs/default/NCLNameCaseInterface.html @@ -164,7 +164,7 @@ -
    +
    genderAutoDetect (line 26) @@ -187,7 +187,7 @@
    -
    +
    getFatherNameCase (line 34) @@ -215,7 +215,7 @@
    -
    +
    getFirstNameCase (line 30) @@ -243,7 +243,7 @@
    -
    +
    getFormatted (line 44) @@ -274,7 +274,7 @@
    -
    +
    getFormattedArray (line 42) @@ -302,7 +302,7 @@
    -
    +
    getSecondNameCase (line 32) @@ -330,7 +330,7 @@
    -
    +
    q (line 48) @@ -364,7 +364,7 @@
    -
    +
    qFatherName (line 40) @@ -398,7 +398,7 @@
    -
    +
    qFirstName (line 36) @@ -432,7 +432,7 @@
    -
    +
    qFullName (line 46) @@ -475,7 +475,7 @@
    -
    +
    qSecondName (line 38) @@ -509,7 +509,7 @@
    -
    +
    setFatherName (line 14) @@ -537,7 +537,7 @@
    -
    +
    setFirstName (line 10) @@ -565,7 +565,7 @@
    -
    +
    setFullName (line 18) @@ -599,7 +599,7 @@
    -
    +
    setGender (line 16) @@ -627,7 +627,7 @@
    -
    +
    setLastName (line 22) @@ -655,7 +655,7 @@
    -
    +
    setName (line 20) @@ -683,7 +683,7 @@
    -
    +
    setSecondName (line 12) @@ -711,7 +711,7 @@
    -
    +
    setSirname (line 24) @@ -739,7 +739,7 @@
    -
    +
    splitFullName (line 28) @@ -772,7 +772,7 @@

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

    \ No newline at end of file diff --git a/Docs/default/NCLNameCaseRu.html b/Docs/default/NCLNameCaseRu.html index 5137242..8c99475 100644 --- a/Docs/default/NCLNameCaseRu.html +++ b/Docs/default/NCLNameCaseRu.html @@ -62,7 +62,7 @@
    - mixed + int $CaseCount
    @@ -103,12 +103,12 @@ (NCLNameCaseWord $word)
    - void + boolean manFatherName ()
    - void + boolean manFirstName ()
    @@ -153,17 +153,17 @@ ()
    - void + boolean manSecondName ()
    - void + boolean womanFatherName ()
    - void + boolean womanFirstName ()
    @@ -188,7 +188,7 @@ ()
    - void + boolean womanSecondName ()
    @@ -214,13 +214,14 @@
    - mixed + int $CaseCount - = 6 (line 22) + = 6 (line 21)
    +

    Количество падежей в языке

    • access: protected
    @@ -235,22 +236,7 @@

    Inherited from NCLNameCaseCore

    - NCLNameCaseCore::$finished
    -
    - - NCLNameCaseCore::$index
    -
    - NCLNameCaseCore::$lastResult
    -
    - - NCLNameCaseCore::$lastRule
    -
    - - NCLNameCaseCore::$ready
    -
    - - NCLNameCaseCore::$words
    NCLNameCaseCore::$workindLastCache
    @@ -327,10 +313,12 @@
    - detectNamePart (line 595) + detectNamePart (line 592)
    +

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

    +

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

    • access: protected
    @@ -346,7 +334,7 @@
    • NCLNameCaseWord - $word
    • + $word: обьект класса слов, который необходимо идентифицировать
    @@ -355,10 +343,11 @@
    - GenderByFatherName (line 574) + GenderByFatherName (line 571)
    +

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

    • access: protected
    @@ -374,7 +363,7 @@
    • NCLNameCaseWord - $word
    • + $word: обьект класса слов, для которого нужно определить пол
    @@ -383,10 +372,11 @@
    - GenderByFirstName (line 486) + GenderByFirstName (line 475)
    +

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

    • access: protected
    @@ -402,7 +392,7 @@
    • NCLNameCaseWord - $word
    • + $word: обьект класса слов, для которого нужно определить пол
    @@ -411,10 +401,11 @@
    - GenderBySecondName (line 549) + GenderBySecondName (line 542)
    +

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

    • access: protected
    @@ -430,7 +421,7 @@
    • NCLNameCaseWord - $word
    • + $word: обьект класса слов, для которого нужно определить пол
    @@ -439,16 +430,18 @@
    - manFatherName (line 453) + manFatherName (line 440)
    +

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

      +
    • return: true - если слово было успешно изменено, false - если не получилось этого сделать
    • access: protected
    - void + boolean manFatherName @@ -462,16 +455,18 @@
    - manFirstName (line 409) + manFirstName (line 404)
    +

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

      +
    • return: true - если было использовано правило из списка, false - если правило не было найденым
    • access: protected
    - void + boolean manFirstName @@ -485,13 +480,14 @@
    - manRule1 (line 54) + manRule1 (line 52)

    Мужские имена, оканчивающиеся на любой ь и -й,

    скло­няются так же, как обычные существительные мужского рода

      +
    • return: true если правило было задействовано и false если нет.
    • access: protected
    @@ -510,13 +506,14 @@
    - manRule2 (line 79) + manRule2 (line 77)

    Мужские имена, оканчивающиеся на любой твердый согласный,

    склоняются так же, как обычные существительные мужского рода

      +
    • return: true если правило было задействовано и false если нет.
    • access: protected
    @@ -535,13 +532,14 @@
    - manRule3 (line 112) + manRule3 (line 110)

    Мужские и женские имена, оканчивающиеся на -а, склоняются, как и любые

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

      +
    • return: true если правило было задействовано и false если нет.
    • access: protected
    @@ -560,13 +558,14 @@
    - manRule4 (line 143) + manRule4 (line 141)

    Мужские фамилии, оканчивающиеся на -ь -й, склоняются так же,

    как обычные существительные мужского рода

      +
    • return: true если правило было задействовано и false если нет.
    • access: protected
    @@ -585,12 +584,13 @@
    - manRule5 (line 182) + manRule5 (line 180)

    Мужские фамилии, оканчивающиеся на -к

      +
    • return: true если правило было задействовано и false если нет.
    • access: protected
    @@ -609,12 +609,13 @@
    - manRule6 (line 213) + manRule6 (line 211)

    Мужские фамили на согласный выбираем ем/ом/ым

      +
    • return: true если правило было задействовано и false если нет.
    • access: protected
    @@ -633,12 +634,13 @@
    - manRule7 (line 240) + manRule7 (line 238)

    Мужские фамили на -а -я

      +
    • return: true если правило было задействовано и false если нет.
    • access: protected
    @@ -657,12 +659,13 @@
    - manRule8 (line 277) + manRule8 (line 275)

    Не склоняются мужский фамилии

      +
    • return: true если правило было задействовано и false если нет.
    • access: protected
    @@ -681,16 +684,18 @@
    - manSecondName (line 431) + manSecondName (line 422)
    +

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

      +
    • return: true - если было использовано правило из списка, false - если правило не было найденым
    • access: protected
    - void + boolean manSecondName @@ -704,16 +709,18 @@
    - womanFatherName (line 475) + womanFatherName (line 460)
    +

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

      +
    • return: true - если слово было успешно изменено, false - если не получилось этого сделать
    • access: protected
    - void + boolean womanFatherName @@ -727,16 +734,18 @@
    - womanFirstName (line 420) + womanFirstName (line 413)
    +

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

      +
    • return: true - если было использовано правило из списка, false - если правило не было найденым
    • access: protected
    - void + boolean womanFirstName @@ -750,13 +759,14 @@
    - womanRule1 (line 293) + womanRule1 (line 291)

    Мужские и женские имена, оканчивающиеся на -а, склоняются,

    как и любые существительные с таким же окончанием

      +
    • return: true если правило было задействовано и false если нет.
    • access: protected
    @@ -775,13 +785,14 @@
    - womanRule2 (line 328) + womanRule2 (line 326)

    Мужские и женские имена, оканчивающиеся иа -я, -ья, -ия, -ея, независимо от языка,

    из которого они происходят, склоняются как сущест­вительные с соответствующими окончаниями

      +
    • return: true если правило было задействовано и false если нет.
    • access: protected
    @@ -800,13 +811,14 @@
    - womanRule3 (line 353) + womanRule3 (line 351)

    Русские женские имена, оканчивающиеся на мягкий согласный, склоняются,

    как существительные женского рода типа дочь, тень

      +
    • return: true если правило было задействовано и false если нет.
    • access: protected
    @@ -825,13 +837,14 @@
    - womanRule4 (line 369) + womanRule4 (line 367)

    Женские фамилия, оканчивающиеся на -а -я, склоняются,

    как и любые существительные с таким же окончанием

      +
    • return: true если правило было задействовано и false если нет.
    • access: protected
    @@ -850,16 +863,18 @@
    - womanSecondName (line 442) + womanSecondName (line 431)
    +

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

      +
    • return: true - если было использовано правило из списка, false - если правило не было найденым
    • access: protected
    \ No newline at end of file diff --git a/Docs/default/NCLNameCaseUa.html b/Docs/default/NCLNameCaseUa.html index f8ea232..d1664e5 100644 --- a/Docs/default/NCLNameCaseUa.html +++ b/Docs/default/NCLNameCaseUa.html @@ -216,22 +216,7 @@

    Inherited from NCLNameCaseCore

    - NCLNameCaseCore::$finished
    -
    - - NCLNameCaseCore::$index
    -
    - NCLNameCaseCore::$lastResult
    -
    - - NCLNameCaseCore::$lastRule
    -
    - - NCLNameCaseCore::$ready
    -
    - - NCLNameCaseCore::$words
    NCLNameCaseCore::$workindLastCache
    @@ -785,10 +770,8 @@

    Inherited From NCLNameCaseCore

    - NCLNameCaseCore::AllWordCases()
    NCLNameCaseCore::fullReset()
    NCLNameCaseCore::genderAutoDetect()
    - NCLNameCaseCore::generateIndex()
    NCLNameCaseCore::getFatherNameCase()
    NCLNameCaseCore::getFirstNameCase()
    NCLNameCaseCore::getFormatted()
    @@ -799,17 +782,11 @@ NCLNameCaseCore::in()
    NCLNameCaseCore::inNames()
    NCLNameCaseCore::Last()
    - NCLNameCaseCore::notReady()
    - NCLNameCaseCore::prepareAllNameParts()
    - NCLNameCaseCore::prepareEverything()
    - NCLNameCaseCore::prepareGender()
    - NCLNameCaseCore::prepareNamePart()
    NCLNameCaseCore::q()
    NCLNameCaseCore::qFatherName()
    NCLNameCaseCore::qFirstName()
    NCLNameCaseCore::qFullName()
    NCLNameCaseCore::qSecondName()
    - NCLNameCaseCore::reset()
    NCLNameCaseCore::Rule()
    NCLNameCaseCore::RulesChain()
    NCLNameCaseCore::setFatherName()
    @@ -819,11 +796,9 @@ NCLNameCaseCore::setLastName()
    NCLNameCaseCore::setName()
    NCLNameCaseCore::setSecondName()
    - NCLNameCaseCore::setSirname()
    + NCLNameCaseCore::setSirName()
    NCLNameCaseCore::setWorkingWord()
    - NCLNameCaseCore::solveGender()
    NCLNameCaseCore::splitFullName()
    - NCLNameCaseCore::WordCase()
    NCLNameCaseCore::wordForms()
    @@ -832,7 +807,7 @@

    - Documentation generated on Wed, 06 Jul 2011 00:21:04 +0300 by phpDocumentor 1.4.3 + Documentation generated on Wed, 06 Jul 2011 13:46:16 +0300 by phpDocumentor 1.4.3

    \ No newline at end of file diff --git a/Docs/default/NCLNameCaseWord.html b/Docs/default/NCLNameCaseWord.html index 2a9ff5b..090a056 100644 --- a/Docs/default/NCLNameCaseWord.html +++ b/Docs/default/NCLNameCaseWord.html @@ -55,59 +55,59 @@ (string $word)
    - void + int gender ()
    - void + array getGender ()
    - void + array getNameCases ()
    - void + string getNamePart ()
    - void + string getWord ()
    - void + bool isGenderSolved ()
    void setGender - ( $man,  $woman) + (int $man, int $woman)
    void setNameCases - ( $nameCases) + (array $nameCases)
    void setNamePart - ( $namePart) + (string $namePart)
    void setRule - ( $ruleID) + (int $ruleID)
    void setTrueGender - ( $gender) + (int $gender)
    @@ -126,14 +126,14 @@ -
    +
    Constructor __construct (line 79)
    -

    Создать запись из слова

    +

    Создание нового обьекта со словом $word

    • access: public
    @@ -149,25 +149,27 @@
    • string - $word
    • + $word: слово
    -
    +
    - gender (line 149) + gender (line 172)
    +

    Расчитывает и возвращает пол текущего слова

      +
    • return: пол текущего слова
    • access: public
    - void + int gender @@ -178,19 +180,21 @@
    -
    +
    - getGender (line 176) + getGender (line 215)
    +

    Возвращает массив вероятности того, что даное слово является мужчиной или женщиной

      +
    • return: массив вероятностей
    • access: public
    - void + array getGender @@ -201,19 +205,21 @@
    -
    +
    - getNameCases (line 144) + getNameCases (line 163)
    +

    Возвращает массив со всеми падежами текущего слова

      +
    • return: массив со всеми падежами
    • access: public
    - void + array getNameCases @@ -224,19 +230,22 @@
    -
    +
    - getNamePart (line 186) + getNamePart (line 241)
    +

    Возвращает тип текущего слова

    +

    Тип слова:

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

      +
    • return: тип слова
    • access: public
    - void + string getNamePart @@ -247,19 +256,21 @@
    -
    +
    - getWord (line 191) + getWord (line 250)
    +

    Возвращает текущее слово.

      +
    • return: текущее слово
    • access: public
    - void + string getWord @@ -270,19 +281,21 @@
    -
    +
    - isGenderSolved (line 196) + isGenderSolved (line 260)
    +

    Если уже был расчитан пол для всех слов системы, тогда каждому слову предается окончательное решение. Эта функция определяет было ли принято окончательное решение.

      +
    • return: было ли принято окончательное решение по поводу пола текущего слова
    • access: public
    - void + bool isGenderSolved @@ -293,13 +306,14 @@
    -
    +
    - setGender (line 165) + setGender (line 193)
    +

    Устанавливает вероятности того, что даное слово является мужчиной или женщиной

    • access: public
    @@ -309,28 +323,29 @@ setGender - ( $man,  $woman) + (int $man, int $woman)
    • - - $man
    • + int + $man: вероятность того, что слово мужчина
    • - - $woman
    • + int + $woman: верятность того, что слово женщина
    -
    +
    - setNameCases (line 138) + setNameCases (line 153)
    +

    Сохраняет результат склонения текущего слова

    • access: public
    @@ -340,25 +355,27 @@ setNameCases - ( $nameCases) + (array $nameCases)
    • - - $nameCases
    • + array + $nameCases: массив со всеми падежами
    -
    +
    - setNamePart (line 181) + setNamePart (line 228)
    +

    Устанавливает тип текущего слова

    +

    Тип слова:

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

    • access: public
    @@ -368,25 +385,26 @@ setNamePart - ( $namePart) + (string $namePart)
    • - - $namePart
    • + string + $namePart: тип слова
    -
    +
    - setRule (line 201) + setRule (line 269)
    +

    Устанавливает номер правила по которому склонялось текущее слово.

    • access: public
    @@ -396,25 +414,27 @@ setRule - ( $ruleID) + (int $ruleID)
    • - - $ruleID
    • + int + $ruleID: номер правила
    -
    +
    - setTrueGender (line 171) + setTrueGender (line 206)
    +

    Окончательно устанавливает пол человека

    +

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

    • access: public
    @@ -424,13 +444,13 @@ setTrueGender - ( $gender) + (int $gender)
    • - - $gender
    • + int + $gender: пол человека
    @@ -441,7 +461,7 @@

    - Documentation generated on Wed, 06 Jul 2011 00:21:05 +0300 by phpDocumentor 1.4.3 + Documentation generated on Wed, 06 Jul 2011 13:46:18 +0300 by phpDocumentor 1.4.3

    \ No newline at end of file diff --git a/Docs/default/NCLStr.html b/Docs/default/NCLStr.html index 04333f5..6362ce9 100644 --- a/Docs/default/NCLStr.html +++ b/Docs/default/NCLStr.html @@ -22,12 +22,13 @@
    -

    Description of NCLStr

    +

    Класс содержит функции для работы со строками, которые используются в NCLNameCaseLib

      -
    • author: seagull
    • +
    • author: Андрей Чайка <bymer3@gmail.com>
    • +
    • version: 0.4

    - Located in /NCL/NCLStr.php (line 13) + Located in /NCL/NCLStr.php (line 8)

    @@ -51,7 +52,7 @@
    - static mixed + static string $charset
    @@ -71,59 +72,59 @@
    - static void + static string connectLetters - ( $lettersArr) + (array $lettersArr)
    - static void + static array explode - ( $pattern,  $string) + (string $pattern, string $string)
    - static void + static bool isLowerCase - ( $phrase) + (string $phrase)
    - static void + static bool isUpperCase - ( $phrase) + (string $phrase)
    - static void + static array splitLetters - ( $phrase) + (string $phrase)
    - static void + static int strlen - ( $str) + (string $str)
    - static void + static int strpos - ( $haystack,  $needle, [ $offset = 0]) + (string $haystack, string $needle, [int $offset = 0])
    - static type + static int strrpos - (type $haystack, type $needle, [type $offset = null]) + (string $haystack, string $needle, [int $offset = null])
    - static void + static string strtolower - ( $str) + (string $str)
    - static void + static string strtoupper - ( $str) + (string $str)
    - static void + static int substr - ( $str,  $start, [ $length = null]) + (string $str, int $start, [int $length = null])
    @@ -144,17 +145,18 @@
    -
    +
    - static mixed + static string $charset - = 'utf-8' (line 16) + = 'utf-8' (line 14)
    +

    Кодировка, в котороя работает система

    @@ -177,309 +179,352 @@
    -
    +
    - static method connectLetters (line 92) + static method connectLetters (line 123)
    +

    Соединяет массив букв в строку

    +
      +
    • return: строка
    • +
    static - void + string connectLetters - ( $lettersArr) + (array $lettersArr)
    • - - $lettersArr
    • + array + $lettersArr: массив букв
    -
    +
    - static method explode (line 97) + static method explode (line 134)
    +

    Разбивает строку на части использую шаблон

    +
      +
    • return: разбитый массив
    • +
    static - void + array explode - ( $pattern,  $string) + (string $pattern, string $string)
    • - - $pattern
    • + string + $pattern: шаблон разбития
    • - - $string
    • + string + $string: строка, которую нужно разбить
    -
    +
    - static method isLowerCase (line 71) + static method isLowerCase (line 87)
    +

    Проверяет в нижнем ли регистре находится строка

    +
      +
    • return: в нижнем ли регистре строка
    • +
    static - void + bool isLowerCase - ( $phrase) + (string $phrase)
    • - - $phrase
    • + string + $phrase: строка
    -
    +
    - static method isUpperCase (line 76) + static method isUpperCase (line 97)
    +

    Проверяет в верхнем ли регистре находится строка

    +
      +
    • return: в верхнем ли регистре строка
    • +
    static - void + bool isUpperCase - ( $phrase) + (string $phrase)
    • - - $phrase
    • + string + $phrase: строка
    -
    +
    - static method splitLetters (line 81) + static method splitLetters (line 107)
    +

    Превращает строку в массив букв

    +
      +
    • return: массив букв
    • +
    static - void + array splitLetters - ( $phrase) + (string $phrase)
    • - - $phrase
    • + string + $phrase: строка
    -
    +
    - static method strlen (line 40) + static method strlen (line 45)
    +

    Определение длины строки

    +
      +
    • return: длина строки
    • +
    static - void + int strlen - ( $str) + (string $str)
    • - - $str
    • + string + $str: строка
    -
    +
    - static method strpos (line 31) + static method strpos (line 35)
    +

    Поиск подстроки в строке

    +
      +
    • return: позиция подстроки в строке
    • +
    static - void + int strpos - ( $haystack,  $needle, [ $offset = 0]) + (string $haystack, string $needle, [int $offset = 0])
    • - - $haystack
    • + string + $haystack: строка, в которой искать
    • - - $needle
    • + string + $needle: подстрока, которую нужно найти
    • - - $offset
    • + int + $offset: начало поиска
    -
    +
    - static method strrpos (line 66) + static method strrpos (line 77)
    -

    Обертка для strrpos

    +

    Поиск подстроки в строке справа

    +
      +
    • return: позиция подстроки в строке
    • +
    static - type + int strrpos - (type $haystack, type $needle, [type $offset = null]) + (string $haystack, string $needle, [int $offset = null])
    • - type - $haystack
    • + string + $haystack: строка, в которой искать
    • - type - $needle
    • + string + $needle: подстрока, которую нужно найти
    • - type - $offset
    • + int + $offset: начало поиска
    -
    +
    - static method strtolower (line 49) + static method strtolower (line 55)
    +

    Переводит строку в нижний регистр

    +
      +
    • return: строка в нижнем регистре
    • +
    static - void + string strtolower - ( $str) + (string $str)
    • - - $str
    • + string + $str: строка
    -
    +
    - static method strtoupper (line 54) + static method strtoupper (line 65)
    +

    Переводит строку в верхний регистр

    +
      +
    • return: строка в верхнем регистре
    • +
    static - void + string strtoupper - ( $str) + (string $str)
    • - - $str
    • + string + $str: строка
    -
    +
    - static method substr (line 22) + static method substr (line 23)
    +

    Получить подстроку из строки

    +
      +
    • return: подстрока
    • +
    static - void + int substr - ( $str,  $start, [ $length = null]) + (string $str, int $start, [int $length = null])
    • - - $str
    • + string + $str: строка
    • - - $start
    • + int + $start: начало подстроки
    • - - $length
    • + int + $length: длина подстроки
    @@ -491,7 +536,7 @@

    - Documentation generated on Wed, 06 Jul 2011 00:21:05 +0300 by phpDocumentor 1.4.3 + Documentation generated on Wed, 06 Jul 2011 13:46:18 +0300 by phpDocumentor 1.4.3

    \ No newline at end of file diff --git a/Docs/default/_NCL---NCL.php.html b/Docs/default/_NCL---NCL.php.html index f1a5c6f..ceefcad 100644 --- a/Docs/default/_NCL---NCL.php.html +++ b/Docs/default/_NCL---NCL.php.html @@ -54,7 +54,7 @@

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

    \ No newline at end of file diff --git a/Docs/default/_NCL---NCLNameCaseCore.php.html b/Docs/default/_NCL---NCLNameCaseCore.php.html index e1d19e4..b979ca3 100644 --- a/Docs/default/_NCL---NCLNameCaseCore.php.html +++ b/Docs/default/_NCL---NCLNameCaseCore.php.html @@ -64,7 +64,7 @@
    -
    +
    @@ -78,7 +78,7 @@
    -
    +
    @@ -92,7 +92,7 @@
    -
    +
    @@ -106,7 +106,7 @@
    -
    +
    @@ -133,7 +133,7 @@
    -
    +
    @@ -152,7 +152,7 @@

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

    \ No newline at end of file diff --git a/Docs/default/_NCL---NCLNameCaseInterface.php.html b/Docs/default/_NCL---NCLNameCaseInterface.php.html index 563d45e..4d19404 100644 --- a/Docs/default/_NCL---NCLNameCaseInterface.php.html +++ b/Docs/default/_NCL---NCLNameCaseInterface.php.html @@ -54,7 +54,7 @@

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

    \ No newline at end of file diff --git a/Docs/default/_NCL---NCLNameCaseWord.php.html b/Docs/default/_NCL---NCLNameCaseWord.php.html index 50ddf04..acf6ee1 100644 --- a/Docs/default/_NCL---NCLNameCaseWord.php.html +++ b/Docs/default/_NCL---NCLNameCaseWord.php.html @@ -54,7 +54,7 @@

    - Documentation generated on Wed, 06 Jul 2011 00:21:05 +0300 by phpDocumentor 1.4.3 + Documentation generated on Wed, 06 Jul 2011 13:46:18 +0300 by phpDocumentor 1.4.3

    \ No newline at end of file diff --git a/Docs/default/_NCL---NCLStr.php.html b/Docs/default/_NCL---NCLStr.php.html index d393ba7..581d868 100644 --- a/Docs/default/_NCL---NCLStr.php.html +++ b/Docs/default/_NCL---NCLStr.php.html @@ -42,7 +42,7 @@ NCLStr - Description of NCLStr + Класс содержит функции для работы со строками, которые используются в NCLNameCaseLib @@ -54,7 +54,7 @@

    - Documentation generated on Wed, 06 Jul 2011 00:21:05 +0300 by phpDocumentor 1.4.3 + Documentation generated on Wed, 06 Jul 2011 13:46:18 +0300 by phpDocumentor 1.4.3

    \ No newline at end of file diff --git a/Docs/default/_NCL.NameCase.ru.php.html b/Docs/default/_NCL.NameCase.ru.php.html index 230eed0..271aca1 100644 --- a/Docs/default/_NCL.NameCase.ru.php.html +++ b/Docs/default/_NCL.NameCase.ru.php.html @@ -81,7 +81,7 @@

    - Documentation generated on Wed, 06 Jul 2011 00:21:03 +0300 by phpDocumentor 1.4.3 + Documentation generated on Wed, 06 Jul 2011 13:46:15 +0300 by phpDocumentor 1.4.3

    \ No newline at end of file diff --git a/Docs/default/_NCL.NameCase.ua.php.html b/Docs/default/_NCL.NameCase.ua.php.html index e7e2bad..9bac925 100644 --- a/Docs/default/_NCL.NameCase.ua.php.html +++ b/Docs/default/_NCL.NameCase.ua.php.html @@ -88,7 +88,7 @@

    - Documentation generated on Wed, 06 Jul 2011 00:21:04 +0300 by phpDocumentor 1.4.3 + Documentation generated on Wed, 06 Jul 2011 13:46:16 +0300 by phpDocumentor 1.4.3

    \ No newline at end of file diff --git a/Docs/elementindex.html b/Docs/elementindex.html index f95cfce..025329b 100644 --- a/Docs/elementindex.html +++ b/Docs/elementindex.html @@ -12,11 +12,10 @@

    Full index

    Package indexes


    - a c d e @@ -37,20 +36,6 @@ _
    - -
    -
    a
    - -
    -
    -
    -
    - AllWordCases -
    -
    -
    NCLNameCaseCore::AllWordCases() in NCLNameCaseCore.php
    -
    -
    c
    @@ -62,26 +47,29 @@ $CaseCount
    -
    NCLNameCaseRu::$CaseCount in NCL.NameCase.ru.php
    +
    NCLNameCaseRu::$CaseCount in NCL.NameCase.ru.php
    +
    Количество падежей в языке
    $CaseCount
    -
    NCLNameCaseUa::$CaseCount in NCL.NameCase.ua.php
    +
    NCLNameCaseUa::$CaseCount in NCL.NameCase.ua.php
    Количество падежей в языке
    $charset
    -
    NCLStr::$charset in NCLStr.php
    +
    NCLStr::$charset in NCLStr.php
    +
    Кодировка, в котороя работает система
    connectLetters
    - + +
    Соединяет массив букв в строку
    @@ -95,21 +83,22 @@ $DATELN
    -
    NCL::$DATELN in NCL.php
    +
    NCL::$DATELN in NCL.php
    Дательный падеж
    detectNamePart
    -
    NCLNameCaseUa::detectNamePart() in NCL.NameCase.ua.php
    +
    NCLNameCaseUa::detectNamePart() in NCL.NameCase.ua.php
    Ідентифікує слово визначаючи чи це ім’я, чи це прізвище, чи це побатькові
    detectNamePart
    -
    NCLNameCaseRu::detectNamePart() in NCL.NameCase.ru.php
    +
    NCLNameCaseRu::detectNamePart() in NCL.NameCase.ru.php
    +
    Идетифицирует слово определяе имя это, или фамилия, или отчество
    @@ -123,7 +112,8 @@ explode
    -
    NCLStr::explode() in NCLStr.php
    +
    NCLStr::explode() in NCLStr.php
    +
    Разбивает строку на части использую шаблон
    @@ -133,18 +123,12 @@
    -
    - $finished -
    -
    -
    NCLNameCaseCore::$finished in NCLNameCaseCore.php
    -
    Все слова уже просклонялись
    -
    fullReset
    -
    NCLNameCaseCore::fullReset() in NCLNameCaseCore.php
    +
    NCLNameCaseCore::fullReset() in NCLNameCaseCore.php
    +
    Сбрасывает все информацию на начальную. Очищает все слова добавленые в систему.
    @@ -158,160 +142,170 @@ gender
    -
    NCLNameCaseWord::gender() in NCLNameCaseWord.php
    +
    NCLNameCaseWord::gender() in NCLNameCaseWord.php
    +
    Расчитывает и возвращает пол текущего слова
    genderAutoDetect
    -
    NCLNameCaseInterface::genderAutoDetect() in NCLNameCaseInterface.php
    +
    NCLNameCaseInterface::genderAutoDetect() in NCLNameCaseInterface.php
    genderAutoDetect
    - + +
    По указаным словам определяется пол человека:
    GenderByFatherName
    - + +
    Определение пола по правилам отчеств
    GenderByFatherName
    - +
    Визначення статі, за правилами по-батькові
    GenderByFirstName
    -
    NCLNameCaseRu::GenderByFirstName() in NCL.NameCase.ru.php
    +
    NCLNameCaseRu::GenderByFirstName() in NCL.NameCase.ru.php
    +
    Определение пола по правилам имен
    GenderByFirstName
    -
    NCLNameCaseUa::GenderByFirstName() in NCL.NameCase.ua.php
    +
    NCLNameCaseUa::GenderByFirstName() in NCL.NameCase.ua.php
    Визначення статі, за правилами імені
    GenderBySecondName
    - +
    Визначення статі, за правилами прізвища
    GenderBySecondName
    - -
    -
    - generateIndex -
    -
    -
    NCLNameCaseCore::generateIndex() in NCLNameCaseCore.php
    + +
    Определение пола по правилам фамилий
    getFatherNameCase
    -
    NCLNameCaseInterface::getFatherNameCase() in NCLNameCaseInterface.php
    + +
    Функция ставит отчество в нужный падеж.
    getFatherNameCase
    - +
    NCLNameCaseInterface::getFatherNameCase() in NCLNameCaseInterface.php
    getFirstNameCase
    - +
    NCLNameCaseInterface::getFirstNameCase() in NCLNameCaseInterface.php
    getFirstNameCase
    -
    NCLNameCaseInterface::getFirstNameCase() in NCLNameCaseInterface.php
    + +
    Функция ставит имя в нужный падеж.
    getFormatted
    -
    NCLNameCaseCore::getFormatted() in NCLNameCaseCore.php
    +
    NCLNameCaseInterface::getFormatted() in NCLNameCaseInterface.php
    getFormatted
    -
    NCLNameCaseInterface::getFormatted() in NCLNameCaseInterface.php
    +
    NCLNameCaseCore::getFormatted() in NCLNameCaseCore.php
    +
    Склоняет текущие слова в падеж $caseNum и форматирует слово по шаблону $format
    getFormattedArray
    -
    NCLNameCaseInterface::getFormattedArray() in NCLNameCaseInterface.php
    + +
    Склоняет текущие слова во все падежи и форматирует слово по шаблону $format
    getFormattedArray
    - +
    NCLNameCaseInterface::getFormattedArray() in NCLNameCaseInterface.php
    getFormattedArrayHard
    - + +
    Склоняет текущие слова во все падежи и форматирует слово по шаблону $format
    getFormattedHard
    - + +
    Склоняет текущие слова в падеж $caseNum и форматирует слово по шаблону $format
    getGender
    -
    NCLNameCaseWord::getGender() in NCLNameCaseWord.php
    +
    NCLNameCaseWord::getGender() in NCLNameCaseWord.php
    +
    Возвращает массив вероятности того, что даное слово является мужчиной или женщиной
    getNameCases
    -
    NCLNameCaseWord::getNameCases() in NCLNameCaseWord.php
    +
    NCLNameCaseWord::getNameCases() in NCLNameCaseWord.php
    +
    Возвращает массив со всеми падежами текущего слова
    getNamePart
    -
    NCLNameCaseWord::getNamePart() in NCLNameCaseWord.php
    +
    NCLNameCaseWord::getNamePart() in NCLNameCaseWord.php
    +
    Возвращает тип текущего слова
    getSecondNameCase
    -
    NCLNameCaseInterface::getSecondNameCase() in NCLNameCaseInterface.php
    + +
    Функция ставит фамилию в нужный падеж.
    getSecondNameCase
    - +
    NCLNameCaseInterface::getSecondNameCase() in NCLNameCaseInterface.php
    getWord
    -
    NCLNameCaseWord::getWord() in NCLNameCaseWord.php
    +
    NCLNameCaseWord::getWord() in NCLNameCaseWord.php
    +
    Возвращает текущее слово.
    @@ -325,45 +319,43 @@ $IMENITLN
    -
    NCL::$IMENITLN in NCL.php
    +
    NCL::$IMENITLN in NCL.php
    Именительный падеж
    -
    - $index -
    -
    -
    NCLNameCaseCore::$index in NCLNameCaseCore.php
    -
    in
    -
    NCLNameCaseCore::in() in NCLNameCaseCore.php
    +
    NCLNameCaseCore::in() in NCLNameCaseCore.php
    +
    Если $string строка, тогда проверяется входит ли буква $letter в строку $string
    inNames
    -
    NCLNameCaseCore::inNames() in NCLNameCaseCore.php
    -
    Функция проверяет, входит ли имя в перечень имен.
    +
    NCLNameCaseCore::inNames() in NCLNameCaseCore.php
    +
    Функция проверяет, входит ли имя $nameNeedle в перечень имен $names.
    isGenderSolved
    -
    NCLNameCaseWord::isGenderSolved() in NCLNameCaseWord.php
    +
    NCLNameCaseWord::isGenderSolved() in NCLNameCaseWord.php
    +
    Если уже был расчитан пол для всех слов системы, тогда каждому слову предается окончательное решение. Эта функция определяет было ли принято окончательное решение.
    isLowerCase
    -
    NCLStr::isLowerCase() in NCLStr.php
    +
    NCLStr::isLowerCase() in NCLStr.php
    +
    Проверяет в нижнем ли регистре находится строка
    isUpperCase
    -
    NCLStr::isUpperCase() in NCLStr.php
    +
    NCLStr::isUpperCase() in NCLStr.php
    +
    Проверяет в верхнем ли регистре находится строка
    @@ -377,21 +369,15 @@ $lastResult
    -
    NCLNameCaseCore::$lastResult in NCLNameCaseCore.php
    -
    Просклоненое слово
    -
    -
    - $lastRule -
    -
    -
    NCLNameCaseCore::$lastRule in NCLNameCaseCore.php
    -
    Последние правило
    +
    NCLNameCaseCore::$lastResult in NCLNameCaseCore.php
    +
    Массив содержит результат склонения слова - слово во всех падежах
    Last
    -
    NCLNameCaseCore::Last() in NCLNameCaseCore.php
    +
    NCLNameCaseCore::Last() in NCLNameCaseCore.php
    +
    Если $stopAfter = 0, тогда вырезает $length последних букв с текущего слова ($this->workingWord)
    @@ -405,137 +391,140 @@ $MAN
    -
    NCL::$MAN in NCL.php
    +
    NCL::$MAN in NCL.php
    Мужской пол
    manFatherName
    -
    NCLNameCaseUa::manFatherName() in NCL.NameCase.ua.php
    +
    NCLNameCaseUa::manFatherName() in NCL.NameCase.ua.php
    Фунція відмінює чоловічі по-батькові
    manFatherName
    -
    NCLNameCaseRu::manFatherName() in NCL.NameCase.ru.php
    +
    NCLNameCaseRu::manFatherName() in NCL.NameCase.ru.php
    +
    Функция склоняет мужский отчества
    manFirstName
    -
    NCLNameCaseUa::manFirstName() in NCL.NameCase.ua.php
    +
    NCLNameCaseUa::manFirstName() in NCL.NameCase.ua.php
    Функція намагається застосувати ланцюг правил для чоловічих імен
    manFirstName
    -
    NCLNameCaseRu::manFirstName() in NCL.NameCase.ru.php
    +
    NCLNameCaseRu::manFirstName() in NCL.NameCase.ru.php
    +
    Функция пытается применить цыпочку правил для мужских имен
    manRule1
    -
    NCLNameCaseUa::manRule1() in NCL.NameCase.ua.php
    +
    NCLNameCaseUa::manRule1() in NCL.NameCase.ua.php
    Українські чоловічі та жіночі імена, що в називному відмінку однини закінчуються на -а (-я), відмінються як відповідні іменники І відміни.
    manRule1
    -
    NCLNameCaseRu::manRule1() in NCL.NameCase.ru.php
    +
    NCLNameCaseRu::manRule1() in NCL.NameCase.ru.php
    Мужские имена, оканчивающиеся на любой ь и -й,
    manRule2
    -
    NCLNameCaseUa::manRule2() in NCL.NameCase.ua.php
    +
    NCLNameCaseUa::manRule2() in NCL.NameCase.ua.php
    Імена, що в називному відмінку закінчуються на -р, у родовому мають закінчення -а: Віктор - Віктора, Макар - Макара, але: Ігор - Ігоря, Лазар - Лазаря.
    manRule2
    -
    NCLNameCaseRu::manRule2() in NCL.NameCase.ru.php
    +
    NCLNameCaseRu::manRule2() in NCL.NameCase.ru.php
    Мужские имена, оканчивающиеся на любой твердый согласный,
    manRule3
    -
    NCLNameCaseRu::manRule3() in NCL.NameCase.ru.php
    +
    NCLNameCaseRu::manRule3() in NCL.NameCase.ru.php
    Мужские и женские имена, оканчивающиеся на -а, склоняются, как и любые
    manRule3
    -
    NCLNameCaseUa::manRule3() in NCL.NameCase.ua.php
    +
    NCLNameCaseUa::manRule3() in NCL.NameCase.ua.php
    Українські чоловічі імена, що в називному відмінку однини закінчуються на приголосний та -о, відмінюються як відповідні іменники ІІ відміни.
    manRule4
    -
    NCLNameCaseUa::manRule4() in NCL.NameCase.ua.php
    +
    NCLNameCaseUa::manRule4() in NCL.NameCase.ua.php
    Якщо слово закінчується на і, то відмінюємо як множину
    manRule4
    -
    NCLNameCaseRu::manRule4() in NCL.NameCase.ru.php
    +
    NCLNameCaseRu::manRule4() in NCL.NameCase.ru.php
    Мужские фамилии, оканчивающиеся на -ь -й, склоняются так же,
    manRule5
    -
    NCLNameCaseRu::manRule5() in NCL.NameCase.ru.php
    +
    NCLNameCaseRu::manRule5() in NCL.NameCase.ru.php
    Мужские фамилии, оканчивающиеся на -к
    manRule5
    -
    NCLNameCaseUa::manRule5() in NCL.NameCase.ua.php
    +
    NCLNameCaseUa::manRule5() in NCL.NameCase.ua.php
    Якщо слово закінчується на ий або ой
    manRule6
    -
    NCLNameCaseRu::manRule6() in NCL.NameCase.ru.php
    +
    NCLNameCaseRu::manRule6() in NCL.NameCase.ru.php
    Мужские фамили на согласный выбираем ем/ом/ым
    manRule7
    -
    NCLNameCaseRu::manRule7() in NCL.NameCase.ru.php
    +
    NCLNameCaseRu::manRule7() in NCL.NameCase.ru.php
    Мужские фамили на -а -я
    manRule8
    -
    NCLNameCaseRu::manRule8() in NCL.NameCase.ru.php
    +
    NCLNameCaseRu::manRule8() in NCL.NameCase.ru.php
    Не склоняются мужский фамилии
    manSecondName
    -
    NCLNameCaseRu::manSecondName() in NCL.NameCase.ru.php
    +
    NCLNameCaseRu::manSecondName() in NCL.NameCase.ru.php
    +
    Функция пытается применить цыпочку правил для мужских фамилий
    manSecondName
    -
    NCLNameCaseUa::manSecondName() in NCL.NameCase.ua.php
    +
    NCLNameCaseUa::manSecondName() in NCL.NameCase.ua.php
    Функція намагається застосувати ланцюг правил для чоловічих прізвищ
    @@ -550,103 +539,98 @@ NCL
    -
    NCL in NCL.php
    -
    Класс, который содержит основные константы библиотеки:
    +
    NCL in NCL.php
    +
    Класс, который содержит основные константы библиотеки:
    • индексы мужского и женского пола
    • индексы всех падежей
    NCL.php
    -
    NCL.php in NCL.php
    +
    NCL.php in NCL.php
    NCLNameCaseCore.php
    -
    NCLNameCaseCore.php in NCLNameCaseCore.php
    +
    NCLNameCaseCore.php in NCLNameCaseCore.php
    NCLNameCaseInterface.php
    -
    NCLNameCaseInterface.php in NCLNameCaseInterface.php
    +
    NCLNameCaseInterface.php in NCLNameCaseInterface.php
    NCLNameCaseWord.php
    -
    NCLNameCaseWord.php in NCLNameCaseWord.php
    +
    NCLNameCaseWord.php in NCLNameCaseWord.php
    NCLStr.php
    -
    NCLStr.php in NCLStr.php
    +
    NCLStr.php in NCLStr.php
    NCL.NameCase.ru.php
    -
    NCL.NameCase.ru.php in NCL.NameCase.ru.php
    +
    NCL.NameCase.ru.php in NCL.NameCase.ru.php
    NCL.NameCase.ua.php
    -
    NCL.NameCase.ua.php in NCL.NameCase.ua.php
    +
    NCL.NameCase.ua.php in NCL.NameCase.ua.php
    NCLNameCaseCore
    -
    NCLNameCaseCore in NCLNameCaseCore.php
    -
    Класс, который содержит основные константы библиотеки:
    +
    NCLNameCaseCore in NCLNameCaseCore.php
    +
    NCL NameCase Core
    NCLNameCaseInterface
    -
    NCLNameCaseInterface in NCLNameCaseInterface.php
    +
    NCLNameCaseInterface in NCLNameCaseInterface.php
    +
    Интерфейс для русского и украинского языка
    NCLNameCaseRu
    -
    NCLNameCaseRu in NCL.NameCase.ru.php
    -
    Класс, который содержит основные константы библиотеки:
    +
    NCLNameCaseRu in NCL.NameCase.ru.php
    +
    NCL NameCase Russian Language
    NCLNameCaseUa
    -
    NCLNameCaseUa in NCL.NameCase.ua.php
    -
    Класс, который содержит основные константы библиотеки:
    +
    NCLNameCaseUa in NCL.NameCase.ua.php
    +
    NCL NameCase Ukranian Language
    NCLNameCaseWord
    -
    NCLNameCaseWord in NCLNameCaseWord.php
    +
    NCLNameCaseWord in NCLNameCaseWord.php
    NCLNameCaseWord - класс, который служит для хранения всей информации о каждом слове
    NCLStr
    -
    NCLStr in NCLStr.php
    -
    Description of NCLStr
    +
    NCLStr in NCLStr.php
    +
    Класс содержит функции для работы со строками, которые используются в NCLNameCaseLib
    NCL_DIR
    -
    NCL_DIR in NCLNameCaseCore.php
    -
    -
    - notReady -
    -
    -
    NCLNameCaseCore::notReady() in NCLNameCaseCore.php
    +
    NCL_DIR in NCLNameCaseCore.php
    @@ -660,33 +644,9 @@ $PREDLOGN
    -
    NCL::$PREDLOGN in NCL.php
    +
    NCL::$PREDLOGN in NCL.php
    Предложный падеж
    -
    - prepareAllNameParts -
    -
    - -
    -
    - prepareEverything -
    -
    - -
    -
    - prepareGender -
    -
    -
    NCLNameCaseCore::prepareGender() in NCLNameCaseCore.php
    -
    -
    - prepareNamePart -
    -
    -
    NCLNameCaseCore::prepareNamePart() in NCLNameCaseCore.php
    -
    @@ -699,61 +659,66 @@ q
    -
    NCLNameCaseInterface::q() in NCLNameCaseInterface.php
    +
    NCLNameCaseInterface::q() in NCLNameCaseInterface.php
    q
    -
    NCLNameCaseCore::q() in NCLNameCaseCore.php
    +
    NCLNameCaseCore::q() in NCLNameCaseCore.php
    +
    Склоняет ФИО $fullname в падеж $caseNum по правилам пола $gender.
    qFatherName
    -
    NCLNameCaseInterface::qFatherName() in NCLNameCaseInterface.php
    +
    NCLNameCaseInterface::qFatherName() in NCLNameCaseInterface.php
    qFatherName
    -
    NCLNameCaseCore::qFatherName() in NCLNameCaseCore.php
    +
    NCLNameCaseCore::qFatherName() in NCLNameCaseCore.php
    +
    Функция ставит отчество $fatherName в нужный падеж $CaseNumber по правилам пола $gender.
    qFirstName
    -
    NCLNameCaseInterface::qFirstName() in NCLNameCaseInterface.php
    +
    NCLNameCaseInterface::qFirstName() in NCLNameCaseInterface.php
    qFirstName
    -
    NCLNameCaseCore::qFirstName() in NCLNameCaseCore.php
    +
    NCLNameCaseCore::qFirstName() in NCLNameCaseCore.php
    +
    Функция ставит имя $firstName в нужный падеж $CaseNumber по правилам пола $gender.
    qFullName
    -
    NCLNameCaseInterface::qFullName() in NCLNameCaseInterface.php
    +
    NCLNameCaseInterface::qFullName() in NCLNameCaseInterface.php
    qFullName
    -
    NCLNameCaseCore::qFullName() in NCLNameCaseCore.php
    +
    NCLNameCaseCore::qFullName() in NCLNameCaseCore.php
    +
    Склоняет фамилию $secondName, имя $firstName, отчество $fatherName
    qSecondName
    -
    NCLNameCaseInterface::qSecondName() in NCLNameCaseInterface.php
    +
    NCLNameCaseInterface::qSecondName() in NCLNameCaseInterface.php
    qSecondName
    -
    NCLNameCaseCore::qSecondName() in NCLNameCaseCore.php
    +
    NCLNameCaseCore::qSecondName() in NCLNameCaseCore.php
    +
    Функция ставит фамилию $secondName в нужный падеж $CaseNumber по правилам пола $gender.
    @@ -763,40 +728,26 @@
    -
    - $ready -
    -
    -
    NCLNameCaseCore::$ready in NCLNameCaseCore.php
    -
    Система уже готово к склонению или нет
    -
    $RODITLN
    -
    NCL::$RODITLN in NCL.php
    +
    NCL::$RODITLN in NCL.php
    Родительный падеж
    -
    - reset -
    -
    -
    NCLNameCaseCore::reset() in NCLNameCaseCore.php
    -
    Сброс всех настроек
    -
    Rule
    -
    NCLNameCaseCore::Rule() in NCLNameCaseCore.php
    -
    Установить номер парвила
    +
    NCLNameCaseCore::Rule() in NCLNameCaseCore.php
    +
    Устанавливает номер последнего правила
    RulesChain
    -
    NCLNameCaseCore::RulesChain() in NCLNameCaseCore.php
    -
    Выполняет над словом типа $gender (man / woman) в порядке указанов в $rulesArray
    +
    NCLNameCaseCore::RulesChain() in NCLNameCaseCore.php
    +
    Над текущим словом ($this->workingWord) выполняются правила в порядке указаном в $rulesArray.
    @@ -810,194 +761,209 @@ setFatherName
    -
    NCLNameCaseCore::setFatherName() in NCLNameCaseCore.php
    +
    NCLNameCaseCore::setFatherName() in NCLNameCaseCore.php
    +
    В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord
    setFatherName
    -
    NCLNameCaseInterface::setFatherName() in NCLNameCaseInterface.php
    +
    NCLNameCaseInterface::setFatherName() in NCLNameCaseInterface.php
    setFirstName
    -
    NCLNameCaseInterface::setFirstName() in NCLNameCaseInterface.php
    +
    NCLNameCaseCore::setFirstName() in NCLNameCaseCore.php
    +
    В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord
    setFirstName
    -
    NCLNameCaseCore::setFirstName() in NCLNameCaseCore.php
    +
    NCLNameCaseInterface::setFirstName() in NCLNameCaseInterface.php
    setFullName
    -
    NCLNameCaseCore::setFullName() in NCLNameCaseCore.php
    +
    NCLNameCaseInterface::setFullName() in NCLNameCaseInterface.php
    setFullName
    -
    NCLNameCaseInterface::setFullName() in NCLNameCaseInterface.php
    +
    NCLNameCaseCore::setFullName() in NCLNameCaseCore.php
    +
    В система заносится сразу фамилия, имя, отчество
    setGender
    -
    NCLNameCaseWord::setGender() in NCLNameCaseWord.php
    +
    NCLNameCaseInterface::setGender() in NCLNameCaseInterface.php
    setGender
    -
    NCLNameCaseCore::setGender() in NCLNameCaseCore.php
    +
    NCLNameCaseWord::setGender() in NCLNameCaseWord.php
    +
    Устанавливает вероятности того, что даное слово является мужчиной или женщиной
    setGender
    -
    NCLNameCaseInterface::setGender() in NCLNameCaseInterface.php
    +
    NCLNameCaseCore::setGender() in NCLNameCaseCore.php
    +
    Всем словам устанавливается пол, который может иметь следующие значения
    setLastName
    -
    NCLNameCaseInterface::setLastName() in NCLNameCaseInterface.php
    +
    NCLNameCaseCore::setLastName() in NCLNameCaseCore.php
    +
    В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord
    setLastName
    -
    NCLNameCaseCore::setLastName() in NCLNameCaseCore.php
    +
    NCLNameCaseInterface::setLastName() in NCLNameCaseInterface.php
    setName
    -
    NCLNameCaseInterface::setName() in NCLNameCaseInterface.php
    +
    NCLNameCaseInterface::setName() in NCLNameCaseInterface.php
    setName
    -
    NCLNameCaseCore::setName() in NCLNameCaseCore.php
    +
    NCLNameCaseCore::setName() in NCLNameCaseCore.php
    +
    В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord
    setNameCases
    -
    NCLNameCaseWord::setNameCases() in NCLNameCaseWord.php
    +
    NCLNameCaseWord::setNameCases() in NCLNameCaseWord.php
    +
    Сохраняет результат склонения текущего слова
    setNamePart
    -
    NCLNameCaseWord::setNamePart() in NCLNameCaseWord.php
    +
    NCLNameCaseWord::setNamePart() in NCLNameCaseWord.php
    +
    Устанавливает тип текущего слова
    setRule
    -
    NCLNameCaseWord::setRule() in NCLNameCaseWord.php
    +
    NCLNameCaseWord::setRule() in NCLNameCaseWord.php
    +
    Устанавливает номер правила по которому склонялось текущее слово.
    setSecondName
    -
    NCLNameCaseInterface::setSecondName() in NCLNameCaseInterface.php
    +
    NCLNameCaseInterface::setSecondName() in NCLNameCaseInterface.php
    setSecondName
    -
    NCLNameCaseCore::setSecondName() in NCLNameCaseCore.php
    +
    NCLNameCaseCore::setSecondName() in NCLNameCaseCore.php
    +
    В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord
    +
    +
    + setSirName +
    +
    +
    NCLNameCaseCore::setSirName() in NCLNameCaseCore.php
    +
    В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord
    setSirname
    -
    NCLNameCaseCore::setSirname() in NCLNameCaseCore.php
    -
    -
    - setSirname -
    -
    -
    NCLNameCaseInterface::setSirname() in NCLNameCaseInterface.php
    +
    NCLNameCaseInterface::setSirname() in NCLNameCaseInterface.php
    setTrueGender
    -
    NCLNameCaseWord::setTrueGender() in NCLNameCaseWord.php
    +
    NCLNameCaseWord::setTrueGender() in NCLNameCaseWord.php
    +
    Окончательно устанавливает пол человека
    setWorkingWord
    -
    NCLNameCaseCore::setWorkingWord() in NCLNameCaseCore.php
    -
    -
    - solveGender -
    -
    -
    NCLNameCaseCore::solveGender() in NCLNameCaseCore.php
    +
    NCLNameCaseCore::setWorkingWord() in NCLNameCaseCore.php
    +
    Устанавливает слово текущим для работы системы. Очищает кеш слова.
    splitFullName
    -
    NCLNameCaseCore::splitFullName() in NCLNameCaseCore.php
    +
    NCLNameCaseCore::splitFullName() in NCLNameCaseCore.php
    +
    Разбивает строку $fullname на слова и возвращает формат в котором записано имя
    splitFullName
    -
    NCLNameCaseInterface::splitFullName() in NCLNameCaseInterface.php
    +
    NCLNameCaseInterface::splitFullName() in NCLNameCaseInterface.php
    splitLetters
    - + +
    Превращает строку в массив букв
    strlen
    -
    NCLStr::strlen() in NCLStr.php
    +
    NCLStr::strlen() in NCLStr.php
    +
    Определение длины строки
    strpos
    -
    NCLStr::strpos() in NCLStr.php
    +
    NCLStr::strpos() in NCLStr.php
    +
    Поиск подстроки в строке
    strrpos
    -
    NCLStr::strrpos() in NCLStr.php
    -
    Обертка для strrpos
    +
    NCLStr::strrpos() in NCLStr.php
    +
    Поиск подстроки в строке справа
    strtolower
    -
    NCLStr::strtolower() in NCLStr.php
    +
    NCLStr::strtolower() in NCLStr.php
    +
    Переводит строку в нижний регистр
    strtoupper
    -
    NCLStr::strtoupper() in NCLStr.php
    +
    NCLStr::strtoupper() in NCLStr.php
    +
    Переводит строку в верхний регистр
    substr
    -
    NCLStr::substr() in NCLStr.php
    +
    NCLStr::substr() in NCLStr.php
    +
    Получить подстроку из строки
    @@ -1011,7 +977,7 @@ $TVORITELN
    -
    NCL::$TVORITELN in NCL.php
    +
    NCL::$TVORITELN in NCL.php
    Творительный падеж
    @@ -1026,49 +992,49 @@ $UaDavalnyi
    -
    NCL::$UaDavalnyi in NCL.php
    +
    NCL::$UaDavalnyi in NCL.php
    Давальний відмінок
    $UaKlychnyi
    -
    NCL::$UaKlychnyi in NCL.php
    +
    NCL::$UaKlychnyi in NCL.php
    Кличний відмінок
    $UaMiszevyi
    -
    NCL::$UaMiszevyi in NCL.php
    +
    NCL::$UaMiszevyi in NCL.php
    Місцевий відмінок
    $UaNazyvnyi
    -
    NCL::$UaNazyvnyi in NCL.php
    +
    NCL::$UaNazyvnyi in NCL.php
    Назвиний відмінок
    $UaOrudnyi
    -
    NCL::$UaOrudnyi in NCL.php
    +
    NCL::$UaOrudnyi in NCL.php
    Орудний відмінок
    $UaRodovyi
    -
    NCL::$UaRodovyi in NCL.php
    +
    NCL::$UaRodovyi in NCL.php
    Родовий відмінок
    $UaZnahidnyi
    - +
    Знахідний відмінок
    @@ -1083,7 +1049,7 @@ $VINITELN
    -
    NCL::$VINITELN in NCL.php
    +
    NCL::$VINITELN in NCL.php
    Винительный падеж
    @@ -1098,127 +1064,120 @@ $WOMAN
    -
    NCL::$WOMAN in NCL.php
    +
    NCL::$WOMAN in NCL.php
    Женский пол
    -
    - $words -
    -
    -
    NCLNameCaseCore::$words in NCLNameCaseCore.php
    -
    Список всех слов
    -
    $workindLastCache
    -
    NCLNameCaseCore::$workindLastCache in NCLNameCaseCore.php
    +
    NCLNameCaseCore::$workindLastCache in NCLNameCaseCore.php
    +
    Метод Last() вырезает подстроки разной длины. Посколько одинаковых вызовов бывает несколько, то все результаты выполнения кешируются в этом массиве.
    $workingWord
    -
    NCLNameCaseCore::$workingWord in NCLNameCaseCore.php
    +
    NCLNameCaseCore::$workingWord in NCLNameCaseCore.php
    +
    Переменная, в которую заносится слово с которым сейчас идет работа
    womanFatherName
    -
    NCLNameCaseUa::womanFatherName() in NCL.NameCase.ua.php
    +
    NCLNameCaseRu::womanFatherName() in NCL.NameCase.ru.php
    +
    Функция склоняет женские отчества
    +
    +
    + womanFatherName +
    +
    +
    NCLNameCaseUa::womanFatherName() in NCL.NameCase.ua.php
    Фунція відмінює жіночі по-батькові
    -
    - womanFatherName -
    -
    -
    NCLNameCaseRu::womanFatherName() in NCL.NameCase.ru.php
    -
    womanFirstName
    -
    NCLNameCaseRu::womanFirstName() in NCL.NameCase.ru.php
    -
    -
    - womanFirstName -
    -
    -
    NCLNameCaseUa::womanFirstName() in NCL.NameCase.ua.php
    +
    NCLNameCaseUa::womanFirstName() in NCL.NameCase.ua.php
    Функція намагається застосувати ланцюг правил для жіночих імен
    +
    + womanFirstName +
    +
    +
    NCLNameCaseRu::womanFirstName() in NCL.NameCase.ru.php
    +
    Функция пытается применить цыпочку правил для женских имен
    +
    womanRule1
    -
    NCLNameCaseUa::womanRule1() in NCL.NameCase.ua.php
    +
    NCLNameCaseUa::womanRule1() in NCL.NameCase.ua.php
    Українські чоловічі та жіночі імена, що в називному відмінку однини закінчуються на -а (-я), відмінються як відповідні іменники І відміни.
    womanRule1
    -
    NCLNameCaseRu::womanRule1() in NCL.NameCase.ru.php
    +
    NCLNameCaseRu::womanRule1() in NCL.NameCase.ru.php
    Мужские и женские имена, оканчивающиеся на -а, склоняются,
    womanRule2
    -
    NCLNameCaseRu::womanRule2() in NCL.NameCase.ru.php
    -
    Мужские и женские имена, оканчивающиеся иа -я, -ья, -ия, -ея, независимо от языка,
    +
    NCLNameCaseUa::womanRule2() in NCL.NameCase.ua.php
    +
    Українські жіночі імена, що в називному відмінку однини закінчуються на приголосний,
    womanRule2
    -
    NCLNameCaseUa::womanRule2() in NCL.NameCase.ua.php
    -
    Українські жіночі імена, що в називному відмінку однини закінчуються на приголосний,
    +
    NCLNameCaseRu::womanRule2() in NCL.NameCase.ru.php
    +
    Мужские и женские имена, оканчивающиеся иа -я, -ья, -ия, -ея, независимо от языка,
    womanRule3
    -
    NCLNameCaseUa::womanRule3() in NCL.NameCase.ua.php
    +
    NCLNameCaseUa::womanRule3() in NCL.NameCase.ua.php
    Якщо слово на ськ або це російське прізвище
    womanRule3
    -
    NCLNameCaseRu::womanRule3() in NCL.NameCase.ru.php
    +
    NCLNameCaseRu::womanRule3() in NCL.NameCase.ru.php
    Русские женские имена, оканчивающиеся на мягкий согласный, склоняются,
    womanRule4
    -
    NCLNameCaseRu::womanRule4() in NCL.NameCase.ru.php
    +
    NCLNameCaseRu::womanRule4() in NCL.NameCase.ru.php
    Женские фамилия, оканчивающиеся на -а -я, склоняются,
    womanSecondName
    -
    NCLNameCaseRu::womanSecondName() in NCL.NameCase.ru.php
    +
    NCLNameCaseUa::womanSecondName() in NCL.NameCase.ua.php
    +
    Функція намагається застосувати ланцюг правил для жіночих прізвищ
    womanSecondName
    -
    NCLNameCaseUa::womanSecondName() in NCL.NameCase.ua.php
    -
    Функція намагається застосувати ланцюг правил для жіночих прізвищ
    -
    -
    - WordCase -
    -
    -
    NCLNameCaseCore::WordCase() in NCLNameCaseCore.php
    +
    NCLNameCaseRu::womanSecondName() in NCL.NameCase.ru.php
    +
    Функция пытается применить цыпочку правил для женских фамилий
    wordForms
    -
    NCLNameCaseCore::wordForms() in NCLNameCaseCore.php
    +
    NCLNameCaseCore::wordForms() in NCLNameCaseCore.php
    +
    Склоняет слово $word, удаляя из него $replaceLast последних букв и добавляя в каждый падеж окончание из массива $endings.
    @@ -1232,13 +1191,12 @@ __construct
    -
    NCLNameCaseWord::__construct() in NCLNameCaseWord.php
    -
    Создать запись из слова
    +
    NCLNameCaseWord::__construct() in NCLNameCaseWord.php
    +
    Создание нового обьекта со словом $word
    - a c d e diff --git a/Docs/elementindex_NameCaseLib.html b/Docs/elementindex_NameCaseLib.html index 2475e5a..8928172 100644 --- a/Docs/elementindex_NameCaseLib.html +++ b/Docs/elementindex_NameCaseLib.html @@ -10,21 +10,44 @@

    [NameCaseLib] element index

    -

    Package indexes

    - All elements
    c d + e + f g + i + l m n + p + q + r + s + t + u + v w + _
    + +
    +
    _
    + +
    +
    +
    +
    + __construct +
    +
    +
    NCLNameCaseWord::__construct() in NCLNameCaseWord.php
    +
    Создание нового обьекта со словом $word
    +
    +
    c
    @@ -35,8 +58,30 @@
    $CaseCount
    +
    +
    NCLNameCaseRu::$CaseCount in NCL.NameCase.ru.php
    +
    Количество падежей в языке
    +
    +
    + $CaseCount +
    NCLNameCaseUa::$CaseCount in NCL.NameCase.ua.php
    +
    Количество падежей в языке
    +
    +
    + $charset +
    +
    +
    NCLStr::$charset in NCLStr.php
    +
    Кодировка, в котороя работает система
    +
    +
    + connectLetters +
    +
    + +
    Соединяет массив букв в строку
    @@ -46,6 +91,13 @@
    +
    + $DATELN +
    +
    +
    NCL::$DATELN in NCL.php
    +
    Дательный падеж
    +
    detectNamePart
    @@ -53,6 +105,43 @@
    NCLNameCaseUa::detectNamePart() in NCL.NameCase.ua.php
    Ідентифікує слово визначаючи чи це ім’я, чи це прізвище, чи це побатькові
    +
    + detectNamePart +
    +
    +
    NCLNameCaseRu::detectNamePart() in NCL.NameCase.ru.php
    +
    Идетифицирует слово определяе имя это, или фамилия, или отчество
    +
    +
    + +
    +
    e
    + +
    +
    +
    +
    + explode +
    +
    +
    NCLStr::explode() in NCLStr.php
    +
    Разбивает строку на части использую шаблон
    +
    +
    + +
    +
    f
    + +
    +
    +
    +
    + fullReset +
    +
    +
    NCLNameCaseCore::fullReset() in NCLNameCaseCore.php
    +
    Сбрасывает все информацию на начальную. Очищает все слова добавленые в систему.
    +
    @@ -61,6 +150,33 @@
    +
    + gender +
    +
    +
    NCLNameCaseWord::gender() in NCLNameCaseWord.php
    +
    Расчитывает и возвращает пол текущего слова
    +
    +
    + genderAutoDetect +
    +
    +
    NCLNameCaseInterface::genderAutoDetect() in NCLNameCaseInterface.php
    +
    +
    + genderAutoDetect +
    +
    + +
    По указаным словам определяется пол человека:
    +
    +
    + GenderByFatherName +
    +
    + +
    Определение пола по правилам отчеств
    +
    GenderByFatherName
    @@ -71,6 +187,13 @@
    GenderByFirstName
    +
    +
    NCLNameCaseRu::GenderByFirstName() in NCL.NameCase.ru.php
    +
    Определение пола по правилам имен
    +
    +
    + GenderByFirstName +
    NCLNameCaseUa::GenderByFirstName() in NCL.NameCase.ua.php
    Визначення статі, за правилами імені
    @@ -82,6 +205,192 @@
    Визначення статі, за правилами прізвища
    +
    + GenderBySecondName +
    +
    + +
    Определение пола по правилам фамилий
    +
    +
    + getFatherNameCase +
    +
    + +
    Функция ставит отчество в нужный падеж.
    +
    +
    + getFatherNameCase +
    +
    +
    NCLNameCaseInterface::getFatherNameCase() in NCLNameCaseInterface.php
    +
    +
    + getFirstNameCase +
    +
    +
    NCLNameCaseInterface::getFirstNameCase() in NCLNameCaseInterface.php
    +
    +
    + getFirstNameCase +
    +
    + +
    Функция ставит имя в нужный падеж.
    +
    +
    + getFormatted +
    +
    +
    NCLNameCaseInterface::getFormatted() in NCLNameCaseInterface.php
    +
    +
    + getFormatted +
    +
    +
    NCLNameCaseCore::getFormatted() in NCLNameCaseCore.php
    +
    Склоняет текущие слова в падеж $caseNum и форматирует слово по шаблону $format
    +
    +
    + getFormattedArray +
    +
    + +
    Склоняет текущие слова во все падежи и форматирует слово по шаблону $format
    +
    +
    + getFormattedArray +
    +
    +
    NCLNameCaseInterface::getFormattedArray() in NCLNameCaseInterface.php
    +
    +
    + getFormattedArrayHard +
    +
    + +
    Склоняет текущие слова во все падежи и форматирует слово по шаблону $format
    +
    +
    + getFormattedHard +
    +
    + +
    Склоняет текущие слова в падеж $caseNum и форматирует слово по шаблону $format
    +
    +
    + getGender +
    +
    +
    NCLNameCaseWord::getGender() in NCLNameCaseWord.php
    +
    Возвращает массив вероятности того, что даное слово является мужчиной или женщиной
    +
    +
    + getNameCases +
    +
    +
    NCLNameCaseWord::getNameCases() in NCLNameCaseWord.php
    +
    Возвращает массив со всеми падежами текущего слова
    +
    +
    + getNamePart +
    +
    +
    NCLNameCaseWord::getNamePart() in NCLNameCaseWord.php
    +
    Возвращает тип текущего слова
    +
    +
    + getSecondNameCase +
    +
    + +
    Функция ставит фамилию в нужный падеж.
    +
    +
    + getSecondNameCase +
    +
    +
    NCLNameCaseInterface::getSecondNameCase() in NCLNameCaseInterface.php
    +
    +
    + getWord +
    +
    +
    NCLNameCaseWord::getWord() in NCLNameCaseWord.php
    +
    Возвращает текущее слово.
    +
    +
    + +
    +
    i
    + +
    +
    +
    +
    + $IMENITLN +
    +
    +
    NCL::$IMENITLN in NCL.php
    +
    Именительный падеж
    +
    +
    + in +
    +
    +
    NCLNameCaseCore::in() in NCLNameCaseCore.php
    +
    Если $string строка, тогда проверяется входит ли буква $letter в строку $string
    +
    +
    + inNames +
    +
    +
    NCLNameCaseCore::inNames() in NCLNameCaseCore.php
    +
    Функция проверяет, входит ли имя $nameNeedle в перечень имен $names.
    +
    +
    + isGenderSolved +
    +
    +
    NCLNameCaseWord::isGenderSolved() in NCLNameCaseWord.php
    +
    Если уже был расчитан пол для всех слов системы, тогда каждому слову предается окончательное решение. Эта функция определяет было ли принято окончательное решение.
    +
    +
    + isLowerCase +
    +
    +
    NCLStr::isLowerCase() in NCLStr.php
    +
    Проверяет в нижнем ли регистре находится строка
    +
    +
    + isUpperCase +
    +
    +
    NCLStr::isUpperCase() in NCLStr.php
    +
    Проверяет в верхнем ли регистре находится строка
    +
    +
    + +
    +
    l
    + +
    +
    +
    +
    + $lastResult +
    +
    +
    NCLNameCaseCore::$lastResult in NCLNameCaseCore.php
    +
    Массив содержит результат склонения слова - слово во всех падежах
    +
    +
    + Last +
    +
    +
    NCLNameCaseCore::Last() in NCLNameCaseCore.php
    +
    Если $stopAfter = 0, тогда вырезает $length последних букв с текущего слова ($this->workingWord)
    +
    @@ -90,6 +399,13 @@
    +
    + $MAN +
    +
    +
    NCL::$MAN in NCL.php
    +
    Мужской пол
    +
    manFatherName
    @@ -97,6 +413,13 @@
    NCLNameCaseUa::manFatherName() in NCL.NameCase.ua.php
    Фунція відмінює чоловічі по-батькові
    +
    + manFatherName +
    +
    +
    NCLNameCaseRu::manFatherName() in NCL.NameCase.ru.php
    +
    Функция склоняет мужский отчества
    +
    manFirstName
    @@ -104,6 +427,13 @@
    NCLNameCaseUa::manFirstName() in NCL.NameCase.ua.php
    Функція намагається застосувати ланцюг правил для чоловічих імен
    +
    + manFirstName +
    +
    +
    NCLNameCaseRu::manFirstName() in NCL.NameCase.ru.php
    +
    Функция пытается применить цыпочку правил для мужских имен
    +
    manRule1
    @@ -111,6 +441,13 @@
    NCLNameCaseUa::manRule1() in NCL.NameCase.ua.php
    Українські чоловічі та жіночі імена, що в називному відмінку однини закінчуються на -а (-я), відмінються як відповідні іменники І відміни.
    +
    + manRule1 +
    +
    +
    NCLNameCaseRu::manRule1() in NCL.NameCase.ru.php
    +
    Мужские имена, оканчивающиеся на любой ь и -й,
    +
    manRule2
    @@ -118,6 +455,20 @@
    NCLNameCaseUa::manRule2() in NCL.NameCase.ua.php
    Імена, що в називному відмінку закінчуються на -р, у родовому мають закінчення -а: Віктор - Віктора, Макар - Макара, але: Ігор - Ігоря, Лазар - Лазаря.
    +
    + manRule2 +
    +
    +
    NCLNameCaseRu::manRule2() in NCL.NameCase.ru.php
    +
    Мужские имена, оканчивающиеся на любой твердый согласный,
    +
    +
    + manRule3 +
    +
    +
    NCLNameCaseRu::manRule3() in NCL.NameCase.ru.php
    +
    Мужские и женские имена, оканчивающиеся на -а, склоняются, как и любые
    +
    manRule3
    @@ -132,6 +483,20 @@
    NCLNameCaseUa::manRule4() in NCL.NameCase.ua.php
    Якщо слово закінчується на і, то відмінюємо як множину
    +
    + manRule4 +
    +
    +
    NCLNameCaseRu::manRule4() in NCL.NameCase.ru.php
    +
    Мужские фамилии, оканчивающиеся на -ь -й, склоняются так же,
    +
    +
    + manRule5 +
    +
    +
    NCLNameCaseRu::manRule5() in NCL.NameCase.ru.php
    +
    Мужские фамилии, оканчивающиеся на -к
    +
    manRule5
    @@ -139,6 +504,34 @@
    NCLNameCaseUa::manRule5() in NCL.NameCase.ua.php
    Якщо слово закінчується на ий або ой
    +
    + manRule6 +
    +
    +
    NCLNameCaseRu::manRule6() in NCL.NameCase.ru.php
    +
    Мужские фамили на согласный выбираем ем/ом/ым
    +
    +
    + manRule7 +
    +
    +
    NCLNameCaseRu::manRule7() in NCL.NameCase.ru.php
    +
    Мужские фамили на -а -я
    +
    +
    + manRule8 +
    +
    +
    NCLNameCaseRu::manRule8() in NCL.NameCase.ru.php
    +
    Не склоняются мужский фамилии
    +
    +
    + manSecondName +
    +
    +
    NCLNameCaseRu::manSecondName() in NCL.NameCase.ru.php
    +
    Функция пытается применить цыпочку правил для мужских фамилий
    +
    manSecondName
    @@ -154,18 +547,522 @@
    +
    + NCL +
    +
    +
    NCL in NCL.php
    +
    Класс, который содержит основные константы библиотеки:
    • индексы мужского и женского пола
    • индексы всех падежей
    +
    +
    + NCL.php +
    +
    +
    NCL.php in NCL.php
    +
    +
    + NCLNameCaseCore.php +
    +
    +
    NCLNameCaseCore.php in NCLNameCaseCore.php
    +
    +
    + NCLNameCaseInterface.php +
    +
    +
    NCLNameCaseInterface.php in NCLNameCaseInterface.php
    +
    +
    + NCLNameCaseWord.php +
    +
    +
    NCLNameCaseWord.php in NCLNameCaseWord.php
    +
    +
    + NCLStr.php +
    +
    +
    NCLStr.php in NCLStr.php
    +
    +
    + NCL.NameCase.ru.php +
    +
    +
    NCL.NameCase.ru.php in NCL.NameCase.ru.php
    +
    NCL.NameCase.ua.php
    NCL.NameCase.ua.php in NCL.NameCase.ua.php
    +
    + NCLNameCaseCore +
    +
    +
    NCLNameCaseCore in NCLNameCaseCore.php
    +
    NCL NameCase Core
    +
    +
    + NCLNameCaseInterface +
    +
    +
    NCLNameCaseInterface in NCLNameCaseInterface.php
    +
    Интерфейс для русского и украинского языка
    +
    +
    + NCLNameCaseRu +
    +
    +
    NCLNameCaseRu in NCL.NameCase.ru.php
    +
    NCL NameCase Russian Language
    +
    NCLNameCaseUa
    NCLNameCaseUa in NCL.NameCase.ua.php
    -
    Класс, который содержит основные константы библиотеки:
    +
    NCL NameCase Ukranian Language
    +
    +
    + NCLNameCaseWord +
    +
    +
    NCLNameCaseWord in NCLNameCaseWord.php
    +
    NCLNameCaseWord - класс, который служит для хранения всей информации о каждом слове
    +
    +
    + NCLStr +
    +
    +
    NCLStr in NCLStr.php
    +
    Класс содержит функции для работы со строками, которые используются в NCLNameCaseLib
    +
    +
    + NCL_DIR +
    +
    +
    NCL_DIR in NCLNameCaseCore.php
    +
    +
    + +
    +
    p
    + +
    +
    +
    +
    + $PREDLOGN +
    +
    +
    NCL::$PREDLOGN in NCL.php
    +
    Предложный падеж
    +
    +
    + +
    +
    q
    + +
    +
    +
    +
    + q +
    +
    +
    NCLNameCaseInterface::q() in NCLNameCaseInterface.php
    +
    +
    + q +
    +
    +
    NCLNameCaseCore::q() in NCLNameCaseCore.php
    +
    Склоняет ФИО $fullname в падеж $caseNum по правилам пола $gender.
    +
    +
    + qFatherName +
    +
    +
    NCLNameCaseInterface::qFatherName() in NCLNameCaseInterface.php
    +
    +
    + qFatherName +
    +
    +
    NCLNameCaseCore::qFatherName() in NCLNameCaseCore.php
    +
    Функция ставит отчество $fatherName в нужный падеж $CaseNumber по правилам пола $gender.
    +
    +
    + qFirstName +
    +
    +
    NCLNameCaseInterface::qFirstName() in NCLNameCaseInterface.php
    +
    +
    + qFirstName +
    +
    +
    NCLNameCaseCore::qFirstName() in NCLNameCaseCore.php
    +
    Функция ставит имя $firstName в нужный падеж $CaseNumber по правилам пола $gender.
    +
    +
    + qFullName +
    +
    +
    NCLNameCaseInterface::qFullName() in NCLNameCaseInterface.php
    +
    +
    + qFullName +
    +
    +
    NCLNameCaseCore::qFullName() in NCLNameCaseCore.php
    +
    Склоняет фамилию $secondName, имя $firstName, отчество $fatherName
    +
    +
    + qSecondName +
    +
    +
    NCLNameCaseInterface::qSecondName() in NCLNameCaseInterface.php
    +
    +
    + qSecondName +
    +
    +
    NCLNameCaseCore::qSecondName() in NCLNameCaseCore.php
    +
    Функция ставит фамилию $secondName в нужный падеж $CaseNumber по правилам пола $gender.
    +
    +
    + +
    +
    r
    + +
    +
    +
    +
    + $RODITLN +
    +
    +
    NCL::$RODITLN in NCL.php
    +
    Родительный падеж
    +
    +
    + Rule +
    +
    +
    NCLNameCaseCore::Rule() in NCLNameCaseCore.php
    +
    Устанавливает номер последнего правила
    +
    +
    + RulesChain +
    +
    +
    NCLNameCaseCore::RulesChain() in NCLNameCaseCore.php
    +
    Над текущим словом ($this->workingWord) выполняются правила в порядке указаном в $rulesArray.
    +
    +
    + +
    +
    s
    + +
    +
    +
    +
    + setFatherName +
    +
    +
    NCLNameCaseCore::setFatherName() in NCLNameCaseCore.php
    +
    В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord
    +
    +
    + setFatherName +
    +
    +
    NCLNameCaseInterface::setFatherName() in NCLNameCaseInterface.php
    +
    +
    + setFirstName +
    +
    +
    NCLNameCaseCore::setFirstName() in NCLNameCaseCore.php
    +
    В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord
    +
    +
    + setFirstName +
    +
    +
    NCLNameCaseInterface::setFirstName() in NCLNameCaseInterface.php
    +
    +
    + setFullName +
    +
    +
    NCLNameCaseInterface::setFullName() in NCLNameCaseInterface.php
    +
    +
    + setFullName +
    +
    +
    NCLNameCaseCore::setFullName() in NCLNameCaseCore.php
    +
    В система заносится сразу фамилия, имя, отчество
    +
    +
    + setGender +
    +
    +
    NCLNameCaseInterface::setGender() in NCLNameCaseInterface.php
    +
    +
    + setGender +
    +
    +
    NCLNameCaseWord::setGender() in NCLNameCaseWord.php
    +
    Устанавливает вероятности того, что даное слово является мужчиной или женщиной
    +
    +
    + setGender +
    +
    +
    NCLNameCaseCore::setGender() in NCLNameCaseCore.php
    +
    Всем словам устанавливается пол, который может иметь следующие значения
    +
    +
    + setLastName +
    +
    +
    NCLNameCaseCore::setLastName() in NCLNameCaseCore.php
    +
    В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord
    +
    +
    + setLastName +
    +
    +
    NCLNameCaseInterface::setLastName() in NCLNameCaseInterface.php
    +
    +
    + setName +
    +
    +
    NCLNameCaseInterface::setName() in NCLNameCaseInterface.php
    +
    +
    + setName +
    +
    +
    NCLNameCaseCore::setName() in NCLNameCaseCore.php
    +
    В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord
    +
    +
    + setNameCases +
    +
    +
    NCLNameCaseWord::setNameCases() in NCLNameCaseWord.php
    +
    Сохраняет результат склонения текущего слова
    +
    +
    + setNamePart +
    +
    +
    NCLNameCaseWord::setNamePart() in NCLNameCaseWord.php
    +
    Устанавливает тип текущего слова
    +
    +
    + setRule +
    +
    +
    NCLNameCaseWord::setRule() in NCLNameCaseWord.php
    +
    Устанавливает номер правила по которому склонялось текущее слово.
    +
    +
    + setSecondName +
    +
    +
    NCLNameCaseInterface::setSecondName() in NCLNameCaseInterface.php
    +
    +
    + setSecondName +
    +
    +
    NCLNameCaseCore::setSecondName() in NCLNameCaseCore.php
    +
    В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord
    +
    +
    + setSirName +
    +
    +
    NCLNameCaseCore::setSirName() in NCLNameCaseCore.php
    +
    В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord
    +
    +
    + setSirname +
    +
    +
    NCLNameCaseInterface::setSirname() in NCLNameCaseInterface.php
    +
    +
    + setTrueGender +
    +
    +
    NCLNameCaseWord::setTrueGender() in NCLNameCaseWord.php
    +
    Окончательно устанавливает пол человека
    +
    +
    + setWorkingWord +
    +
    +
    NCLNameCaseCore::setWorkingWord() in NCLNameCaseCore.php
    +
    Устанавливает слово текущим для работы системы. Очищает кеш слова.
    +
    +
    + splitFullName +
    +
    +
    NCLNameCaseCore::splitFullName() in NCLNameCaseCore.php
    +
    Разбивает строку $fullname на слова и возвращает формат в котором записано имя
    +
    +
    + splitFullName +
    +
    +
    NCLNameCaseInterface::splitFullName() in NCLNameCaseInterface.php
    +
    +
    + splitLetters +
    +
    + +
    Превращает строку в массив букв
    +
    +
    + strlen +
    +
    +
    NCLStr::strlen() in NCLStr.php
    +
    Определение длины строки
    +
    +
    + strpos +
    +
    +
    NCLStr::strpos() in NCLStr.php
    +
    Поиск подстроки в строке
    +
    +
    + strrpos +
    +
    +
    NCLStr::strrpos() in NCLStr.php
    +
    Поиск подстроки в строке справа
    +
    +
    + strtolower +
    +
    +
    NCLStr::strtolower() in NCLStr.php
    +
    Переводит строку в нижний регистр
    +
    +
    + strtoupper +
    +
    +
    NCLStr::strtoupper() in NCLStr.php
    +
    Переводит строку в верхний регистр
    +
    +
    + substr +
    +
    +
    NCLStr::substr() in NCLStr.php
    +
    Получить подстроку из строки
    +
    +
    + +
    +
    t
    + +
    +
    +
    +
    + $TVORITELN +
    +
    +
    NCL::$TVORITELN in NCL.php
    +
    Творительный падеж
    +
    +
    + +
    +
    u
    + +
    +
    +
    +
    + $UaDavalnyi +
    +
    +
    NCL::$UaDavalnyi in NCL.php
    +
    Давальний відмінок
    +
    +
    + $UaKlychnyi +
    +
    +
    NCL::$UaKlychnyi in NCL.php
    +
    Кличний відмінок
    +
    +
    + $UaMiszevyi +
    +
    +
    NCL::$UaMiszevyi in NCL.php
    +
    Місцевий відмінок
    +
    +
    + $UaNazyvnyi +
    +
    +
    NCL::$UaNazyvnyi in NCL.php
    +
    Назвиний відмінок
    +
    +
    + $UaOrudnyi +
    +
    +
    NCL::$UaOrudnyi in NCL.php
    +
    Орудний відмінок
    +
    +
    + $UaRodovyi +
    +
    +
    NCL::$UaRodovyi in NCL.php
    +
    Родовий відмінок
    +
    +
    + $UaZnahidnyi +
    +
    + +
    Знахідний відмінок
    +
    +
    + +
    +
    v
    + +
    +
    +
    +
    + $VINITELN +
    +
    +
    NCL::$VINITELN in NCL.php
    +
    Винительный падеж
    @@ -175,6 +1072,34 @@
    +
    + $WOMAN +
    +
    +
    NCL::$WOMAN in NCL.php
    +
    Женский пол
    +
    +
    + $workindLastCache +
    +
    +
    NCLNameCaseCore::$workindLastCache in NCLNameCaseCore.php
    +
    Метод Last() вырезает подстроки разной длины. Посколько одинаковых вызовов бывает несколько, то все результаты выполнения кешируются в этом массиве.
    +
    +
    + $workingWord +
    +
    +
    NCLNameCaseCore::$workingWord in NCLNameCaseCore.php
    +
    Переменная, в которую заносится слово с которым сейчас идет работа
    +
    +
    + womanFatherName +
    +
    +
    NCLNameCaseRu::womanFatherName() in NCL.NameCase.ru.php
    +
    Функция склоняет женские отчества
    +
    womanFatherName
    @@ -189,6 +1114,13 @@
    NCLNameCaseUa::womanFirstName() in NCL.NameCase.ua.php
    Функція намагається застосувати ланцюг правил для жіночих імен
    +
    + womanFirstName +
    +
    +
    NCLNameCaseRu::womanFirstName() in NCL.NameCase.ru.php
    +
    Функция пытается применить цыпочку правил для женских имен
    +
    womanRule1
    @@ -196,6 +1128,13 @@
    NCLNameCaseUa::womanRule1() in NCL.NameCase.ua.php
    Українські чоловічі та жіночі імена, що в називному відмінку однини закінчуються на -а (-я), відмінються як відповідні іменники І відміни.
    +
    + womanRule1 +
    +
    +
    NCLNameCaseRu::womanRule1() in NCL.NameCase.ru.php
    +
    Мужские и женские имена, оканчивающиеся на -а, склоняются,
    +
    womanRule2
    @@ -203,6 +1142,13 @@
    NCLNameCaseUa::womanRule2() in NCL.NameCase.ua.php
    Українські жіночі імена, що в називному відмінку однини закінчуються на приголосний,
    +
    + womanRule2 +
    +
    +
    NCLNameCaseRu::womanRule2() in NCL.NameCase.ru.php
    +
    Мужские и женские имена, оканчивающиеся иа -я, -ья, -ия, -ея, независимо от языка,
    +
    womanRule3
    @@ -210,6 +1156,20 @@
    NCLNameCaseUa::womanRule3() in NCL.NameCase.ua.php
    Якщо слово на ськ або це російське прізвище
    +
    + womanRule3 +
    +
    +
    NCLNameCaseRu::womanRule3() in NCL.NameCase.ru.php
    +
    Русские женские имена, оканчивающиеся на мягкий согласный, склоняются,
    +
    +
    + womanRule4 +
    +
    +
    NCLNameCaseRu::womanRule4() in NCL.NameCase.ru.php
    +
    Женские фамилия, оканчивающиеся на -а -я, склоняются,
    +
    womanSecondName
    @@ -217,14 +1177,40 @@
    NCLNameCaseUa::womanSecondName() in NCL.NameCase.ua.php
    Функція намагається застосувати ланцюг правил для жіночих прізвищ
    +
    + womanSecondName +
    +
    +
    NCLNameCaseRu::womanSecondName() in NCL.NameCase.ru.php
    +
    Функция пытается применить цыпочку правил для женских фамилий
    +
    +
    + wordForms +
    +
    +
    NCLNameCaseCore::wordForms() in NCLNameCaseCore.php
    +
    Склоняет слово $word, удаляя из него $replaceLast последних букв и добавляя в каждый падеж окончание из массива $endings.
    +
    c d + e + f g + i + l m n + p + q + r + s + t + u + v w + _
    \ No newline at end of file diff --git a/Docs/elementindex_default.html b/Docs/elementindex_default.html index 93d2f7f..00eccf5 100644 --- a/Docs/elementindex_default.html +++ b/Docs/elementindex_default.html @@ -13,7 +13,6 @@ All elements
    - a c d e @@ -46,21 +45,7 @@
    NCLNameCaseWord::__construct() in NCLNameCaseWord.php
    -
    Создать запись из слова
    -
    - - -
    -
    a
    - -
    -
    -
    -
    - AllWordCases -
    -
    -
    NCLNameCaseCore::AllWordCases() in NCLNameCaseCore.php
    +
    Создание нового обьекта со словом $word
    @@ -75,6 +60,7 @@
    NCLNameCaseRu::$CaseCount in NCL.NameCase.ru.php
    +
    Количество падежей в языке
    $CaseCount @@ -88,12 +74,14 @@
    NCLStr::$charset in NCLStr.php
    +
    Кодировка, в котороя работает система
    connectLetters
    +
    Соединяет массив букв в строку
    @@ -122,6 +110,7 @@
    NCLNameCaseRu::detectNamePart() in NCL.NameCase.ru.php
    +
    Идетифицирует слово определяе имя это, или фамилия, или отчество
    @@ -136,6 +125,7 @@
    NCLStr::explode() in NCLStr.php
    +
    Разбивает строку на части использую шаблон
    @@ -145,18 +135,12 @@
    -
    - $finished -
    -
    -
    NCLNameCaseCore::$finished in NCLNameCaseCore.php
    -
    Все слова уже просклонялись
    -
    fullReset
    NCLNameCaseCore::fullReset() in NCLNameCaseCore.php
    +
    Сбрасывает все информацию на начальную. Очищает все слова добавленые в систему.
    @@ -171,6 +155,7 @@
    NCLNameCaseWord::gender() in NCLNameCaseWord.php
    +
    Расчитывает и возвращает пол текущего слова
    genderAutoDetect @@ -183,12 +168,14 @@
    +
    По указаным словам определяется пол человека:
    GenderByFatherName
    +
    Определение пола по правилам отчеств
    GenderByFatherName @@ -202,6 +189,7 @@
    NCLNameCaseRu::GenderByFirstName() in NCL.NameCase.ru.php
    +
    Определение пола по правилам имен
    GenderByFirstName @@ -222,12 +210,14 @@
    +
    Определение пола по правилам фамилий
    - generateIndex + getFatherNameCase
    -
    NCLNameCaseCore::generateIndex() in NCLNameCaseCore.php
    + +
    Функция ставит отчество в нужный падеж.
    getFatherNameCase @@ -235,18 +225,6 @@
    NCLNameCaseInterface::getFatherNameCase() in NCLNameCaseInterface.php
    -
    - getFatherNameCase -
    -
    - -
    -
    - getFirstNameCase -
    -
    - -
    getFirstNameCase
    @@ -254,10 +232,11 @@
    NCLNameCaseInterface::getFirstNameCase() in NCLNameCaseInterface.php
    - getFormatted + getFirstNameCase
    -
    NCLNameCaseCore::getFormatted() in NCLNameCaseCore.php
    + +
    Функция ставит имя в нужный падеж.
    getFormatted @@ -266,46 +245,66 @@
    NCLNameCaseInterface::getFormatted() in NCLNameCaseInterface.php
    - getFormattedArray + getFormatted
    -
    NCLNameCaseInterface::getFormattedArray() in NCLNameCaseInterface.php
    +
    NCLNameCaseCore::getFormatted() in NCLNameCaseCore.php
    +
    Склоняет текущие слова в падеж $caseNum и форматирует слово по шаблону $format
    getFormattedArray
    +
    Склоняет текущие слова во все падежи и форматирует слово по шаблону $format
    +
    +
    + getFormattedArray +
    +
    +
    NCLNameCaseInterface::getFormattedArray() in NCLNameCaseInterface.php
    getFormattedArrayHard
    +
    Склоняет текущие слова во все падежи и форматирует слово по шаблону $format
    getFormattedHard
    +
    Склоняет текущие слова в падеж $caseNum и форматирует слово по шаблону $format
    getGender
    NCLNameCaseWord::getGender() in NCLNameCaseWord.php
    +
    Возвращает массив вероятности того, что даное слово является мужчиной или женщиной
    getNameCases
    NCLNameCaseWord::getNameCases() in NCLNameCaseWord.php
    +
    Возвращает массив со всеми падежами текущего слова
    getNamePart
    NCLNameCaseWord::getNamePart() in NCLNameCaseWord.php
    +
    Возвращает тип текущего слова
    +
    +
    + getSecondNameCase +
    +
    + +
    Функция ставит фамилию в нужный падеж.
    getSecondNameCase @@ -313,17 +312,12 @@
    NCLNameCaseInterface::getSecondNameCase() in NCLNameCaseInterface.php
    -
    - getSecondNameCase -
    -
    - -
    getWord
    NCLNameCaseWord::getWord() in NCLNameCaseWord.php
    +
    Возвращает текущее слово.
    @@ -340,42 +334,40 @@
    NCL::$IMENITLN in NCL.php
    Именительный падеж
    -
    - $index -
    -
    -
    NCLNameCaseCore::$index in NCLNameCaseCore.php
    -
    in
    NCLNameCaseCore::in() in NCLNameCaseCore.php
    +
    Если $string строка, тогда проверяется входит ли буква $letter в строку $string
    inNames
    NCLNameCaseCore::inNames() in NCLNameCaseCore.php
    -
    Функция проверяет, входит ли имя в перечень имен.
    +
    Функция проверяет, входит ли имя $nameNeedle в перечень имен $names.
    isGenderSolved
    NCLNameCaseWord::isGenderSolved() in NCLNameCaseWord.php
    +
    Если уже был расчитан пол для всех слов системы, тогда каждому слову предается окончательное решение. Эта функция определяет было ли принято окончательное решение.
    isLowerCase
    NCLStr::isLowerCase() in NCLStr.php
    +
    Проверяет в нижнем ли регистре находится строка
    isUpperCase
    NCLStr::isUpperCase() in NCLStr.php
    +
    Проверяет в верхнем ли регистре находится строка
    @@ -390,20 +382,14 @@
    NCLNameCaseCore::$lastResult in NCLNameCaseCore.php
    -
    Просклоненое слово
    -
    -
    - $lastRule -
    -
    -
    NCLNameCaseCore::$lastRule in NCLNameCaseCore.php
    -
    Последние правило
    +
    Массив содержит результат склонения слова - слово во всех падежах
    Last
    NCLNameCaseCore::Last() in NCLNameCaseCore.php
    +
    Если $stopAfter = 0, тогда вырезает $length последних букв с текущего слова ($this->workingWord)
    @@ -432,6 +418,7 @@
    NCLNameCaseRu::manFatherName() in NCL.NameCase.ru.php
    +
    Функция склоняет мужский отчества
    manFirstName @@ -445,6 +432,7 @@
    NCLNameCaseRu::manFirstName() in NCL.NameCase.ru.php
    +
    Функция пытается применить цыпочку правил для мужских имен
    manRule1 @@ -542,6 +530,7 @@
    NCLNameCaseRu::manSecondName() in NCL.NameCase.ru.php
    +
    Функция пытается применить цыпочку правил для мужских фамилий
    manSecondName @@ -646,7 +635,7 @@
    NCLStr in NCLStr.php
    -
    Description of NCLStr
    +
    Класс содержит функции для работы со строками, которые используются в NCLNameCaseLib
    NCL_DIR @@ -654,12 +643,6 @@
    NCL_DIR in NCLNameCaseCore.php
    -
    - notReady -
    -
    -
    NCLNameCaseCore::notReady() in NCLNameCaseCore.php
    -
    @@ -675,30 +658,6 @@
    NCL::$PREDLOGN in NCL.php
    Предложный падеж
    -
    - prepareAllNameParts -
    -
    - -
    -
    - prepareEverything -
    -
    - -
    -
    - prepareGender -
    -
    -
    NCLNameCaseCore::prepareGender() in NCLNameCaseCore.php
    -
    -
    - prepareNamePart -
    -
    -
    NCLNameCaseCore::prepareNamePart() in NCLNameCaseCore.php
    -
    @@ -718,6 +677,7 @@
    NCLNameCaseCore::q() in NCLNameCaseCore.php
    +
    Склоняет ФИО $fullname в падеж $caseNum по правилам пола $gender.
    qFatherName @@ -730,6 +690,7 @@
    NCLNameCaseCore::qFatherName() in NCLNameCaseCore.php
    +
    Функция ставит отчество $fatherName в нужный падеж $CaseNumber по правилам пола $gender.
    qFirstName @@ -742,6 +703,7 @@
    NCLNameCaseCore::qFirstName() in NCLNameCaseCore.php
    +
    Функция ставит имя $firstName в нужный падеж $CaseNumber по правилам пола $gender.
    qFullName @@ -754,6 +716,7 @@
    NCLNameCaseCore::qFullName() in NCLNameCaseCore.php
    +
    Склоняет фамилию $secondName, имя $firstName, отчество $fatherName
    qSecondName @@ -766,6 +729,7 @@
    NCLNameCaseCore::qSecondName() in NCLNameCaseCore.php
    +
    Функция ставит фамилию $secondName в нужный падеж $CaseNumber по правилам пола $gender.
    @@ -775,13 +739,6 @@
    -
    - $ready -
    -
    -
    NCLNameCaseCore::$ready in NCLNameCaseCore.php
    -
    Система уже готово к склонению или нет
    -
    $RODITLN
    @@ -789,26 +746,19 @@
    NCL::$RODITLN in NCL.php
    Родительный падеж
    -
    - reset -
    -
    -
    NCLNameCaseCore::reset() in NCLNameCaseCore.php
    -
    Сброс всех настроек
    -
    Rule
    NCLNameCaseCore::Rule() in NCLNameCaseCore.php
    -
    Установить номер парвила
    +
    Устанавливает номер последнего правила
    RulesChain
    NCLNameCaseCore::RulesChain() in NCLNameCaseCore.php
    -
    Выполняет над словом типа $gender (man / woman) в порядке указанов в $rulesArray
    +
    Над текущим словом ($this->workingWord) выполняются правила в порядке указаном в $rulesArray.
    @@ -823,6 +773,7 @@
    NCLNameCaseCore::setFatherName() in NCLNameCaseCore.php
    +
    В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord
    setFatherName @@ -834,19 +785,14 @@ setFirstName
    -
    NCLNameCaseInterface::setFirstName() in NCLNameCaseInterface.php
    +
    NCLNameCaseCore::setFirstName() in NCLNameCaseCore.php
    +
    В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord
    setFirstName
    -
    NCLNameCaseCore::setFirstName() in NCLNameCaseCore.php
    -
    -
    - setFullName -
    -
    -
    NCLNameCaseCore::setFullName() in NCLNameCaseCore.php
    +
    NCLNameCaseInterface::setFirstName() in NCLNameCaseInterface.php
    setFullName @@ -855,16 +801,11 @@
    NCLNameCaseInterface::setFullName() in NCLNameCaseInterface.php
    - setGender + setFullName
    -
    NCLNameCaseWord::setGender() in NCLNameCaseWord.php
    -
    -
    - setGender -
    -
    -
    NCLNameCaseCore::setGender() in NCLNameCaseCore.php
    +
    NCLNameCaseCore::setFullName() in NCLNameCaseCore.php
    +
    В система заносится сразу фамилия, имя, отчество
    setGender @@ -873,16 +814,31 @@
    NCLNameCaseInterface::setGender() in NCLNameCaseInterface.php
    - setLastName + setGender
    -
    NCLNameCaseInterface::setLastName() in NCLNameCaseInterface.php
    +
    NCLNameCaseWord::setGender() in NCLNameCaseWord.php
    +
    Устанавливает вероятности того, что даное слово является мужчиной или женщиной
    +
    +
    + setGender +
    +
    +
    NCLNameCaseCore::setGender() in NCLNameCaseCore.php
    +
    Всем словам устанавливается пол, который может иметь следующие значения
    setLastName
    NCLNameCaseCore::setLastName() in NCLNameCaseCore.php
    +
    В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord
    +
    +
    + setLastName +
    +
    +
    NCLNameCaseInterface::setLastName() in NCLNameCaseInterface.php
    setName @@ -895,24 +851,28 @@
    NCLNameCaseCore::setName() in NCLNameCaseCore.php
    +
    В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord
    setNameCases
    NCLNameCaseWord::setNameCases() in NCLNameCaseWord.php
    +
    Сохраняет результат склонения текущего слова
    setNamePart
    NCLNameCaseWord::setNamePart() in NCLNameCaseWord.php
    +
    Устанавливает тип текущего слова
    setRule
    NCLNameCaseWord::setRule() in NCLNameCaseWord.php
    +
    Устанавливает номер правила по которому склонялось текущее слово.
    setSecondName @@ -925,12 +885,14 @@
    NCLNameCaseCore::setSecondName() in NCLNameCaseCore.php
    +
    В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord
    - setSirname + setSirName
    -
    NCLNameCaseCore::setSirname() in NCLNameCaseCore.php
    +
    NCLNameCaseCore::setSirName() in NCLNameCaseCore.php
    +
    В массив $this->words добавляется новый об’єкт класса NCLNameCaseWord
    setSirname @@ -943,24 +905,21 @@
    NCLNameCaseWord::setTrueGender() in NCLNameCaseWord.php
    +
    Окончательно устанавливает пол человека
    setWorkingWord
    NCLNameCaseCore::setWorkingWord() in NCLNameCaseCore.php
    -
    -
    - solveGender -
    -
    -
    NCLNameCaseCore::solveGender() in NCLNameCaseCore.php
    +
    Устанавливает слово текущим для работы системы. Очищает кеш слова.
    splitFullName
    NCLNameCaseCore::splitFullName() in NCLNameCaseCore.php
    +
    Разбивает строку $fullname на слова и возвращает формат в котором записано имя
    splitFullName @@ -973,43 +932,49 @@
    +
    Превращает строку в массив букв
    strlen
    NCLStr::strlen() in NCLStr.php
    +
    Определение длины строки
    strpos
    NCLStr::strpos() in NCLStr.php
    +
    Поиск подстроки в строке
    strrpos
    NCLStr::strrpos() in NCLStr.php
    -
    Обертка для strrpos
    +
    Поиск подстроки в строке справа
    strtolower
    NCLStr::strtolower() in NCLStr.php
    +
    Переводит строку в нижний регистр
    strtoupper
    NCLStr::strtoupper() in NCLStr.php
    +
    Переводит строку в верхний регистр
    substr
    NCLStr::substr() in NCLStr.php
    +
    Получить подстроку из строки
    @@ -1113,24 +1078,26 @@
    NCL::$WOMAN in NCL.php
    Женский пол
    -
    - $words -
    -
    -
    NCLNameCaseCore::$words in NCLNameCaseCore.php
    -
    Список всех слов
    -
    $workindLastCache
    NCLNameCaseCore::$workindLastCache in NCLNameCaseCore.php
    +
    Метод Last() вырезает подстроки разной длины. Посколько одинаковых вызовов бывает несколько, то все результаты выполнения кешируются в этом массиве.
    $workingWord
    NCLNameCaseCore::$workingWord in NCLNameCaseCore.php
    +
    Переменная, в которую заносится слово с которым сейчас идет работа
    +
    +
    + womanFatherName +
    +
    +
    NCLNameCaseRu::womanFatherName() in NCL.NameCase.ru.php
    +
    Функция склоняет женские отчества
    womanFatherName @@ -1140,23 +1107,18 @@
    Фунція відмінює жіночі по-батькові
    - womanFatherName + womanFirstName
    -
    NCLNameCaseRu::womanFatherName() in NCL.NameCase.ru.php
    +
    NCLNameCaseUa::womanFirstName() in NCL.NameCase.ua.php
    +
    Функція намагається застосувати ланцюг правил для жіночих імен
    womanFirstName
    NCLNameCaseRu::womanFirstName() in NCL.NameCase.ru.php
    -
    -
    - womanFirstName -
    -
    -
    NCLNameCaseUa::womanFirstName() in NCL.NameCase.ua.php
    -
    Функція намагається застосувати ланцюг правил для жіночих імен
    +
    Функция пытается применить цыпочку правил для женских имен
    womanRule1 @@ -1176,15 +1138,15 @@ womanRule2
    -
    NCLNameCaseRu::womanRule2() in NCL.NameCase.ru.php
    -
    Мужские и женские имена, оканчивающиеся иа -я, -ья, -ия, -ея, независимо от языка,
    +
    NCLNameCaseUa::womanRule2() in NCL.NameCase.ua.php
    +
    Українські жіночі імена, що в називному відмінку однини закінчуються на приголосний,
    womanRule2
    -
    NCLNameCaseUa::womanRule2() in NCL.NameCase.ua.php
    -
    Українські жіночі імена, що в називному відмінку однини закінчуються на приголосний,
    +
    NCLNameCaseRu::womanRule2() in NCL.NameCase.ru.php
    +
    Мужские и женские имена, оканчивающиеся иа -я, -ья, -ия, -ея, независимо от языка,
    womanRule3 @@ -1211,31 +1173,26 @@ womanSecondName
    -
    NCLNameCaseRu::womanSecondName() in NCL.NameCase.ru.php
    +
    NCLNameCaseUa::womanSecondName() in NCL.NameCase.ua.php
    +
    Функція намагається застосувати ланцюг правил для жіночих прізвищ
    womanSecondName
    -
    NCLNameCaseUa::womanSecondName() in NCL.NameCase.ua.php
    -
    Функція намагається застосувати ланцюг правил для жіночих прізвищ
    -
    -
    - WordCase -
    -
    -
    NCLNameCaseCore::WordCase() in NCLNameCaseCore.php
    +
    NCLNameCaseRu::womanSecondName() in NCL.NameCase.ru.php
    +
    Функция пытается применить цыпочку правил для женских фамилий
    wordForms
    NCLNameCaseCore::wordForms() in NCLNameCaseCore.php
    +
    Склоняет слово $word, удаляя из него $replaceLast последних букв и добавляя в каждый падеж окончание из массива $endings.
    - a c d e diff --git a/Docs/errors.html b/Docs/errors.html index 4762a21..40e8ae5 100644 --- a/Docs/errors.html +++ b/Docs/errors.html @@ -9,49 +9,8 @@ Post-parsing
    -NCL.NameCase.ua.php
    -NCL.php
    -NCLNameCaseCore.php
    -NCLNameCaseInterface.php
    -NCLNameCaseWord.php
    -NCLStr.php
    - -

    NCL.NameCase.ru.php

    -

    Warnings:


    -Warning on line 15 - no @package tag was used in a DocBlock for class NCLNameCaseRu
    -Warning on line 657 - File "/home/seagull/localhost/www/NameCaseLib/Library/NCL.NameCase.ru.php" has no page-level DocBlock, use @package in the first DocBlock to create one
    - -

    NCL.NameCase.ua.php

    -

    Warnings:


    -Warning on line 17 - no @package tag was used in a DocBlock for class NCLNameCaseUa
    -Warning on line 752 - File "/home/seagull/localhost/www/NameCaseLib/Library/NCL.NameCase.ua.php" has no page-level DocBlock, use @package in the first DocBlock to create one
    - -

    NCL.php

    -

    Warnings:


    -Warning on line 9 - no @package tag was used in a DocBlock for class NCL
    -Warning on line 102 - File "/home/seagull/localhost/www/NameCaseLib/Library/NCL/NCL.php" has no page-level DocBlock, use @package in the first DocBlock to create one
    - -

    NCLNameCaseCore.php

    -

    Warnings:


    -Warning on line 13 - no @package tag was used in a DocBlock for class NCLNameCaseCore
    -Warning on line 909 - File "/home/seagull/localhost/www/NameCaseLib/Library/NCL/NCLNameCaseCore.php" has no page-level DocBlock, use @package in the first DocBlock to create one
    - -

    NCLNameCaseInterface.php

    -

    Warnings:


    -Warning on line 7 - no @package tag was used in a DocBlock for interface NCLNameCaseInterface
    -Warning on line 50 - File "/home/seagull/localhost/www/NameCaseLib/Library/NCL/NCLNameCaseInterface.php" has no page-level DocBlock, use @package in the first DocBlock to create one
    - -

    NCLNameCaseWord.php

    -

    Warnings:


    -Warning on line 8 - no @package tag was used in a DocBlock for class NCLNameCaseWord
    -Warning on line 206 - File "/home/seagull/localhost/www/NameCaseLib/Library/NCL/NCLNameCaseWord.php" has no page-level DocBlock, use @package in the first DocBlock to create one
    - -

    NCLStr.php

    -

    Warnings:


    -Warning on line 13 - no @package tag was used in a DocBlock for class NCLStr
    -Warning on line 102 - File "/home/seagull/localhost/www/NameCaseLib/Library/NCL/NCLStr.php" has no page-level DocBlock, use @package in the first DocBlock to create one

    - Documentation generated on Wed, 06 Jul 2011 00:21:05 +0300 by phpDocumentor 1.4.3 + Documentation generated on Wed, 06 Jul 2011 14:04:08 +0300 by phpDocumentor 1.4.3

    \ No newline at end of file diff --git a/Docs/index.html b/Docs/index.html index 951aafe..b0e957c 100644 --- a/Docs/index.html +++ b/Docs/index.html @@ -4,7 +4,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd"> - + Generated Documentation @@ -12,7 +12,7 @@ - + diff --git a/Docs/li_NameCaseLib.html b/Docs/li_NameCaseLib.html index 286bb7e..9a514ec 100644 --- a/Docs/li_NameCaseLib.html +++ b/Docs/li_NameCaseLib.html @@ -22,10 +22,22 @@ <dt class="folder-title">Interfaces</dt> - <dt class="folder-title">Classes</dt> - <dd><a href='NameCaseLib/NCLNameCaseUa.html' target='right'>NCLNameCaseUa</a></dd> + <dd><a href='NameCaseLib/NCLNameCaseInterface.html' target='right'>NCLNameCaseInterface</a></dd> + <dt class="folder-title">Classes</dt> + <dd><a href='NameCaseLib/NCL.html' target='right'>NCL</a></dd> + <dd><a href='NameCaseLib/NCLNameCaseCore.html' target='right'>NCLNameCaseCore</a></dd> + <dd><a href='NameCaseLib/NCLNameCaseRu.html' target='right'>NCLNameCaseRu</a></dd> + <dd><a href='NameCaseLib/NCLNameCaseUa.html' target='right'>NCLNameCaseUa</a></dd> + <dd><a href='NameCaseLib/NCLNameCaseWord.html' target='right'>NCLNameCaseWord</a></dd> + <dd><a href='NameCaseLib/NCLStr.html' target='right'>NCLStr</a></dd> <dt class="folder-title">Files</dt> + <dd><a href='NameCaseLib/_NCL.NameCase.ru.php.html' target='right'>NCL.NameCase.ru.php</a></dd> <dd><a href='NameCaseLib/_NCL.NameCase.ua.php.html' target='right'>NCL.NameCase.ua.php</a></dd> + <dd><a href='NameCaseLib/_NCL---NCL.php.html' target='right'>NCL.php</a></dd> + <dd><a href='NameCaseLib/_NCL---NCLNameCaseCore.php.html' target='right'>NCLNameCaseCore.php</a></dd> + <dd><a href='NameCaseLib/_NCL---NCLNameCaseInterface.php.html' target='right'>NCLNameCaseInterface.php</a></dd> + <dd><a href='NameCaseLib/_NCL---NCLNameCaseWord.php.html' target='right'>NCLNameCaseWord.php</a></dd> + <dd><a href='NameCaseLib/_NCL---NCLStr.php.html' target='right'>NCLStr.php</a></dd> </dl> diff --git a/Docs/packages.html b/Docs/packages.html index f9712e4..d843875 100644 --- a/Docs/packages.html +++ b/Docs/packages.html @@ -10,7 +10,7 @@ </head> <body> <div class="banner"> - <div class="banner-title">default</div> + <div class="banner-title">NameCaseLib</div> <div class="banner-menu"> <table cellpadding="0" cellspacing="0" style="width: 100%"> <tr> diff --git a/Library/NCL.NameCase.ru.php b/Library/NCL.NameCase.ru.php index 6b5bba8..110d51d 100644 --- a/Library/NCL.NameCase.ru.php +++ b/Library/NCL.NameCase.ru.php @@ -1,55 +1,61 @@ <?php - -/* - * NCL NameCase Russian Language - * - * Клас, которые позволяет склонять русские Имена, Фамили Отчества по падежам. - * +/** * @license Dual licensed under the MIT or GPL Version 2 licenses. - * @author Андрей Чайка http://seagull.net.ua/ bymer3@gmail.com - * @version 0.1.2 05.05.2011 + * @package NameCaseLib + */ + +/** * */ require_once dirname(__FILE__) . '/NCL/NCLNameCaseCore.php'; +/** + * <b>NCL NameCase Russian Language</b> + * + * Русские правила склонения ФИО + * Правила определения пола человека по ФИО для русского языка + * Система разделения фамилий имен и отчеств для русского языка + * + * @author Андрей Чайка <bymer3@gmail.com> + * @version 0.4 + * @package NameCaseLib + */ class NCLNameCaseRu extends NCLNameCaseCore implements NCLNameCaseInterface { - /* - * @static string - * Количество падежов + /** + * Количество падежей в языке + * @var int */ - protected $CaseCount = 6; - /* - * @static string - * Список гласных + /** + * Список гласных русского языка + * @var string */ private $vowels = "аеёиоуыэюя"; - /* - * @static string - * Список согласных + /** + * Список согласных русского языка + * @var string */ private $consonant = "бвгджзйклмнпрстфхцчшщ"; - - /* - * @static array() - * Список окончание для неизменяемых имен + /** + * Окончания имен/фамилий, который не склоняются + * @var array */ private $ovo = array('ово', 'аго', 'яго', 'ирь'); - /* - * @static array() - * Список окончание для неизменяемых имен + /** + * Окончания имен/фамилий, который не склоняются + * @var array */ private $ih = array('их', 'ых', 'ко'); /** * Мужские имена, оканчивающиеся на любой ь и -й, * скло­няются так же, как обычные существительные мужского рода - * @return bool + * @return bool true если правило было задействовано и false если нет. */ protected function manRule1() { @@ -74,7 +80,7 @@ class NCLNameCaseRu extends NCLNameCaseCore implements NCLNameCaseInterface /** * Мужские имена, оканчивающиеся на любой твердый согласный, * склоняются так же, как обычные существительные мужского рода - * @return bool + * @return bool true если правило было задействовано и false если нет. */ protected function manRule2() { @@ -107,7 +113,7 @@ class NCLNameCaseRu extends NCLNameCaseCore implements NCLNameCaseInterface * существительные с таким же окончанием * Мужские и женские имена, оканчивающиеся иа -я, -ья, -ия, -ея, независимо от языка, * из которого они происходят, склоняются как существительные с соответствующими окончаниями - * @return bool + * @return bool true если правило было задействовано и false если нет. */ protected function manRule3() { @@ -138,7 +144,7 @@ class NCLNameCaseRu extends NCLNameCaseCore implements NCLNameCaseInterface /** * Мужские фамилии, оканчивающиеся на -ь -й, склоняются так же, * как обычные существительные мужского рода - * @return bool + * @return bool true если правило было задействовано и false если нет. */ protected function manRule4() { @@ -177,7 +183,7 @@ class NCLNameCaseRu extends NCLNameCaseCore implements NCLNameCaseInterface /** * Мужские фамилии, оканчивающиеся на -к - * @return bool + * @return bool true если правило было задействовано и false если нет. */ protected function manRule5() { @@ -208,7 +214,7 @@ class NCLNameCaseRu extends NCLNameCaseCore implements NCLNameCaseInterface /** * Мужские фамили на согласный выбираем ем/ом/ым - * @return bool + * @return bool true если правило было задействовано и false если нет. */ protected function manRule6() { @@ -235,7 +241,7 @@ class NCLNameCaseRu extends NCLNameCaseCore implements NCLNameCaseInterface /** * Мужские фамили на -а -я - * @return bool + * @return bool true если правило было задействовано и false если нет. */ protected function manRule7() { @@ -272,7 +278,7 @@ class NCLNameCaseRu extends NCLNameCaseCore implements NCLNameCaseInterface /** * Не склоняются мужский фамилии - * @return bool + * @return bool true если правило было задействовано и false если нет. */ protected function manRule8() { @@ -288,7 +294,7 @@ class NCLNameCaseRu extends NCLNameCaseCore implements NCLNameCaseInterface /** * Мужские и женские имена, оканчивающиеся на -а, склоняются, * как и любые существительные с таким же окончанием - * @return bool + * @return bool true если правило было задействовано и false если нет. */ protected function womanRule1() { @@ -323,7 +329,7 @@ class NCLNameCaseRu extends NCLNameCaseCore implements NCLNameCaseInterface /** * Мужские и женские имена, оканчивающиеся иа -я, -ья, -ия, -ея, независимо от языка, * из которого они происходят, склоняются как сущест­вительные с соответствующими окончаниями - * @return bool + * @return bool true если правило было задействовано и false если нет. */ protected function womanRule2() { @@ -348,7 +354,7 @@ class NCLNameCaseRu extends NCLNameCaseCore implements NCLNameCaseInterface /** * Русские женские имена, оканчивающиеся на мягкий согласный, склоняются, * как существительные женского рода типа дочь, тень - * @return bool + * @return bool true если правило было задействовано и false если нет. */ protected function womanRule3() { @@ -364,7 +370,7 @@ class NCLNameCaseRu extends NCLNameCaseCore implements NCLNameCaseInterface /** * Женские фамилия, оканчивающиеся на -а -я, склоняются, * как и любые существительные с таким же окончанием - * @return bool + * @return bool true если правило было задействовано и false если нет. */ protected function womanRule4() { @@ -390,7 +396,6 @@ class NCLNameCaseRu extends NCLNameCaseCore implements NCLNameCaseInterface return true; } } - //Мужские и женские имена, оканчивающиеся иа -я, -ья, -ия, -ея, независимо от языка, из которого они происходят, склоняются как сущест­вительные с соответствующими окончаниями elseif ($this->Last(1) == "я") { $this->wordForms($this->workingWord, array('ой', 'ой', 'ую', 'ой', 'ой'), 2); @@ -400,56 +405,46 @@ class NCLNameCaseRu extends NCLNameCaseCore implements NCLNameCaseInterface return false; } - /* - * Функция, которая склоняет имя записаное в $this->firstName, по правилам склонения мужских имен. - * - * @return boolean + /** + * Функция пытается применить цыпочку правил для мужских имен + * @return boolean true - если было использовано правило из списка, false - если правило не было найденым */ - protected function manFirstName() { return $this->RulesChain('man', array(1, 2, 3)); } - /* - * Функция, которая склоняет имя записаное в $this->firstName, по правилам склонения женских имен. - * - * @return boolean + /** + * Функция пытается применить цыпочку правил для женских имен + * @return boolean true - если было использовано правило из списка, false - если правило не было найденым */ - protected function womanFirstName() { return $this->RulesChain('woman', array(1, 2, 3)); } - /* - * Функция, которая склоняет фамилию записаное в $this->secondName, по правилам склонения мужских фамилий. - * - * @return boolean + /** + * Функция пытается применить цыпочку правил для мужских фамилий + * @return boolean true - если было использовано правило из списка, false - если правило не было найденым */ - protected function manSecondName() { return $this->RulesChain('man', array(8, 4, 5, 6, 7)); } - /* - * Функция, которая склоняет фамилию записаное в $this->secondName, по правилам склонения женских фамилий. - * - * @return boolean + /** + * Функция пытается применить цыпочку правил для женских фамилий + * @return boolean true - если было использовано правило из списка, false - если правило не было найденым */ - protected function womanSecondName() { return $this->RulesChain('woman', array(4)); } - /* - * Функция, которая склоняет отчество записаное в $this->secondName, по правилам склонения мужских отчеств. - * - * @return boolean + /** + * Функция склоняет мужский отчества + * @return boolean true - если слово было успешно изменено, false - если не получилось этого сделать */ - protected function manFatherName() { //Проверяем действительно ли отчество @@ -466,12 +461,10 @@ class NCLNameCaseRu extends NCLNameCaseCore implements NCLNameCaseInterface return false; } - /* - * Функция, которая склоняет отчество записаное в $this->fatherName, по правилам склонения женских отчеств. - * - * @return boolean + /** + * Функция склоняет женские отчества + * @return boolean true - если слово было успешно изменено, false - если не получилось этого сделать */ - protected function womanFatherName() { //Проверяем действительно ли отчество @@ -482,7 +475,11 @@ class NCLNameCaseRu extends NCLNameCaseCore implements NCLNameCaseInterface } return false; } - + + /** + * Определение пола по правилам имен + * @param NCLNameCaseWord $word обьект класса слов, для которого нужно определить пол + */ protected function GenderByFirstName(NCLNameCaseWord $word) { $this->setWorkingWord($word->getWord()); @@ -545,7 +542,11 @@ class NCLNameCaseRu extends NCLNameCaseCore implements NCLNameCaseInterface $word->setGender($man, $woman); } - + + /** + * Определение пола по правилам фамилий + * @param NCLNameCaseWord $word обьект класса слов, для которого нужно определить пол + */ protected function GenderBySecondName(NCLNameCaseWord $word) { $this->setWorkingWord($word->getWord()); @@ -570,7 +571,11 @@ class NCLNameCaseRu extends NCLNameCaseCore implements NCLNameCaseInterface $word->setGender($man, $woman); } - + + /** + * Определение пола по правилам отчеств + * @param NCLNameCaseWord $word обьект класса слов, для которого нужно определить пол + */ protected function GenderByFatherName(NCLNameCaseWord $word) { $this->setWorkingWord($word->getWord()); @@ -585,13 +590,13 @@ class NCLNameCaseRu extends NCLNameCaseCore implements NCLNameCaseInterface } } - - - /* - * Определение текущее слово есть фамилией, именем или отчеством - * @return integer $number - 1-фамили 2-имя 3-отчество + /** + * Идетифицирует слово определяе имя это, или фамилия, или отчество + * - <b>N</b> - имя + * - <b>S</b> - фамилия + * - <b>F</b> - отчество + * @param NCLNameCaseWord $word обьект класса слов, который необходимо идентифицировать */ - protected function detectNamePart(NCLNameCaseWord $word) { $namepart = $word->getWord(); diff --git a/Library/NCL.NameCase.ua.php b/Library/NCL.NameCase.ua.php index 528ae0d..e68f5f0 100644 --- a/Library/NCL.NameCase.ua.php +++ b/Library/NCL.NameCase.ua.php @@ -1,19 +1,25 @@ <?php +/** + * @license Dual licensed under the MIT or GPL Version 2 licenses. + * @package NameCaseLib + */ + +/** + * + */ +require_once dirname(__FILE__) . '/NCL/NCLNameCaseCore.php'; /** * <b>NCL NameCase Ukranian Language</b> * * Украинские правила склонений ФИО. * Правила определения пола человека по ФИО для украинского языка - * Система разделения фамилий имен и отчеств для украинского языка - * - * @license Dual licensed under the MIT or GPL Version 2 licenses. - * @author Андрей Чайка http://seagull.net.ua/ bymer3@gmail.com - * @version 0.4 05.07.2011 + * Система разделения фамилий имен и отчеств для украинского языка * + * @author Андрей Чайка <bymer3@gmail.com> + * @version 0.4 + * @package NameCaseLib */ -require_once dirname(__FILE__) . '/NCL/NCLNameCaseCore.php'; - class NCLNameCaseUa extends NCLNameCaseCore implements NCLNameCaseInterface { diff --git a/Library/NCL/NCL.php b/Library/NCL/NCL.php index bb5a23e..604830d 100644 --- a/Library/NCL/NCL.php +++ b/Library/NCL/NCL.php @@ -1,10 +1,17 @@ <?php +/** + * @license Dual licensed under the MIT or GPL Version 2 licenses. + * @package NameCaseLib + */ + /** * Класс, который содержит основные константы библиотеки: * - индексы мужского и женского пола * - индексы всех падежей + * * @author Андрей Чайка <bymer3@gmail.com> * @version 0.4 + * @package NameCaseLib */ class NCL { diff --git a/Library/NCL/NCLNameCaseCore.php b/Library/NCL/NCLNameCaseCore.php index 17f7d12..487fca4 100644 --- a/Library/NCL/NCLNameCaseCore.php +++ b/Library/NCL/NCLNameCaseCore.php @@ -1,5 +1,12 @@ <?php +/** + * @license Dual licensed under the MIT or GPL Version 2 licenses. + * @package NameCaseLib + */ +/** + * + */ if (!defined('NCL_DIR')) { define('NCL_DIR', dirname(__FILE__)); @@ -10,84 +17,121 @@ require_once NCL_DIR . '/NCLStr.php'; require_once NCL_DIR . '/NCLNameCaseInterface.php'; require_once NCL_DIR . '/NCLNameCaseWord.php'; + + +/** + * <b>NCL NameCase Core</b> + * + * Набор основных функций, который позволяют сделать интерфейс слонения русского и украниского языка + * абсолютно одинаковым. Содержит все функции для внешнего взаимодействия с библиотекой. + * + * @author Андрей Чайка <bymer3@gmail.com> + * @version 0.4 + * @package NameCaseLib + */ class NCLNameCaseCore extends NCL { /** - * Система уже готово к склонению или нет + * Готовность системы: + * - Все слова идентифицированы (известо к какой части ФИО относится слово) + * - У всех слов определен пол + * Если все сделано стоит флаг true, при добавлении нового слова флаг сбрасывается на false * @var bool */ - protected $ready = false; + private $ready = false; + /** - * Все слова уже просклонялись + * Если все текущие слова было просклонены и в каждом слове уже есть результат склонения, + * тогда true. Если было добавлено новое слово флаг збрасывается на false * @var bool */ - protected $finished = false; + private $finished = false; + /** - * Список всех слов + * Массив содержит елементы типа NCLNameCaseWord. Это все слова которые нужно обработать и просклонять * @var array */ - protected $words = array(); + private $words = array(); - /* - * Слово с которым работаем сейчас + /** + * Переменная, в которую заносится слово с которым сейчас идет работа * @var string */ protected $workingWord = ''; - /* - * Кеш окончаний слова + /** + * Метод Last() вырезает подстроки разной длины. Посколько одинаковых вызовов бывает несколько, + * то все результаты выполнения кешируются в этом массиве. * @var array */ protected $workindLastCache = array(); + /** - * Последние правило + * Номер последнего использованого правила, устанавливается методом Rule() * @var int */ - protected $lastRule = 0; + private $lastRule = 0; + /** - * Просклоненое слово + * Массив содержит результат склонения слова - слово во всех падежах * @var array */ protected $lastResult = array(); - protected $index = array(); + + /** + * Массив содержит информацию о том какие слова из массива <var>$this->words</var> относятся к + * фамилии, какие к отчеству а какие к имени. Массив нужен потому, что при добавлении слов мы не + * всегда знаем какая часть ФИО сейчас, поэтому после идентификации всех слов генерируется массив + * индексов для быстрого поиска в дальнейшем. + * @var array + */ + private $index = array(); /** - * Сброс всех настроек + * Метод очищает результаты последнего склонения слова. Нужен при склонении нескольких слов. */ - protected function reset() + private function reset() { $this->lastRule = 0; $this->lastResult = array(); } - - protected function fullReset() + + /** + * Сбрасывает все информацию на начальную. Очищает все слова добавленые в систему. + * После выполнения система готова работать с начала. + */ + public function fullReset() { $this->words = array(); $this->index = array('N' => array(), 'F' => array(), 'S' => array()); $this->reset(); $this->notReady(); } - - protected function notReady() + + /** + * Устанавливает флаги о том, что система не готово и слова еще не были просклонены + */ + private function notReady() { $this->ready = false; $this->finished = false; } /** - * Установить номер парвила - * @param int $index + * Устанавливает номер последнего правила + * @param int $index номер правила которое нужно установить */ protected function Rule($index) { $this->lastRule = $index; } - /* - * Установить текущее слово + + /** + * Устанавливает слово текущим для работы системы. Очищает кеш слова. + * @param string $word слово, которое нужно установить */ - protected function setWorkingWord($word) { //Сбрасываем настройки @@ -98,11 +142,13 @@ class NCLNameCaseCore extends NCL $this->workindLastCache = array(); } - /* - * Если $stopAfter = 0, тогда вырезает $length последних букв - * Если нет, тогда вырезает $stopAfter букв начиная от $length с конца + /** + * Если <var>$stopAfter</var> = 0, тогда вырезает $length последних букв с текущего слова (<var>$this->workingWord</var>) + * Если нет, тогда вырезает <var>$stopAfter</var> букв начиная от <var>$length</var> с конца + * @param int $length количество букв с конца + * @param int $stopAfter количество букв которые нужно вырезать (0 - все) + * @return string требуемая подстрока */ - protected function Last($length=1, $stopAfter=0) { //Сколько букв нужно вырезать все или только часть @@ -124,10 +170,11 @@ class NCLNameCaseCore extends NCL } /** - * Выполняет над словом типа $gender (man / woman) в порядке указанов в $rulesArray - * @param string $gender - мужские/женский правила - * @param type $rulesArray - массив, порядок выполнения правил - * @return boolean + * Над текущим словом (<var>$this->workingWord</var>) выполняются правила в порядке указаном в <var>$rulesArray</var>. + * <var>$gender</var> служит для указания какие правила использовать мужские ('man') или женские ('woman') + * @param string $gender - префикс мужских/женских правил + * @param array $rulesArray - массив, порядок выполнения правил + * @return boolean если правило было задествовано, тогда true, если нет - тогда false */ protected function RulesChain($gender, $rulesArray) { @@ -141,16 +188,14 @@ class NCLNameCaseCore extends NCL } return false; } - - /* - * Функция проверяет, входит ли буква в строку. - * - * @param $letter - буква - * @param $string - строка - * - * @return boolean + + /** + * Если <var>$string</var> строка, тогда проверяется входит ли буква <var>$letter</var> в строку <var>$string</var> + * Если <var>$string</var> массив, тогда проверяется входит ли строка <var>$letter</var> в массив <var>$string</var> + * @param string $letter буква или строка, которую нужно искать + * @param mixed $string строка или массив, в котором нужно искать + * @return bool true если искомое значение найдено */ - protected function in($letter, $string) { //Если второй параметр массив @@ -172,10 +217,9 @@ class NCLNameCaseCore extends NCL } /** - * Функция проверяет, входит ли имя в перечень имен. - * - * @param string $nameNeedle - имя - * @param string $names - перечень имен + * Функция проверяет, входит ли имя <var>$nameNeedle</var> в перечень имен <var>$names</var>. + * @param string $nameNeedle - имя которое нужно найти + * @param array $names - перечень имен в котором нужно найти имя */ protected function inNames($nameNeedle, $names) { @@ -194,16 +238,13 @@ class NCLNameCaseCore extends NCL return false; } - /* - * Функция дополняет переданое слово нужными окончаниями. - * - * @param $word (string) - слово - * @param $endings (array) - окончания - * @param $replaceLast (int) - сколько букв убрать - * - * @return (array) + /** + * Склоняет слово <var>$word</var>, удаляя из него <var>$replaceLast</var> последних букв + * и добавляя в каждый падеж окончание из массива <var>$endings</var>. + * @param string $word слово, к которому нужно добавить окончания + * @param array $endings массив окончаний + * @param int $replaceLast сколько последних букв нужно убрать с начального слова */ - protected function wordForms($word, $endings, $replaceLast=0) { //Создаем массив с именительный падежом @@ -220,14 +261,11 @@ class NCLNameCaseCore extends NCL $this->lastResult = $result; } - /* - * Установка имени - * - * @param $firstname - * - * @return void + /** + * В массив <var>$this->words</var> добавляется новый об’єкт класса NCLNameCaseWord + * со словом <var>$firstname</var> и пометкой, что это имя + * @param string $firstname имя */ - public function setFirstName($firstname="") { if ($firstname) @@ -239,14 +277,11 @@ class NCLNameCaseCore extends NCL } } - /* - * Установка Фамилии - * - * @param $secondname - * - * @return void + /** + * В массив <var>$this->words</var> добавляется новый об’єкт класса NCLNameCaseWord + * со словом <var>$secondname</var> и пометкой, что это фамилия + * @param string $secondname фамилия */ - public function setSecondName($secondname="") { if ($secondname) @@ -258,14 +293,11 @@ class NCLNameCaseCore extends NCL } } - /* - * Установка Отчества - * - * @param $secondname - * - * @return void + /** + * В массив <var>$this->words</var> добавляется новый об’єкт класса NCLNameCaseWord + * со словом <var>$fathername</var> и пометкой, что это отчество + * @param string $fathername отчество */ - public function setFatherName($fathername="") { if ($fathername) @@ -277,16 +309,13 @@ class NCLNameCaseCore extends NCL } } - /* - * Установка пола - * - * @param $gender + /** + * Всем словам устанавливается пол, который может иметь следующие значения * - 0 - не определено * - NCL::$MAN - мужчина * - NCL::$WOMAN - женщина - * @return void + * @param int $gender пол, который нужно установить */ - public function setGender($gender=0) { foreach ($this->words as $word) @@ -295,16 +324,12 @@ class NCLNameCaseCore extends NCL } } - /* - * Установка Имени, Фамилии, Отчества - * - * @param $firstName - имя - * @param $secondName - фамилия - * @param $fatherName - отчество - * - * @return void + /** + * В система заносится сразу фамилия, имя, отчество + * @param string $secondName фамилия + * @param string $firstName имя + * @param string $fatherName отчество */ - public function setFullName($secondName="", $firstName="", $fatherName="") { $this->setFirstName($firstName); @@ -312,62 +337,64 @@ class NCLNameCaseCore extends NCL $this->setFatherName($fatherName); } - /* - * Установка имени - * - * @param $firstname - * - * @return void + /** + * В массив <var>$this->words</var> добавляется новый об’єкт класса NCLNameCaseWord + * со словом <var>$firstname</var> и пометкой, что это имя + * @param string $firstname имя */ - public function setName($firstname="") { $this->setFirstName($firstname); } - /* - * Установка Фамилии - * - * @param $secondname - * - * @return void + /** + * В массив <var>$this->words</var> добавляется новый об’єкт класса NCLNameCaseWord + * со словом <var>$secondname</var> и пометкой, что это фамилия + * @param string $secondname фамилия */ - public function setLastName($secondname="") { $this->setSecondName($secondname); } - /* - * Установка Фамилии - * - * @param $secondname - * - * @return void + /** + * В массив <var>$this->words</var> добавляется новый об’єкт класса NCLNameCaseWord + * со словом <var>$secondname</var> и пометкой, что это фамилия + * @param string $secondname фамилия */ - - public function setSirname($secondname="") + public function setSirName($secondname="") { $this->setSecondName($secondname); } - - protected function prepareNamePart(NCLNameCaseWord $word) + + /** + * Если слово <var>$word</var> не идентифицировано, тогда определяется это имя, фамилия или отчество + * @param NCLNameCaseWord $word слово которое нужно идентифицировать + */ + private function prepareNamePart(NCLNameCaseWord $word) { if (!$word->getNamePart()) { $this->detectNamePart($word); } } - - protected function prepareAllNameParts() + + /** + * Проверяет все ли слова идентифицированы, если нет тогда для каждого определяется это имя, фамилия или отчество + */ + private function prepareAllNameParts() { foreach ($this->words as $word) { $this->prepareNamePart($word); } } - - protected function prepareGender(NCLNameCaseWord $word) + + /** + * Определяет пол для слова <var>$word</var> + * @param NCLNameCaseWord $word слово для которого нужно определить пол + */ + private function prepareGender(NCLNameCaseWord $word) { if (!$word->isGenderSolved()) { @@ -383,8 +410,13 @@ class NCLNameCaseCore extends NCL } } } - - protected function solveGender() + + /** + * Для всех слов проверяет определен ли пол, если нет - определяет его + * После этого расчитывает пол для всех слов и устанавливает такой пол всем словам + * @return bool был ли определен пол + */ + private function solveGender() { //Ищем, может гдето пол уже установлен foreach ($this->words as $word) @@ -419,8 +451,14 @@ class NCLNameCaseCore extends NCL return true; } - - protected function generateIndex() + + /** + * Генерируется массив, который содержит информацию о том какие слова из массива <var>$this->words</var> относятся к + * фамилии, какие к отчеству а какие к имени. Массив нужен потому, что при добавлении слов мы не + * всегда знаем какая часть ФИО сейчас, поэтому после идентификации всех слов генерируется массив + * индексов для быстрого поиска в дальнейшем. + */ + private function generateIndex() { $this->index = array('N' => array(), 'S' => array(), 'F' => array()); foreach ($this->words as $index => $word) @@ -429,8 +467,13 @@ class NCLNameCaseCore extends NCL $this->index[$namepart][] = $index; } } - - protected function prepareEverything() + + /** + * Выполнет все необходимые подготовления для склонения. + * Все слова идентфицируются. Определяется пол. + * Обновляется индекс. + */ + private function prepareEverything() { if (!$this->ready) { @@ -441,12 +484,13 @@ class NCLNameCaseCore extends NCL } } - /* - * Автоматическое определение пола - * Возвращает пол по ФИО - * @return integer + /** + * По указаным словам определяется пол человека: + * - 0 - не определено + * - NCL::$MAN - мужчина + * - NCL::$WOMAN - женщина + * @return int текущий пол человека */ - public function genderAutoDetect() { $this->prepareEverything(); @@ -457,11 +501,15 @@ class NCLNameCaseCore extends NCL return false; } - /* - * Разбиение фразы на слова и определение, где имя, где фамилия, где отчество - * @return string $format - формат имен и фамилий + /** + * Разбивает строку <var>$fullname</var> на слова и возвращает формат в котором записано имя + * <b>Формат:</b> + * - S - Фамилия + * - N - Имя + * - F - Отчество + * @param string $fullname строка, для которой необходимо определить формат + * @return string формат в котором записано имя например 'N F S' */ - public function splitFullName($fullname) { @@ -483,8 +531,12 @@ class NCLNameCaseCore extends NCL return implode(' ', $formatArr); } - - protected function WordCase(NCLNameCaseWord $word) + + /** + * Склоняет слово <var>$word</var> по нужным правилам в зависимости от пола и типа слова + * @param NCLNameCaseWord $word слово, которое нужно просклонять + */ + private function WordCase(NCLNameCaseWord $word) { $gender = ($word->gender() == NCL::$MAN ? 'man' : 'woman'); @@ -512,8 +564,11 @@ class NCLNameCaseCore extends NCL $word->setRule(-1); } } - - protected function AllWordCases() + + /** + * Производит склонение всех слов, который хранятся в массиве <var>$this->words</var> + */ + private function AllWordCases() { if (!$this->finished) { @@ -527,7 +582,14 @@ class NCLNameCaseCore extends NCL $this->finished = true; } } - + + /** + * Если указан номер падежа <var>$number</var>, тогда возвращается строка с таким номером падежа, + * если нет, тогда возвращается массив со всеми падежами текущего слова. + * @param NCLNameCaseWord $word слово для котрого нужно вернуть падеж + * @param int $number номер падежа, который нужно вернуть + * @return mixed массив или строка с нужным падежом + */ private function getWordCase(NCLNameCaseWord $word, $number=null) { $cases = $word->getNameCases(); @@ -542,9 +604,11 @@ class NCLNameCaseCore extends NCL } /** - * Возвращает склееные результаты склонения - * @param array $indexArray - индексы слов, которые необходимо склеить - * @param int $number - + * Если нужно было просклонять несколько слов, то их необходимо собрать в одну строку. + * Эта функция собирает все слова указаные в <var>$indexArray</var> в одну строку. + * @param array $indexArray индексы слов, которые необходимо собрать вместе + * @param int $number номер падежа + * @return mixed либо массив со всеми падежами, либо строка с одним падежом */ private function getCasesConnected($indexArray, $number=null) { @@ -580,12 +644,14 @@ class NCLNameCaseCore extends NCL return ''; } - /* - * Поставить имя в определенный падеж + /** + * Функция ставит имя в нужный падеж. * - * @return string + * Если указан номер падежа <var>$number</var>, тогда возвращается строка с таким номером падежа, + * если нет, тогда возвращается массив со всеми падежами текущего слова. + * @param int $number номер падежа + * @return mixed массив или строка с нужным падежом */ - public function getFirstNameCase($number=null) { $this->AllWordCases(); @@ -593,12 +659,14 @@ class NCLNameCaseCore extends NCL return $this->getCasesConnected($this->index['N'], $number); } - /* - * Поставить фамилию в определенный падеж + /** + * Функция ставит фамилию в нужный падеж. * - * @return string + * Если указан номер падежа <var>$number</var>, тогда возвращается строка с таким номером падежа, + * если нет, тогда возвращается массив со всеми падежами текущего слова. + * @param int $number номер падежа + * @return mixed массив или строка с нужным падежом */ - public function getSecondNameCase($number=null) { $this->AllWordCases(); @@ -606,12 +674,14 @@ class NCLNameCaseCore extends NCL return $this->getCasesConnected($this->index['S'], $number); } - /* - * Поставить отчество в определенный падеж + /** + * Функция ставит отчество в нужный падеж. * - * @return string + * Если указан номер падежа <var>$number</var>, тогда возвращается строка с таким номером падежа, + * если нет, тогда возвращается массив со всеми падежами текущего слова. + * @param int $number номер падежа + * @return mixed массив или строка с нужным падежом */ - public function getFatherNameCase($number=null) { $this->AllWordCases(); @@ -619,12 +689,16 @@ class NCLNameCaseCore extends NCL return $this->getCasesConnected($this->index['F'], $number); } - /* - * Поставить фамилию в определенный падеж + /** + * Функция ставит имя <var>$firstName</var> в нужный падеж <var>$CaseNumber</var> по правилам пола <var>$gender</var>. * - * @return string + * Если указан номер падежа <var>$CaseNumber</var>, тогда возвращается строка с таким номером падежа, + * если нет, тогда возвращается массив со всеми падежами текущего слова. + * @param string $firstName имя, которое нужно просклонять + * @param int $CaseNumber номер падежа + * @param int $gender пол, который нужно использовать + * @return mixed массив или строка с нужным падежом */ - public function qFirstName($firstName, $CaseNumber=null, $gender=0) { $this->fullReset(); @@ -636,12 +710,16 @@ class NCLNameCaseCore extends NCL return $this->getFirstNameCase($CaseNumber); } - /* - * Поставить фамилию в определенный падеж + /** + * Функция ставит фамилию <var>$secondName</var> в нужный падеж <var>$CaseNumber</var> по правилам пола <var>$gender</var>. * - * @return string + * Если указан номер падежа <var>$CaseNumber</var>, тогда возвращается строка с таким номером падежа, + * если нет, тогда возвращается массив со всеми падежами текущего слова. + * @param string $secondName фамилия, которую нужно просклонять + * @param int $CaseNumber номер падежа + * @param int $gender пол, который нужно использовать + * @return mixed массив или строка с нужным падежом */ - public function qSecondName($secondName, $CaseNumber=null, $gender=0) { $this->fullReset(); @@ -654,12 +732,16 @@ class NCLNameCaseCore extends NCL return $this->getSecondNameCase($CaseNumber); } - /* - * Поставить отчество в определенный падеж + /** + * Функция ставит отчество <var>$fatherName</var> в нужный падеж <var>$CaseNumber</var> по правилам пола <var>$gender</var>. * - * @return string + * Если указан номер падежа <var>$CaseNumber</var>, тогда возвращается строка с таким номером падежа, + * если нет, тогда возвращается массив со всеми падежами текущего слова. + * @param string $fatherName отчество, которое нужно просклонять + * @param int $CaseNumber номер падежа + * @param int $gender пол, который нужно использовать + * @return mixed массив или строка с нужным падежом */ - public function qFatherName($fatherName, $CaseNumber=null, $gender=0) { $this->fullReset(); @@ -671,16 +753,15 @@ class NCLNameCaseCore extends NCL return $this->getFatherNameCase($CaseNumber); } - /* - * Склоняет во все падежи и форматирует по шаблону $format - * Шаблон $format - * S - Фамилия - * N - Имя - * F - Отчество - * - * @return array + /** + * Склоняет текущие слова во все падежи и форматирует слово по шаблону <var>$format</var> + * <b>Формат:</b> + * - S - Фамилия + * - N - Имя + * - F - Отчество + * @param string $format строка формат + * @return array массив со всеми падежами */ - public function getFormattedArray($format) { if (is_array($format)) @@ -735,7 +816,16 @@ class NCLNameCaseCore extends NCL } return $result; } - + + /** + * Склоняет текущие слова во все падежи и форматирует слово по шаблону <var>$format</var> + * <b>Формат:</b> + * - S - Фамилия + * - N - Имя + * - F - Отчество + * @param array $format массив с форматом + * @return array массив со всеми падежами + */ public function getFormattedArrayHard($format) { @@ -785,7 +875,16 @@ class NCLNameCaseCore extends NCL } return $result; } - + + /** + * Склоняет текущие слова в падеж <var>$caseNum</var> и форматирует слово по шаблону <var>$format</var> + * <b>Формат:</b> + * - S - Фамилия + * - N - Имя + * - F - Отчество + * @param array $format массив с форматом + * @return string строка в нужном падеже + */ public function getFormattedHard($caseNum=0, $format=array()) { $result = ""; @@ -811,19 +910,15 @@ class NCLNameCaseCore extends NCL return trim($result); } - /* - * Склоняет в падеж $caseNum, и форматирует по шаблону $format - * Шаблон $format - * S - Фамилия - * N - Имя - * F - Отчество - * - * Например getFormatted(1, 'N F') - * Выведет имя и отчество в родительном падиже - * - * @return string + /** + * Склоняет текущие слова в падеж <var>$caseNum</var> и форматирует слово по шаблону <var>$format</var> + * <b>Формат:</b> + * - S - Фамилия + * - N - Имя + * - F - Отчество + * @param string $format строка с форматом + * @return string строка в нужном падеже */ - public function getFormatted($caseNum=0, $format="S N F") { //Если не указан падеж используем другую функцию @@ -864,16 +959,21 @@ class NCLNameCaseCore extends NCL } } - /* - * Склоняет фамилию имя отчество в падеж $caseNum, и форматирует по шаблону $format - * Шаблон $format - * S - Фамилия - * N - Имя - * F - Отчество - * - * @return string + /** + * Склоняет фамилию <var>$secondName</var>, имя <var>$firstName</var>, отчество <var>$fatherName</var> + * в падеж <var>$caseNum</var> по правилам пола <var>$gender</var> и форматирует результат по шаблону <var>$format</var> + * <b>Формат:</b> + * - S - Фамилия + * - N - Имя + * - F - Отчество + * @param string $secondName фамилия + * @param string $firstName имя + * @param string $fatherName отчество + * @param int $gender пол + * @param int $caseNum номер падежа + * @param string $format формат + * @return mixed либо массив со всеми падежами, либо строка */ - public function qFullName($secondName="", $firstName="", $fatherName="", $gender=0, $caseNum=0, $format="S N F") { $this->fullReset(); @@ -888,12 +988,14 @@ class NCLNameCaseCore extends NCL return $this->getFormatted($caseNum, $format); } - /* - * Быстрое склонение имени. Передается один параметр строка, где может быть ФИО в любом виде. Есть необязательный параметр пол. И так ще необязательный параметр падеж. Если падеж указан, тогда возвращается строка в том падеже, если нет тогда все возможные падежи. - * - * @return string + /** + * Склоняет ФИО <var>$fullname</var> в падеж <var>$caseNum</var> по правилам пола <var>$gender</var>. + * Возвращает результат в таком же формате, как он и был. + * @param string $fullname ФИО + * @param int $caseNum номер падежа + * @param int $gender пол человека + * @return mixed либо массив со всеми падежами, либо строка */ - public function q($fullname, $caseNum=null, $gender=null) { $this->fullReset(); diff --git a/Library/NCL/NCLNameCaseInterface.php b/Library/NCL/NCLNameCaseInterface.php index 1003eb2..9b72fda 100644 --- a/Library/NCL/NCLNameCaseInterface.php +++ b/Library/NCL/NCLNameCaseInterface.php @@ -1,8 +1,15 @@ <?php +/** + * @license Dual licensed under the MIT or GPL Version 2 licenses. + * @package NameCaseLib + */ /** - * - * @author seagull + * Интерфейс для русского и украинского языка + * + * @author Андрей Чайка <bymer3@gmail.com> + * @version 0.4 + * @package NameCaseLib */ interface NCLNameCaseInterface { diff --git a/Library/NCL/NCLNameCaseWord.php b/Library/NCL/NCLNameCaseWord.php index c11ab9a..61e5804 100644 --- a/Library/NCL/NCLNameCaseWord.php +++ b/Library/NCL/NCLNameCaseWord.php @@ -1,9 +1,15 @@ <?php +/** + * @license Dual licensed under the MIT or GPL Version 2 licenses. + * @package NameCaseLib + */ /** * NCLNameCaseWord - класс, который служит для хранения всей информации о каждом слове + * * @author Андрей Чайка <bymer3@gmail.com> * @version 0.4 + * @package NameCaseLib */ class NCLNameCaseWord { @@ -73,15 +79,21 @@ class NCLNameCaseWord private $rule = 0; /** - * Создать запись из слова - * @param string $word + * Создание нового обьекта со словом <var>$word</var> + * @param string $word слово */ public function __construct($word) { $this->generateMask($word); $this->word = NCLStr::strtolower($word); } - + + /** + * Генерирует маску, которая содержит информацию о том, какие буквы в слове были большими, а какие маленькими: + * - x - маленькая буква + * - X - больная буква + * @param string $word слово, для которого генерировать маску + */ private function generateMask($word) { $letters = NCLStr::splitLetters($word); @@ -101,7 +113,12 @@ class NCLNameCaseWord } $this->letterMask = $mask; } - + + /** + * Возвращает все падежи слова в начальную маску: + * - x - маленькая буква + * - X - больная буква + */ private function returnMask() { if ($this->isUpperCase) @@ -134,18 +151,30 @@ class NCLNameCaseWord } } } - + + /** + * Сохраняет результат склонения текущего слова + * @param array $nameCases массив со всеми падежами + */ public function setNameCases($nameCases) { $this->NameCases = $nameCases; $this->returnMask(); } - + + /** + * Возвращает массив со всеми падежами текущего слова + * @return array массив со всеми падежами + */ public function getNameCases() { return $this->NameCases; } - + + /** + * Расчитывает и возвращает пол текущего слова + * @return int пол текущего слова + */ public function gender() { if (!$this->genderSolved) @@ -161,43 +190,88 @@ class NCLNameCaseWord } return $this->genderSolved; } - + + /** + * Устанавливает вероятности того, что даное слово является мужчиной или женщиной + * @param int $man вероятность того, что слово мужчина + * @param int $woman верятность того, что слово женщина + */ public function setGender($man, $woman) { $this->genderMan = $man; $this->genderWoman = $woman; } + /** + * Окончательно устанавливает пол человека + * - 0 - не определено + * - NCL::$MAN - мужчина + * - NCL::$WOMAN - женщина + * @param int $gender пол человека + */ public function setTrueGender($gender) { $this->genderSolved = $gender; } - + + /** + * Возвращает массив вероятности того, что даное слово является мужчиной или женщиной + * @return array массив вероятностей + */ public function getGender() { return array(NCL::$MAN => $this->genderMan, NCL::$WOMAN => $this->genderWoman); } - + + /** + * Устанавливает тип текущего слова + * <b>Тип слова:</b> + * - S - Фамилия + * - N - Имя + * - F - Отчество + * @param string $namePart тип слова + */ public function setNamePart($namePart) { $this->namePart = $namePart; } - + + /** + * Возвращает тип текущего слова + * <b>Тип слова:</b> + * - S - Фамилия + * - N - Имя + * - F - Отчество + * @return string $namePart тип слова + */ public function getNamePart() { return $this->namePart; } - + + /** + * Возвращает текущее слово. + * @return string текущее слово + */ public function getWord() { return $this->word; } + /** + * Если уже был расчитан пол для всех слов системы, тогда каждому слову предается окончательное + * решение. Эта функция определяет было ли принято окончательное решение. + * @return bool было ли принято окончательное решение по поводу пола текущего слова + */ public function isGenderSolved() { return ($this->genderSolved ? true : false); } + /** + * Устанавливает номер правила по которому склонялось текущее слово. + * @param int $ruleID номер правила + */ public function setRule($ruleID) { $this->rule = $ruleID; diff --git a/Library/NCL/NCLStr.php b/Library/NCL/NCLStr.php index 6efc4d7..fdfddfa 100644 --- a/Library/NCL/NCLStr.php +++ b/Library/NCL/NCLStr.php @@ -1,83 +1,115 @@ <?php - -/* - * To change this template, choose Tools | Templates - * and open the template in the editor. +/** + * @license Dual licensed under the MIT or GPL Version 2 licenses. + * @package NameCaseLib */ /** - * Description of NCLStr - * - * @author seagull + * Класс содержит функции для работы со строками, которые используются в NCLNameCaseLib + * + * @author Андрей Чайка <bymer3@gmail.com> + * @version 0.4 + * @package NameCaseLib */ class NCLStr { - + /** + * Кодировка, в котороя работает система + * @var string + */ static $charset = 'utf-8'; - /* - * Обертка для substr + /** + * Получить подстроку из строки + * @param string $str строка + * @param int $start начало подстроки + * @param int $length длина подстроки + * @return int подстрока */ - static function substr($str, $start, $length=null) { return mb_substr($str, $start, $length, NCLStr::$charset); } - /* - * Обертка для strpos + /** + * Поиск подстроки в строке + * @param string $haystack строка, в которой искать + * @param string $needle подстрока, которую нужно найти + * @param int $offset начало поиска + * @return int позиция подстроки в строке */ - static function strpos($haystack, $needle, $offset = 0) { return mb_strpos($haystack, $needle, $offset, NCLStr::$charset); } - /* - * Обертка для strlen + /** + * Определение длины строки + * @param string $str строка + * @return int длина строки */ - static function strlen($str) { return mb_strlen($str, NCLStr::$charset); } - /* - * Обертка для strtolower + /** + * Переводит строку в нижний регистр + * @param string $str строка + * @return string строка в нижнем регистре */ - static function strtolower($str) { return mb_strtolower($str, NCLStr::$charset); } - + + /** + * Переводит строку в верхний регистр + * @param string $str строка + * @return string строка в верхнем регистре + */ static function strtoupper($str) { return mb_strtoupper($str, NCLStr::$charset); } /** - * Обертка для strrpos - * @param type $haystack - * @param type $needle - * @param type $offset - * @return type + * Поиск подстроки в строке справа + * @param string $haystack строка, в которой искать + * @param string $needle подстрока, которую нужно найти + * @param int $offset начало поиска + * @return int позиция подстроки в строке */ static function strrpos($haystack, $needle, $offset=null) { return mb_strrpos($haystack, $needle, $offset, NCLStr::$charset); } - + + /** + * Проверяет в нижнем ли регистре находится строка + * @param string $phrase строка + * @return bool в нижнем ли регистре строка + */ static function isLowerCase($phrase) { return ($phrase == NCLStr::strtolower($phrase)); } + /** + * Проверяет в верхнем ли регистре находится строка + * @param string $phrase строка + * @return bool в верхнем ли регистре строка + */ static function isUpperCase($phrase) { return ($phrase == NCLStr::strtoupper($phrase)); } - + + /** + * Превращает строку в массив букв + * @param string $phrase строка + * @return array массив букв + */ static function splitLetters($phrase) { $resultArr = array(); @@ -89,11 +121,22 @@ class NCLStr return $resultArr; } + /** + * Соединяет массив букв в строку + * @param array $lettersArr массив букв + * @return string строка + */ static function connectLetters($lettersArr) { return implode('', $lettersArr); } + /** + * Разбивает строку на части использую шаблон + * @param string $pattern шаблон разбития + * @param string $string строка, которую нужно разбить + * @return array разбитый массив + */ static function explode($pattern, $string) { return mb_split($pattern, $string);