Joomla! Documentation - User contributions [en]

Translations:Joomla CodeSniffer/Page display title/ru

2020-01-03T16:11:07Z

B2z: Created page with "Joomla CodeSniffer"

Joomla CodeSniffer

Joomla CodeSniffer/ru

2020-01-03T16:10:47Z

B2z: Created page with "* Установите phpcs и стандарты Joomla, как описано выше. * В '''Atom > Preferences > Install''' установите '''linter-phpcs''' и..."

<noinclude><languages /></noinclude>

== Анализатор кода для Joomla ==
Это кастомный стандарт оформления кода для PHP CodeSniffer, который пытается привести всё к единому стандарту оформления кода в Joomla. В этом материале описывается, как настроить автоматическую проверку стиля оформления кода.
# Установка PHP CodeSniffer (phpcs).
# Клонирование Joomla Code Style (для использования с phpcs).
# Настройки вашей IDE для работы с PHP CodeSniffer и Joomla Code Style.

[[File:CodeSnifferInAction.jpg|center|thumb|300px|PHP Code Sniffer in action]]

==Зачем?==
*Понятная и устойчивая практика написания кода заставляет выглядеть файлы более профессионально. Конфликтующие стили в том же проекте (или ещё хуже, в том же файле) не только выглядят небрежно, но и поощряют ещё большую небрежность.
*Когда весь код соответствует единому стандарту, плохой код намного легче обнаружить.
*Для того, кто только начал разбираться с файлом в проекте, намного проще найти и исправить ошибки или расширить функциональность.
*Если нет постоянно поддерживаемого стандарта, разработчики будут форматировать текст как им удобнее. Это приводит к широкому диапазону изменений в репозитории с кодом. Если проблема обнаружится на последней стадии, то значительная часть изменений может быть утеряна при выборке во время diff.

==1. Установка PHP Code Sniffer (phpcs)==
===Composer===
PHP Code Sniffer доступен через Composer. Он может быть установлен в рамках всей системы следующей командой:<br />
<tt>composer global require squizlabs/php_codesniffer "~2.8"</tt>
На '''Linux''' PHP Code Sniffer (phpcs) будет установлен в папку вашего пользователя:
* Символическая ссылка: <tt>~/.composer/vendor/bin/phpcs</tt>
* Файл: <tt>~/.composer/vendor/squizlabs/php_codesniffer/scripts/phpcs</tt>
Для создания символической ссылки, используйте командную строку: <code>
$ sudo ln -s ~/.config/composer/vendor/squizlabs/php_codesniffer/scripts /usr/bin/phpcs
</code>

или (например OpenSuse)
* Символическая ссылка: <tt>~/.config/composer/vendor/bin/phpcs</tt>
* Файл: <tt>~/.config/composer/vendor/squizlabs/php_codesniffer/scripts/phpcs</tt>

На '''Windows''' PHP Code Sniffer (phpcs) будет установлен в папку вашего пользователя:
* Символическая ссылка: <tt>c:\Users\Username\AppData\Roaming\Composer\vendor\bin\phpcs</tt>
* Файл: <tt>c:\Users\Username\AppData\Roaming\Composer\vendor\squizlabs\php_codesniffer\scripts\phpcs</tt>

=== Добавление директории bin composer к переменной $PATH ===
Для того, чтобы запускать PHP Code sniffer откуда угодно в командной строке Linux или Mac, необходимо добавить <tt>.composer/vendor/bin</tt> к вашей переменной $PATH.
Для того, чтобы зафиксировать это на постоянной основе, отредактируйте стартовый файл оболочки, например .profile или .bash_profile, в зависимости от того, какую оболочку вы используете (echo $SHELL покажет вам, какую вы используете).

Добавьте следующую строку в файл:
<tt>export PATH=$PATH:~/.composer/vendor/bin</tt>

В качестве альтернативы вы можете создать симовлическую ссылку в папке bin:
<tt>ln -s ~/.composer/vendor/bin/phpcs /usr/local/bin/phpcs</tt>

==2. Установка Joomla Coding Standards==
Для того, чтобы PHP Code Sniffer (phpcs) начал "нюхать" (проверять) ваши проекты Joomla на правильный стиль оформления кода, вам необходимо установить Joomla Coding Standards (стандарты оформления кода в Joomla).

Используя composer, мы можем запустить:
<tt>composer global require joomla/coding-standards "~2.0@alpha"</tt>

Обратите внимание на <tt>@alpha</tt>. Всё потому, что стандарт всё ещё в стадии альфа, и мы должны позволить установку кода, со статусом alpha. Если мы не укажем @alpha, то стандарты не будут установлены и выкинут ошибку.

<pre>
Your requirements could not be resolved to an installable set of packages.

Problem 1
- The requested package joomla/coding-standards ~2.0 is satisfiable by joomla/coding-standards[2.0.0-alpha, 2.0.0-alpha2, 2.x-dev] but these conflict with your requirements or minimum-stability.
</pre>

Как только установка завершится, стандарт оформления кода будет установлен в глобальную папку composer. Расположение этой папки зависит от вашей операционной системы. Вот некоторые популярные места расположения:

'''Mac / Linux'''
~/.composer/vendor/joomla/coding-standards/

~/.config/composer/vendor/joomla/coding-standards/
'''Windows'''
c:\Users\Username\AppData\Roaming\Composer\vendor\joomla\coding-standards\
Так это выглядит при использовании Composer в Windows.

Если вы не можете найти ни одну из выше указанных папок, то учите, что папка, которую вы ищите, заканчивается на '''\joomla\coding-standards\'''
И наконец, мы должны дать понятьCode Sniffer, что стандарты оформления кода Joomla существуют.

'''Установка Joomla Coding Standards'''
# Проверьте, пути установлены или нет, запустив команду <tt>phpcs --config-show</tt>
# Вы можете получить ответ, который выглядит вот так: <tt>installed_paths: /path/to/installation</tt>
# На шаге 2, если вы видите '''installed_paths''', скопируйте их
# Установите путь Joomla Coding Standards в phpcs вызовом команды <tt>phpcs --config-set installed_paths /Users/user/.composer/vendor/joomla/coding-standards</tt>. Если вы скопировали пути на шаге 2, включите их здесь, разделяя запятой. Команда будет выглядеть как <tt>phpcs --config-set installed_paths [/to/path1],[/to/path2],[/Users/user/.composer/vendor/joomla/coding-standards]</tt>
# Убедитесь, что путь установлен верно, запустив команду <tt>phpcs --config-show</tt>
# Убедитесь, что phpcs видит стандарт оформления кода Joomla, запустив команду <tt>phpcs -i</tt>
# Вывод должен выглядеть вот так: <tt>The installed coding standards are MySource, PEAR, PHPCS, PSR1, PSR2, Squiz, Zend and Joomla</tt>

== Использование ==
Вы вызываете кастомный стандарт через
<tt>phpcs --standard=Joomla file/to/sniff</tt>

Для тестирования файлов platform со стандартом разработки platform, используйте
<tt>phpcs --standard=build/phpcs/Joomla path/to/file/or/folder</tt>

Дополнительная документация по использованию phpcs доступна здесь: [http://pear.php.net/package/PHP_CodeSniffer/docs]

==3. Интеграция с IDE ==
Все любять консоль. Это, без сомнения, самый эффективный путь делать то, что захочется. Но иногда и гуру Linux нуждаются в небольшом комфорте.

К счастью, для PhpStorm, Eclipse и Netbeans существует плагин, который интегрирует CodeSniffer в вашу любимую IDE, поэтому нарушения стандартов оформления кода показываются как "обычные" ошибки.

=== PhpStorm ===
Code Sniffer поддерживается PhpStorm из коробки. Зайдите в Settings, и в Editor {{rarr}} Inspections вы увидите список установленных снифферов.
==== Установите путь до Code Sniffer ====
# Откройте Settings (CTRL-ALT-S / CMD-,)
# Перейдите в Languages & Frameworks
# Щёлкните на PHP
# Щёлкните на Quality Tools
# Щёлкните на область PHP CS Fixer
# Настройка по умолчанию установлена в Local
# Щёлкните на 3 точки за ней для открытия настроечного экрана
# Первая опция и есть путь PHP Code Sniffer (phpcs)
# Щёлкните на 3 точки за путём для выбора расположения файла phpcs. Смотрите выше, где может быть установлен phpcs.
# Щёлкните на Validate, чтобы убедиться в том, что путь верен и phpcs работает
# Щёлкните OK

===== Активизация Joomla Code Style =====
# Откройте Settings (CTRL-ALT-S / CMD-,)
# Перейдите в Editor
# Щёлкните на Inspections
# В списке перейдите к PHP
# Щёлкните на PHP Code Sniffer Validation
# Щёлкните на чекбокс за ним, для активации
# Щёлкните на кнопку Reload (2 стрелки) для принудительной перезагрузки правил с диска
# Теперь в списке должна стать доступной Joomla. Смотрите на картинке:{{-}}[[File:PhpStorm8CodeSniffer.png|PHPStorm CodeSniffer|500px]]
# Щёлкните OK

==== PHP PSR-0, PSR-1 и PSR-2 ====
* https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md
* https://github.com/pmjones/fig-standards/blob/psr-1-style-guide/proposed/PSR-1-basic.md
* https://github.com/pmjones/fig-standards/blob/psr-1-style-guide/proposed/PSR-2-advanced.md

===== Использование PHP PSR-1 и PSR-2 Sniff =====
CodeSniffer также может быть использован и для PSR-x Coding Standard. В этом случае вы просто выбираете другой стандарт, а не Joomla.
===== Использование стиля офрмления кода Joomla =====
Было бы неплохо проверять, что стандарты действительно учитываются. А ещё лучше, если бы PhpStorm помогал вам с форматированием по мере того, как вы пишете код.
Для использования стиля оформления кода в PhpStorm
# Откройте Settings (CTRL-ALT-S / CMD-,)
# Пройдите в Editor
# Щёлкните на Code Style
# Выберите Joomla в списке Scheme

==== PhpStorm / Альтернативный метод ====
'''Примечание''': Метод '''просрочен''', но может быть полезен, если вы ищете возможности другой интегрции. Он также демонстрирует использование внешних инструментов в PhpStorm - так что ''не стоит его удалять''.

Code Sniffer также может быть легко интегрирован как внешний инструмент. PhpStorm отобразит вывод в консоли, в том числе ссылки с возможностью щелчка, содержащие номера строк и столбцов с файлами, которые содержат ошибки.

* Щёлкните на "Settings" и найдите "External tools"
* Щёлкните "Add..."
* Выберите "Name", "Group" and "Description".
* Щёлкните "Output Filters"
** Щёлкните "Add...", выберите название и введите в "Regular expression to match output" значение: <tt>$FILE_PATH$:$LINE$:$COLUMN$</tt>
* "Program": найдите в вашей системе исполняемый файл phpcs. Вы должны выбрать путь до ''phpcs.bat'' из установленного пакета PHP_CodeSniffer PEAR
** Для Unix систем, путём будет что-то вроде /usr/bin/phpcs
** В XAMPP (windows), вы можете найти файл в корне папки PHP (например, C:\xampp\php\phpcs.bat)
* "Parameters":
** <tt>--standard=<path/to/joomla-platform>/build/phpcs/Joomla</tt> Путь до стандартов оформления кода Joomla.
** <tt>--report=emacs</tt> Это сгенерирует простой список, содержащий ссылки на файлы ошибок
** Опционально вы можете указать <tt>-p</tt> для "progress" или <tt>-n</tt> для "errors only".
** Последним параметром должен быть <tt>$FilePath$</tt>, который должен указывать на папку или файл, которые вы хотите проверить.

Типичная строка "Parameters" на Linux системах может выглядеть вот так:
<pre>-np --standard=/home/elkuku/libs/joomla/build/phpcs/Joomla --report=emacs $FilePath$</pre>

Теперь вы можете сделать правый щелчок на любом файле или папке и выбрать сниффер из контекстного меню. Или можете добавить кнопку на панель инструментов с красивым лого Joomla. [[File:icon-16-joomla.png]].

=== Netbeans ===
У Netbeans функциональность сниффера встроена в ядро системы.

# Запустите Netbeans IDE
# Откройте Tools => Options => PHP => Code Analysis => Code Sniffer
# Вы должны установить путь до ''phpcs.bat'' из установленного пакета PHP_CodeSniffer PEAR
#* Для Unix систем, путём будет что-то вроде /usr/bin/phpcs
#* В XAMPP (windows), вы можете найти файл в корне папки PHP (например, C:\xampp\php\phpcs.bat)
# Как "Default Standard," выберите "Joomla"
# Теперь можете щёлкнуть на ''OK''
# Откройте из верхнего меню Source => Inspect...
# Наслаждайтесь

=== Eclipse ===
[[Image:eclipse_pti.png|left|thumb|200px|1) Eclipse PTI]]
{{-}}
Установка следует обычному шаблону:
# <tt>Help => Install New Software...</tt>
# <tt>Work with:</tt> Заполните одним из адресов URLs, которые можно найти здесь: http://www.phpsrc.org/eclipse/pti/
# Выберите нужный инструмент
# Перезапустите Eclipse.

[[Image:eclipse_pti_settings.png|right|thumb|150px|2) Настройки Eclipse PTI]]
Теперь вы можете выполнять проверку кода согласно таким стандартам как PEAR, Zend и т.п..

Для выполения проверки собственных стандартов, укажите расположение и активизируйте (смотрите скриншот 2)
# <tt>Window => Preferences</tt>
# <tt>PHP Tools => PHP CodeSniffer</tt>

Удачного сниффинга.

=== Geany ===
* Откройте PHP файл. (Иначе меню build недоступно.) Смотрите [http://static.xscreenshot.com/2016/07/13/08/screen_6bc0692cf995702a1e379b39643d0c2d Screenshot]
* В верхнем меню выберите Build->Set Build Commands.
* Выберите второе поле и назовите его по своему желанию. Введите этот код в Command: <code>phpcs --standard=Joomla "%f" | sed -e 's/^/%f |/' | egrep 'WARNING|ERROR'</code>
* Введите этот код в поле Error Regular Expression: <code>(.+) [|]\s+([0-9]+)</code> See this [http://view.xscreenshot.com/ef00820cf7c017ce659c8e9f0b02d3ae Screenshot]
* Выберите OK.
* Если окно Message не открыто, отобразите его, выбрав в верхнем меню View.
* При просмотре любого PHP файла, нажмите F9 для просмотра найденных ошибок. [http://view.xscreenshot.com/8704b9fd1bda3f841364a0ffa28a54ae Screenshot]

=== Atom ===
* Установите phpcs и стандарты Joomla, как описано выше.
* В '''Atom > Preferences > Install''' установите '''linter-phpcs''' и все его требования.
* В '''Atom > Preferences > Packages > linter-phpcs > Settings''' настройте
** '''Executable Path''' путь до вашего phpcs
** '''Code Standard Or Config File''': Joomla
** '''Tab Width''': 4

=== Ссылки ===
* https://github.com/joomla/coding-standards - Joomla! Coding Standards
* http://www.phpsrc.org/ PTI - инструменты интеграции PHP для Eclipse
* http://sourceforge.net/projects/phpmdnb/ Плагин Netbeans
* http://hakre.wordpress.com/2010/03/06/php-code-sniffer-eclipse-and-wordpress/ - Отличный материал. Просто поменяйте "Wordpress" на "Joomla!"

<noinclude>
[[Category:Development{{#translation:}}]]
[[Category:Bug Squad{{#translation:}}]]
[[Category:IDE (Integrated development environment){{#translation:}}]]
</noinclude>

Translations:Joomla CodeSniffer/79/ru

2020-01-03T16:10:47Z

* Установите phpcs и стандарты Joomla, как описано выше.
* В '''Atom > Preferences > Install''' установите '''linter-phpcs''' и все его требования.
* В '''Atom > Preferences > Packages > linter-phpcs > Settings''' настройте
** '''Executable Path''' путь до вашего phpcs
** '''Code Standard Or Config File''': Joomla
** '''Tab Width''': 4

Translations:Joomla CodeSniffer/78/ru

2020-01-03T16:09:40Z

B2z: Created page with "=== Atom ==="

=== Atom ===

Joomla CodeSniffer/ru

2020-01-03T16:09:24Z

B2z: Created page with "Code Sniffer также может быть легко интегрирован как внешний инструмент. PhpStorm отобразит вывод в конс..."

<noinclude><languages /></noinclude>

== Анализатор кода для Joomla ==
Это кастомный стандарт оформления кода для PHP CodeSniffer, который пытается привести всё к единому стандарту оформления кода в Joomla. В этом материале описывается, как настроить автоматическую проверку стиля оформления кода.
# Установка PHP CodeSniffer (phpcs).
# Клонирование Joomla Code Style (для использования с phpcs).
# Настройки вашей IDE для работы с PHP CodeSniffer и Joomla Code Style.

[[File:CodeSnifferInAction.jpg|center|thumb|300px|PHP Code Sniffer in action]]

==Зачем?==
*Понятная и устойчивая практика написания кода заставляет выглядеть файлы более профессионально. Конфликтующие стили в том же проекте (или ещё хуже, в том же файле) не только выглядят небрежно, но и поощряют ещё большую небрежность.
*Когда весь код соответствует единому стандарту, плохой код намного легче обнаружить.
*Для того, кто только начал разбираться с файлом в проекте, намного проще найти и исправить ошибки или расширить функциональность.
*Если нет постоянно поддерживаемого стандарта, разработчики будут форматировать текст как им удобнее. Это приводит к широкому диапазону изменений в репозитории с кодом. Если проблема обнаружится на последней стадии, то значительная часть изменений может быть утеряна при выборке во время diff.

==1. Установка PHP Code Sniffer (phpcs)==
===Composer===
PHP Code Sniffer доступен через Composer. Он может быть установлен в рамках всей системы следующей командой:<br />
<tt>composer global require squizlabs/php_codesniffer "~2.8"</tt>
На '''Linux''' PHP Code Sniffer (phpcs) будет установлен в папку вашего пользователя:
* Символическая ссылка: <tt>~/.composer/vendor/bin/phpcs</tt>
* Файл: <tt>~/.composer/vendor/squizlabs/php_codesniffer/scripts/phpcs</tt>
Для создания символической ссылки, используйте командную строку: <code>
$ sudo ln -s ~/.config/composer/vendor/squizlabs/php_codesniffer/scripts /usr/bin/phpcs
</code>

или (например OpenSuse)
* Символическая ссылка: <tt>~/.config/composer/vendor/bin/phpcs</tt>
* Файл: <tt>~/.config/composer/vendor/squizlabs/php_codesniffer/scripts/phpcs</tt>

На '''Windows''' PHP Code Sniffer (phpcs) будет установлен в папку вашего пользователя:
* Символическая ссылка: <tt>c:\Users\Username\AppData\Roaming\Composer\vendor\bin\phpcs</tt>
* Файл: <tt>c:\Users\Username\AppData\Roaming\Composer\vendor\squizlabs\php_codesniffer\scripts\phpcs</tt>

=== Добавление директории bin composer к переменной $PATH ===
Для того, чтобы запускать PHP Code sniffer откуда угодно в командной строке Linux или Mac, необходимо добавить <tt>.composer/vendor/bin</tt> к вашей переменной $PATH.
Для того, чтобы зафиксировать это на постоянной основе, отредактируйте стартовый файл оболочки, например .profile или .bash_profile, в зависимости от того, какую оболочку вы используете (echo $SHELL покажет вам, какую вы используете).

Добавьте следующую строку в файл:
<tt>export PATH=$PATH:~/.composer/vendor/bin</tt>

В качестве альтернативы вы можете создать симовлическую ссылку в папке bin:
<tt>ln -s ~/.composer/vendor/bin/phpcs /usr/local/bin/phpcs</tt>

==2. Установка Joomla Coding Standards==
Для того, чтобы PHP Code Sniffer (phpcs) начал "нюхать" (проверять) ваши проекты Joomla на правильный стиль оформления кода, вам необходимо установить Joomla Coding Standards (стандарты оформления кода в Joomla).

Используя composer, мы можем запустить:
<tt>composer global require joomla/coding-standards "~2.0@alpha"</tt>

Обратите внимание на <tt>@alpha</tt>. Всё потому, что стандарт всё ещё в стадии альфа, и мы должны позволить установку кода, со статусом alpha. Если мы не укажем @alpha, то стандарты не будут установлены и выкинут ошибку.

<pre>
Your requirements could not be resolved to an installable set of packages.

Problem 1
- The requested package joomla/coding-standards ~2.0 is satisfiable by joomla/coding-standards[2.0.0-alpha, 2.0.0-alpha2, 2.x-dev] but these conflict with your requirements or minimum-stability.
</pre>

Как только установка завершится, стандарт оформления кода будет установлен в глобальную папку composer. Расположение этой папки зависит от вашей операционной системы. Вот некоторые популярные места расположения:

'''Mac / Linux'''
~/.composer/vendor/joomla/coding-standards/

~/.config/composer/vendor/joomla/coding-standards/
'''Windows'''
c:\Users\Username\AppData\Roaming\Composer\vendor\joomla\coding-standards\
Так это выглядит при использовании Composer в Windows.

Если вы не можете найти ни одну из выше указанных папок, то учите, что папка, которую вы ищите, заканчивается на '''\joomla\coding-standards\'''
И наконец, мы должны дать понятьCode Sniffer, что стандарты оформления кода Joomla существуют.

'''Установка Joomla Coding Standards'''
# Проверьте, пути установлены или нет, запустив команду <tt>phpcs --config-show</tt>
# Вы можете получить ответ, который выглядит вот так: <tt>installed_paths: /path/to/installation</tt>
# На шаге 2, если вы видите '''installed_paths''', скопируйте их
# Установите путь Joomla Coding Standards в phpcs вызовом команды <tt>phpcs --config-set installed_paths /Users/user/.composer/vendor/joomla/coding-standards</tt>. Если вы скопировали пути на шаге 2, включите их здесь, разделяя запятой. Команда будет выглядеть как <tt>phpcs --config-set installed_paths [/to/path1],[/to/path2],[/Users/user/.composer/vendor/joomla/coding-standards]</tt>
# Убедитесь, что путь установлен верно, запустив команду <tt>phpcs --config-show</tt>
# Убедитесь, что phpcs видит стандарт оформления кода Joomla, запустив команду <tt>phpcs -i</tt>
# Вывод должен выглядеть вот так: <tt>The installed coding standards are MySource, PEAR, PHPCS, PSR1, PSR2, Squiz, Zend and Joomla</tt>

== Использование ==
Вы вызываете кастомный стандарт через
<tt>phpcs --standard=Joomla file/to/sniff</tt>

Для тестирования файлов platform со стандартом разработки platform, используйте
<tt>phpcs --standard=build/phpcs/Joomla path/to/file/or/folder</tt>

Дополнительная документация по использованию phpcs доступна здесь: [http://pear.php.net/package/PHP_CodeSniffer/docs]

==3. Интеграция с IDE ==
Все любять консоль. Это, без сомнения, самый эффективный путь делать то, что захочется. Но иногда и гуру Linux нуждаются в небольшом комфорте.

К счастью, для PhpStorm, Eclipse и Netbeans существует плагин, который интегрирует CodeSniffer в вашу любимую IDE, поэтому нарушения стандартов оформления кода показываются как "обычные" ошибки.

=== PhpStorm ===
Code Sniffer поддерживается PhpStorm из коробки. Зайдите в Settings, и в Editor {{rarr}} Inspections вы увидите список установленных снифферов.
==== Установите путь до Code Sniffer ====
# Откройте Settings (CTRL-ALT-S / CMD-,)
# Перейдите в Languages & Frameworks
# Щёлкните на PHP
# Щёлкните на Quality Tools
# Щёлкните на область PHP CS Fixer
# Настройка по умолчанию установлена в Local
# Щёлкните на 3 точки за ней для открытия настроечного экрана
# Первая опция и есть путь PHP Code Sniffer (phpcs)
# Щёлкните на 3 точки за путём для выбора расположения файла phpcs. Смотрите выше, где может быть установлен phpcs.
# Щёлкните на Validate, чтобы убедиться в том, что путь верен и phpcs работает
# Щёлкните OK

===== Активизация Joomla Code Style =====
# Откройте Settings (CTRL-ALT-S / CMD-,)
# Перейдите в Editor
# Щёлкните на Inspections
# В списке перейдите к PHP
# Щёлкните на PHP Code Sniffer Validation
# Щёлкните на чекбокс за ним, для активации
# Щёлкните на кнопку Reload (2 стрелки) для принудительной перезагрузки правил с диска
# Теперь в списке должна стать доступной Joomla. Смотрите на картинке:{{-}}[[File:PhpStorm8CodeSniffer.png|PHPStorm CodeSniffer|500px]]
# Щёлкните OK

==== PHP PSR-0, PSR-1 и PSR-2 ====
* https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-0.md
* https://github.com/pmjones/fig-standards/blob/psr-1-style-guide/proposed/PSR-1-basic.md
* https://github.com/pmjones/fig-standards/blob/psr-1-style-guide/proposed/PSR-2-advanced.md

===== Использование PHP PSR-1 и PSR-2 Sniff =====
CodeSniffer также может быть использован и для PSR-x Coding Standard. В этом случае вы просто выбираете другой стандарт, а не Joomla.
===== Использование стиля офрмления кода Joomla =====
Было бы неплохо проверять, что стандарты действительно учитываются. А ещё лучше, если бы PhpStorm помогал вам с форматированием по мере того, как вы пишете код.
Для использования стиля оформления кода в PhpStorm
# Откройте Settings (CTRL-ALT-S / CMD-,)
# Пройдите в Editor
# Щёлкните на Code Style
# Выберите Joomla в списке Scheme

==== PhpStorm / Альтернативный метод ====
'''Примечание''': Метод '''просрочен''', но может быть полезен, если вы ищете возможности другой интегрции. Он также демонстрирует использование внешних инструментов в PhpStorm - так что ''не стоит его удалять''.

Code Sniffer также может быть легко интегрирован как внешний инструмент. PhpStorm отобразит вывод в консоли, в том числе ссылки с возможностью щелчка, содержащие номера строк и столбцов с файлами, которые содержат ошибки.

* Щёлкните на "Settings" и найдите "External tools"
* Щёлкните "Add..."
* Выберите "Name", "Group" and "Description".
* Щёлкните "Output Filters"
** Щёлкните "Add...", выберите название и введите в "Regular expression to match output" значение: <tt>$FILE_PATH$:$LINE$:$COLUMN$</tt>
* "Program": найдите в вашей системе исполняемый файл phpcs. Вы должны выбрать путь до ''phpcs.bat'' из установленного пакета PHP_CodeSniffer PEAR
** Для Unix систем, путём будет что-то вроде /usr/bin/phpcs
** В XAMPP (windows), вы можете найти файл в корне папки PHP (например, C:\xampp\php\phpcs.bat)
* "Parameters":
** <tt>--standard=<path/to/joomla-platform>/build/phpcs/Joomla</tt> Путь до стандартов оформления кода Joomla.
** <tt>--report=emacs</tt> Это сгенерирует простой список, содержащий ссылки на файлы ошибок
** Опционально вы можете указать <tt>-p</tt> для "progress" или <tt>-n</tt> для "errors only".
** Последним параметром должен быть <tt>$FilePath$</tt>, который должен указывать на папку или файл, которые вы хотите проверить.

Типичная строка "Parameters" на Linux системах может выглядеть вот так:
<pre>-np --standard=/home/elkuku/libs/joomla/build/phpcs/Joomla --report=emacs $FilePath$</pre>

Теперь вы можете сделать правый щелчок на любом файле или папке и выбрать сниффер из контекстного меню. Или можете добавить кнопку на панель инструментов с красивым лого Joomla. [[File:icon-16-joomla.png]].

=== Netbeans ===
У Netbeans функциональность сниффера встроена в ядро системы.

# Запустите Netbeans IDE
# Откройте Tools => Options => PHP => Code Analysis => Code Sniffer
# Вы должны установить путь до ''phpcs.bat'' из установленного пакета PHP_CodeSniffer PEAR
#* Для Unix систем, путём будет что-то вроде /usr/bin/phpcs
#* В XAMPP (windows), вы можете найти файл в корне папки PHP (например, C:\xampp\php\phpcs.bat)
# Как "Default Standard," выберите "Joomla"
# Теперь можете щёлкнуть на ''OK''
# Откройте из верхнего меню Source => Inspect...
# Наслаждайтесь

=== Eclipse ===
[[Image:eclipse_pti.png|left|thumb|200px|1) Eclipse PTI]]
{{-}}
Установка следует обычному шаблону:
# <tt>Help => Install New Software...</tt>
# <tt>Work with:</tt> Заполните одним из адресов URLs, которые можно найти здесь: http://www.phpsrc.org/eclipse/pti/
# Выберите нужный инструмент
# Перезапустите Eclipse.

[[Image:eclipse_pti_settings.png|right|thumb|150px|2) Настройки Eclipse PTI]]
Теперь вы можете выполнять проверку кода согласно таким стандартам как PEAR, Zend и т.п..

Для выполения проверки собственных стандартов, укажите расположение и активизируйте (смотрите скриншот 2)
# <tt>Window => Preferences</tt>
# <tt>PHP Tools => PHP CodeSniffer</tt>

Удачного сниффинга.

=== Geany ===
* Откройте PHP файл. (Иначе меню build недоступно.) Смотрите [http://static.xscreenshot.com/2016/07/13/08/screen_6bc0692cf995702a1e379b39643d0c2d Screenshot]
* В верхнем меню выберите Build->Set Build Commands.
* Выберите второе поле и назовите его по своему желанию. Введите этот код в Command: <code>phpcs --standard=Joomla "%f" | sed -e 's/^/%f |/' | egrep 'WARNING|ERROR'</code>
* Введите этот код в поле Error Regular Expression: <code>(.+) [|]\s+([0-9]+)</code> See this [http://view.xscreenshot.com/ef00820cf7c017ce659c8e9f0b02d3ae Screenshot]
* Выберите OK.
* Если окно Message не открыто, отобразите его, выбрав в верхнем меню View.
* При просмотре любого PHP файла, нажмите F9 для просмотра найденных ошибок. [http://view.xscreenshot.com/8704b9fd1bda3f841364a0ffa28a54ae Screenshot]

=== Atom ===
* Install phpcs and the Joomla standards as described above.
* In '''Atom > Preferences > Install''' install '''linter-phpcs''' and all its requirements.
* In '''Atom > Preferences > Packages > linter-phpcs > Settings''' adjust
** '''Executable Path''' to the path of your phpcs
** '''Code Standard Or Config File''': Joomla
** '''Tab Width''': 4

=== Ссылки ===
* https://github.com/joomla/coding-standards - Joomla! Coding Standards
* http://www.phpsrc.org/ PTI - инструменты интеграции PHP для Eclipse
* http://sourceforge.net/projects/phpmdnb/ Плагин Netbeans
* http://hakre.wordpress.com/2010/03/06/php-code-sniffer-eclipse-and-wordpress/ - Отличный материал. Просто поменяйте "Wordpress" на "Joomla!"

<noinclude>
[[Category:Development{{#translation:}}]]
[[Category:Bug Squad{{#translation:}}]]
[[Category:IDE (Integrated development environment){{#translation:}}]]
</noinclude>

Another tutorial (a little out of date, but still useful) is at [http://eddify.me/posts/logging-in-joomla-with-jlog.html Logging in Joomla with JLog].
Другое руководство (немного устаревшее, но все же полезное) находится по адресу [http://eddify.me/posts/logging-in-joomla-with-jlog.html Logging in Joomla with JLog].

Using JLog/ru

2019-01-16T08:15:37Z

B2z: Created page with "Логирование в Joomla должно использоваться в тандеме с исключениями PHP, а не в качестве замены. Под..."

<noinclude><languages /></noinclude>

__TOC__
== Обзор ==
Логирование в Joomla дает вам возможность логировать сообщения в файлы и на экран (в консоли отладки Joomla внизу веб-страницы), а основным классом Joomla, который для этого используется, является JLog.

Логирование, в некоторой степени, может контролироваться динамически через общие настройки Joomla и путем настройки плагина Система - Отладка (поставляется с Joomla). В целом эти возможности позволяют вам:
* включать или отключать систему отладки - чтобы вы не потребляли ресурсы без необходимости, но при этом у вас оставалась информация, чтобы помочь в устранении неполадок, когда есть проблемы. Например, на живом сайте, на котором установлено ваше расширение.
* направлять сообщения логов в определенный файл логов вашего собственного расширения
* просматривать сообщения логов в консоли отладки - вы можете выбрать группу пользователей, для которых должны отображаться сообщения логов, чтобы на живом сайте разработчики могли видеть сообщения, в то время как другие пользователи не затрагивались.
* фильтровать сообщения консоли отладки по приоритету (например, INFO, DEBUG, WARNING и т. д.) и по категориям (вы можете сами определять свои категории).
Кроме того, сообщения логов могут быть переведены на разные языки.

Основные параметры конфигурации, относящиеся к ведению логов, показаны ниже.

Включение отладки и отображение консоли отладки Joomla контролируется через общие настройки.
[[File:Global conf debug-en.jpg]]

Логирование в общий файл логов контролируется с помощью вкладки Журнал (логи) конфигурации плагина Joomla Система - Отладка (в меню администратора нажмите «Расширения / Плагины», найдите плагин «Система - Отладка» и нажмите на него, чтобы изменить его настраиваемые параметры).
[[File:Debug logging settings-en.jpg]]

Параметры на вкладке "Плагин" контролируют отображение в консоли отладки Joomla.
[[File:Debug plugin settings-en.jpg]]

== Базовое логирование в файл ==

Чтобы залогировать сообщение, используйте функцию <tt>JLog::add()</tt>. Например:

JLog::add('my error message', JLog::ERROR, 'my-error-category');

Параметры
# Строка сообщения. Вы можете использовать перевод с этими значениями, например, <tt>JText::_('MY_EXTENSION_ERR_MSG')</tt>. Вы также можете отображать значения переменных при условии, что вы конвертируете их в строковый формат (например, с помощью <tt>__toString ()</tt>, если тип переменной это поддерживает).
# Приоритет, который может быть одним из: JLog::EMERGENCY, JLog::ALERT, JLog::CRITICAL, JLog::ERROR, JLog::WARNING, JLog::NOTICE, JLog::INFO, JLog::DEBUG (основано на уровнях серьёзности syslog / RFC 5424 – подробнее на [https://ru.wikipedia.org/wiki/Syslog материал Wikipedia о syslog]).
# Категория, которая является просто текстовой строкой. Вы можете определить любые категории, которые вам нравятся, и лучше всего определять их, чтобы избежать возможных конфликтов с другими расширениями.

Если вы включите диагностические сообщения отладки в ваше расширение, то это может быть очень полезно при устранении неполадок. В этом случае добавьте к своему лог сообщению проверку на JDEBUG:

if (JDEBUG)
{
JLog::add('my debug message', JLog::DEBUG, 'my-debug-category');
}

== Логирование в определённый файл лога ==
Вы можете использовать <tt>JLog::addLogger()</tt>, чтобы настроить ведение логов в дополнительный файл логов, отфильтровывая сообщения логов по приоритету (уровень серьезности) и / или категории. Параметры <tt>JLog::addLogger()</tt>:

# массив с деталями конфигурации - включая имя файла логов
# уровни серьезности, которые будут логироваться в этом файле
# массив категорий, которые будут логироваться в этом файле (или если для параметра 4 установлено значение <tt>true</tt>, тогда этот массив определяет категории, которые НЕ должны регистрироваться в файле)
# (часто пропускается) логическое значение, указывающее, является ли параметр 3 списком включения (по умолчанию P4 = <tt>false</tt>) или списком исключения (P4 = <tt>true</tt>)

Например, если вы разработали расширение 'com_helloworld', вы можете использовать следующее:

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.log.php'
),
// Sets messages of all log levels to be sent to the file
JLog::ALL,
// The log category/categories which should be recorded in this file
// In this case, it's just the one category from our extension, still
// we need to put it inside an array
array('com_helloworld')
);

Затем, когда вы логируете сообщение, укажите категорию 'com_helloworld', как в примере ниже

JLog::add(JText::_('COM_HELLOWORLD_ERROR_MESSAGE_123'), JLog::ERROR, 'com_helloworld');

Это приведет к тому, что ваше сообщение будет записано в com_helloworld.log.php. Если в настройках плагина «Система - Отладка» для параметра «Протоколировать все» задано значение «Да», то это сообщение появится и в общем файле журнала everything.php.

'''Примечание:''' Вы можете объединить это с [[S:MyLanguage/Display error messages and notices|Display error messages and notices]] для отображения видимых уведомлений об ошибках для пользователей.

Вы также можете добавить дополнительный логгер для сбора только критических и аварийных уведомлений:

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.critical_emergency.php'
),
// Sets critical and emergency log level messages to be sent to the file
JLog::CRITICAL + JLog::EMERGENCY,
// The log category which should be recorded in this file
array('com_helloworld')
);

Вы также можете исключить определенный уровень приоритета от включения в файл логов. Например, чтобы логировать все сообщения кроме DEBUG:

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.all_but_debug.php'
),
// Sets all but DEBUG log level messages to be sent to the file
JLog::ALL & ~JLog::DEBUG,
// The log category which should be recorded in this file
array('com_helloworld')
);

Уровни приоритета <tt>JLog</tt> реализованы в виде отдельных битов целого числа, поэтому вы можете использовать '''побитовые''' операции (побитовое AND, &; и побитовое NOT, ~) для вычисления подходящих уровней логов. <tt>JLog::All</tt> является постоянным целым числом, в котором установлены все соответствующие биты, так что включены все уровни приоритета Joomla.

== Форматирование файла лога ==

Первый параметр <tt>addLogger</tt> может иметь несколько необязательных дополнительных настроек в дополнение к записи <tt>text_file</tt>.

Например, есть параметр <tt>text_entry_format</tt>, указывающая формат каждой строки в вашем лог файле.

Формат по умолчанию:

'{DATETIME} {PRIORITY} {CATEGORY} {MESSAGE}'

Вот пример другого формата, который показывает, как пропустить категорию:

JLog::addLogger(
array(
// Sets file name
'text_file' => 'com_helloworld.critical_emergency.php',
// Sets the format of each line
'text_entry_format' => '{DATETIME} {PRIORITY} {MESSAGE}'
),
// Sets all but DEBUG log level messages to be sent to the file
JLog::ALL & ~JLog::DEBUG,
// The log category which should be recorded in this file
array('com_helloworld')
);

Помимо заполнителей (placeholder), показанных выше в строке по умолчанию, доступны следующие значения:

{CLIENTIP} (this is the IP address of the client)
{TIME}
{DATE}

Существует дополнительный необязательный логический параметр <tt>text_file_no_php</tt>, который указывает, следует ли добавлять в файл логов обычный префикс:

#
#<?php die('Forbidden.');?>

'''Примечание:''' Обычно вам не следует устанавливать для этого параметра значение <tt>false</tt>. Файлы логов не должны быть доступны для чтения извне, поскольку они могут предоставить злоумышленникам ценную информацию о вашей системе.
Изменяйте этот параметр, только если вы знаете, что делаете!

Кроме того, если вы хотите сохранить файл логов где-то еще, а не по пути, указанному в общих настройках Joomla, вы можете изменить параметр <tt>text_file_path</tt>.

== Логирование в другие места ==

Помимо логирования в файлы, вы также можете логировать в другие места, такие как
* область сообщений Joomla (сообщение отображается, если вы вызываете <tt>JFactory::getApplication()->enqueueMessage()</tt>)
* таблица базы данных
* просто echo
Из них, пожалуй, наиболее полезным является логирование в панель сообщений, которое можно настроить следующим образом:
JLog::addLogger(array('logger' => 'messagequeue'), JLog::ALL, array('msg-error-cat'));
Затем, когда вы делаете:
JLog::add('сообщение об ошибке для отображения', JLog::ERROR, 'msg-error-cat');
вы получаете сообщение, скопированное на панель сообщений.

'''Note that Joomla core code sets up logging to the messagequeue for category 'jerror', so that if you use this category in your log messages, you will get the message displayed on the message bar.''' Eg
JLog::add('error copied to message bar', JLog::Error, 'jerror');
will result in the message being shown in the Joomla message area, even though you haven't explicitly set up a logger to log there.

== Исключения ==

<code>JLog::add()</code> кидает исключение, если не может записать в файл логов. Чтобы избежать этого, вам придется либо обернуть вызов в другую функцию, либо реализовать свой собственный класс логгера, а затем включить его в:

JLog::addLogger(
array(
// Use mycustomlogger
'logger' => 'mycustomlogger',
'text_file' => 'com_helloworld.errors.php'
),
JLog::ALL,
array('com_helloworld')
);

== Что ещё почитать ==
Логирование в Joomla должно использоваться в тандеме с исключениями PHP, а не в качестве замены. Подробнее в [[S:MyLanguage/Exceptions and Logging in Joomla 1.7 and Joomla Platform 11.1|Exceptions and Logging in Joomla 1.7 and Joomla Platform 11.1]].

Another tutorial (a little out of date, but still useful) is at [http://eddify.me/posts/logging-in-joomla-with-jlog.html logging in joomla with jlog].

<noinclude>
[[Category:Development{{#translation:}}]]
[[category:Joomla! 1.7{{#translation:}}]]
[[category:Joomla! 2.5{{#translation:}}]]
[[category:Joomla! 3.0{{#translation:}}]]
[[category:Joomla! 3.x{{#translation:}}]]
</noinclude>

Translations:Using JLog/51/ru

2019-01-16T08:15:37Z

Логирование в Joomla должно использоваться в тандеме с исключениями PHP, а не в качестве замены. Подробнее в [[S:MyLanguage/Exceptions and Logging in Joomla 1.7 and Joomla Platform 11.1|Exceptions and Logging in Joomla 1.7 and Joomla Platform 11.1]].