aboutsummaryrefslogtreecommitdiff
path: root/src/NXP/Resources/doc
diff options
context:
space:
mode:
Diffstat (limited to 'src/NXP/Resources/doc')
-rw-r--r--src/NXP/Resources/doc/index.rst41
1 files changed, 41 insertions, 0 deletions
diff --git a/src/NXP/Resources/doc/index.rst b/src/NXP/Resources/doc/index.rst
new file mode 100644
index 0000000..4b94f4d
--- /dev/null
+++ b/src/NXP/Resources/doc/index.rst
@@ -0,0 +1,41 @@
+Rutils Symfony 2 Bundle
+=======================
+
+Простой бандл для Symfony 2 содержащий в себе расширение для Twig, позволяющее использовать функции из библиотеки RUtils_ в шаблонах.
+
+Допускается как вызов в стиле функций::
+
+ {{ getPlural(10, ['гвоздь', 'гвоздя', 'гвоздей']) }}
+
+так и в стиле фильтров::
+
+ {{ 10 | getPlural(['гвоздь', 'гвоздя', 'гвоздей']) }}
+
+Поддерживаются все методы библиотеки:
+
+Числительные::
+ getInWords\2 - вывод числа прописью
+ getInWordsInt\2 - вывод числа прописью
+ getInWordsFloat\2 - вывод числа прописью
+ getPlural\3 - выбор формы множественного числа и вывод вместе с числом
+ choosePlural\2 - выбор только формы множественного числа
+ sumString\3 - выбор формы и вывод прописью
+ getRubles\2 - вывод суммы денег в рублях
+
+Даты::
+ ruStrFTime\6 - вывод даты строкой
+ distanceOfTimeInWords\3 - временной период
+ getAge\1 - возраст
+
+Транслитерация::
+ translify\1 - транслитерация
+ detranslify\1 - обратное преобразование
+ slugify\1 - подготовка для использования в URL'ях или путях
+
+Типографика::
+ typography\2
+
+TODO::
+ написать нормальную документацию
+
+.. _RUtils: https://github.com/Andre-487/php_rutils/ \ No newline at end of file