NameCaseLib/README.md

# NameCaseLib
Библиотека для PHP5 позволяет склонять по падежам Фамилию Имя Отчество. Имеет очень хороший алгоритм склонения Имен, Отчеств и Фамилий. Это первая публичная версия библиотеки. Пожалуйста оставляйте все свои пожелания и замечания.
## Туториал
Встроенные константы
-----------
* NCLNameCaseRu::$MAN - мужской пол
* NCLNameCaseRu::$WOMAN - женский пол

* NCLNameCaseRu::$IMENITLN - именительный падеж
* NCLNameCaseRu::$RODITLN - родительные падеж
* NCLNameCaseRu::$DATELN - дательные падеж
* NCLNameCaseRu::$VINITELN - винительный падеж
* NCLNameCaseRu::$TVORITELN - творительный падеж
* NCLNameCaseRu::$PREDLOGN - предложный падеж
 

Описание формата вывода
-----------
* S - фамилия
* N - имя
* F - отчество


Пример использования
-----------

echo 'Отчет, ' .
 $nc->qFullName("Афонин", "Николай", "Сергеевич", NCLNameCaseRu::$MAN, NCLNameCaseRu::$RODITLN)
 . ' о проделаной работе вместе с его сыном ' .
 $nc->qFullName("Афонин", "Никита", "", NCLNameCaseRu::$MAN, NCLNameCaseRu::$TVORITELN, "N S") .
 ' на осенних каникулах. Задание держалось ' .
 $nc->qFullName("", "Маргаритта", "Николаевна", NCLNameCaseRu::$WOMAN, NCLNameCaseRu::$PREDLOGN, "на N F; ") .
 'Поздравляем всех предчастных, в том числе и ' .
 $nc->qFullName("Кардонский", "Серафим", "Ильич", NCLNameCaseRu::$MAN, NCLNameCaseRu::$VINITELN) . ' и ' .
 $nc->qFullName("Лобудская", "София", "Викторовна", NCLNameCaseRu::$WOMAN, NCLNameCaseRu::$VINITELN) .
 '. Хотим передать поздравление также ' .
 $nc->qFullName("Игнатьев", "Павел", "Викторович", NCLNameCaseRu::$MAN, NCLNameCaseRu::$DATELN) . ' и ' .
 $nc->qFullName("Сумарский", "Лев", "", NCLNameCaseRu::$MAN, NCLNameCaseRu::$DATELN, "S N");


Результат выполнения
-----------
Отчет, Афонина Николая Сергеевича о проделаной работе вместе с его сыном Никитой Афониным на осенних каникулах. Задание держалось на Маргаритте Николаевне; Поздравляем всех предчастных, в том числе и Кардонского Серафима Ильича и Лобудскую Софию Викторовну. Хотим передать поздравление также Игнатьеву Павлу Викторовичу и Сумарскому Льву
Дополнительно
-----------
Дополнительные демонстрации находятся в папке Tutorial

Лицензия
-----------
Dual licensed under the MIT or GPL Version 2 licenses.

## 0.1.1 (2011-05-03)
- Написана функция определения пола NCLNameCaseRu::GenderAutoDetect() — отлично справляется с парами Имя Фамилия, по моим тестам дает 100% прохождение тестов (2000 пар имен и фамилий). Если указано отчество, пол определает без проблем.Для просто имен вероятность правильного определения больше 98,5%. Для просто фамилий — больше 96%.

## 0.1.0 (2011-05-01)
- Первая версия библиотеки