.vim/bundle/ale/doc/ale-php.txt

   1 ===============================================================================
   2 ALE PHP Integration                                           *ale-php-options*
   3
   4
   5 ===============================================================================
   6 cspell                                                         *ale-php-cspell*
   7
   8 See |ale-cspell-options|
   9
  10
  11 ===============================================================================
  12 langserver                                                 *ale-php-langserver*
  13
  14                                         *ale-options.php_langserver_executable*
  15                                               *g:ale_php_langserver_executable*
  16                                               *b:ale_php_langserver_executable*
  17 php_langserver_executable
  18 g:ale_php_langserver_executable
  19   Type: |String|
  20   Default: `'php-language-server.php'`
  21
  22   The variable can be set to configure the executable that will be used for
  23   running the PHP language server. `vendor` directory executables will be
  24   preferred instead of this setting if |g:ale_php_langserver_use_global| is `0`.
  25
  26   See: |ale-integrations-local-executables|
  27
  28                                         *ale-options.php_langserver_use_global*
  29                                               *g:ale_php_langserver_use_global*
  30                                               *b:ale_php_langserver_use_global*
  31 php_langserver_use_global
  32 g:ale_php_langserver_use_global
  33   Type: |Number|
  34   Default: `get(g:, 'ale_use_global_executables', 0)`
  35
  36   This variable can be set to `1` to force the language server to be run with
  37   the executable set for |g:ale_php_langserver_executable|.
  38
  39   See: |ale-integrations-local-executables|
  40
  41
  42 ===============================================================================
  43 phan                                                             *ale-php-phan*
  44
  45 WARNING: please use the phan_client linter if you have an configuration file
  46 for your project because the phan will look into your entirely project and
  47 ale will display in the current buffer warnings that may belong to other file.
  48
  49                                         *ale-options.php_phan_minimum_severity*
  50                                               *g:ale_php_phan_minimum_severity*
  51                                               *b:ale_php_phan_minimum_severity*
  52 php_phan_minimum_severity
  53 g:ale_php_phan_minimum_severity
  54   Type: |Number|
  55   Default: `0`
  56
  57   This variable defines the minimum severity level.
  58
  59                                               *ale-options.php_phan_executable*
  60                                                     *g:ale_php_phan_executable*
  61                                                     *b:ale_php_phan_executable*
  62 php_phan_executable
  63 g:ale_php_phan_executable
  64   Type: |String|
  65   Default: `'phan'`
  66
  67   This variable sets executable used for phan or phan_client.
  68
  69                                               *ale-options.php_phan_use_client*
  70                                                     *g:ale_php_phan_use_client*
  71                                                     *b:ale_php_phan_use_client*
  72 php_phan_use_client
  73 g:ale_php_phan_use_client
  74   Type: |Number|
  75   Default: `get(g:, 'ale_php_phan_use_client', 0)`
  76
  77   This variable can be set to 1 to use the phan_client with phan daemon mode
  78   instead of the phan standalone.
  79
  80
  81 ===============================================================================
  82 phpcbf                                                         *ale-php-phpcbf*
  83
  84                                             *ale-options.php_phpcbf_executable*
  85                                                   *g:ale_php_phpcbf_executable*
  86                                                   *b:ale_php_phpcbf_executable*
  87 php_phpcbf_executable
  88 g:ale_php_phpcbf_executable
  89   Type: |String|
  90   Default: `'phpcbf'`
  91
  92   See |ale-integrations-local-executables|
  93
  94                                               *ale-options.php_phpcbf_standard*
  95                                                     *g:ale_php_phpcbf_standard*
  96                                                     *b:ale_php_phpcbf_standard*
  97 php_phpcbf_standard
  98 g:ale_php_phpcbf_standard
  99   Type: |String|
 100   Default: `''`
 101
 102   This variable can be set to specify the coding standard used by phpcbf. If no
 103   coding standard is specified, phpcbf will default to fixing against the
 104   PEAR coding standard, or the standard you have set as the default.
 105
 106                                             *ale-options.php_phpcbf_use_global*
 107                                                   *g:ale_php_phpcbf_use_global*
 108                                                   *b:ale_php_phpcbf_use_global*
 109 php_phpcbf_use_global
 110 g:ale_php_phpcbf_use_global
 111   Type: |Number|
 112   Default: `get(g:, 'ale_use_global_executables', 0)`
 113
 114   See |ale-integrations-local-executables|
 115
 116                                                *ale-options.php_phpcbf_options*
 117                                                      *g:ale_php_phpcbf_options*
 118                                                       *b:ale_php_phpcbf_options*
 119 php_phpcbf_options
 120 g:ale_php_phpcbf_options
 121   Type: |String|
 122   Default: `''`
 123
 124   This variable can be set to pass additional options to php-cbf
 125
 126
 127 ===============================================================================
 128 phpcs                                                           *ale-php-phpcs*
 129
 130                                              *ale-options.php_phpcs_executable*
 131                                                    *g:ale_php_phpcs_executable*
 132                                                    *b:ale_php_phpcs_executable*
 133 php_phpcs_executable
 134 g:ale_php_phpcs_executable
 135   Type: |String|
 136   Default: `'phpcs'`
 137
 138   See |ale-integrations-local-executables|
 139
 140                                                *ale-options.php_phpcs_standard*
 141                                                      *g:ale_php_phpcs_standard*
 142                                                      *b:ale_php_phpcs_standard*
 143 php_phpcs_standard
 144 g:ale_php_phpcs_standard
 145   Type: |String|
 146   Default: `''`
 147
 148   This variable can be set to specify the coding standard used by phpcs. If no
 149   coding standard is specified, phpcs will default to checking against the
 150   PEAR coding standard, or the standard you have set as the default.
 151
 152                                              *ale-options.php_phpcs_use_global*
 153                                                    *g:ale_php_phpcs_use_global*
 154                                                    *b:ale_php_phpcs_use_global*
 155 php_phpcs_use_global
 156 g:ale_php_phpcs_use_global
 157   Type: |Number|
 158   Default: `get(g:, 'ale_use_global_executables', 0)`
 159
 160   See |ale-integrations-local-executables|
 161
 162                                                 *ale-options.php_phpcs_options*
 163                                                       *g:ale_php_phpcs_options*
 164                                                       *b:ale_php_phpcs_options*
 165 php_phpcs_options
 166 g:ale_php_phpcs_options
 167   Type: |String|
 168   Default: `''`
 169
 170   This variable can be set to pass additional options to php-cs
 171
 172
 173 ===============================================================================
 174 phpmd                                                           *ale-php-phpmd*
 175
 176                                              *ale-options.php_phpmd_executable*
 177                                                    *g:ale_php_phpmd_executable*
 178                                                    *b:ale_php_phpmd_executable*
 179 php_phpmd_executable
 180 g:ale_php_phpmd_executable
 181   Type: |String|
 182   Default: `'phpmd'`
 183
 184   This variable sets executable used for phpmd.
 185
 186                                                 *ale-options.php_phpmd_ruleset*
 187                                                       *g:ale_php_phpmd_ruleset*
 188                                                       *b:ale_php_phpmd_ruleset*
 189 php_phpmd_ruleset
 190 g:ale_php_phpmd_ruleset
 191   Type: |String|
 192   Default: `'cleancode,codesize,controversial,design,naming,unusedcode'`
 193
 194   This variable controls the ruleset used by phpmd. Default is to use all of
 195   the available phpmd rulesets
 196
 197
 198 ===============================================================================
 199 phpstan                                                       *ale-php-phpstan*
 200
 201                                            *ale-options.php_phpstan_executable*
 202                                                  *g:ale_php_phpstan_executable*
 203                                                  *b:ale_php_phpstan_executable*
 204 php_phpstan_executable
 205 g:ale_php_phpstan_executable
 206   Type: |String|
 207   Default: `'phpstan'`
 208
 209   This variable sets executable used for phpstan.
 210
 211                                                 *ale-options.php_phpstan_level*
 212                                                       *g:ale_php_phpstan_level*
 213                                                       *b:ale_php_phpstan_level*
 214 php_phpstan_level
 215 g:ale_php_phpstan_level
 216   Type: |String|
 217   Default: `''`
 218
 219   This variable controls the rule levels. 0 is the loosest and 7 is the
 220   strictest. If this option isn't set, the rule level will be controlled by
 221   the configuration file. If no configuration file can be detected, `'7'` will
 222   be used instead.
 223
 224                                         *ale-options.php_phpstan_configuration*
 225                                               *g:ale_php_phpstan_configuration*
 226                                               *b:ale_php_phpstan_configuration*
 227 php_phpstan_configuration
 228 g:ale_php_phpstan_configuration
 229   Type: |String|
 230   Default: `''`
 231
 232   This variable sets path to phpstan configuration file.
 233
 234                                              *ale-options.php_phpstan_autoload*
 235                                                    *g:ale_php_phpstan_autoload*
 236                                                    *b:ale_php_phpstan_autoload*
 237 php_phpstan_autoload
 238 g:ale_php_phpstan_autoload
 239   Type: |String|
 240   Default: `''`
 241
 242   This variable sets path to phpstan autoload file.
 243
 244                                          *ale-options.php_phpstan_memory_limit*
 245                                                *g:ale_php_phpstan_memory_limit*
 246                                                *b:ale_php_phpstan_memory-limit*
 247 php_phpstan_memory_limit
 248 g:ale_php_phpstan_memory_limit
 249   Type: |String|
 250   Default: `''`
 251
 252   This variable sets the memory limit for phpstan analysis. This is a string
 253   in the same format as `php.ini` accepts, e.g. `128M`, `1G`.
 254
 255
 256 ===============================================================================
 257 psalm                                                           *ale-php-psalm*
 258
 259                                              *ale-options.php_psalm_executable*
 260                                                    *g:ale_php_psalm_executable*
 261                                                    *b:ale_php_psalm_executable*
 262 php_psalm_executable
 263 g:ale_php_psalm_executable
 264   Type: |String|
 265   Default: `'psalm'`
 266
 267   This variable sets the executable used for psalm.
 268
 269                                                 *ale-options.php_psalm_options*
 270                                                       *g:ale_php_psalm_options*
 271                                                       *b:ale_php_psalm_options*
 272 php_psalm_options
 273 g:ale_php_psalm_options
 274   Type: |String|
 275   Default: `''`
 276
 277   This variable can be set to pass additional options to psalm.
 278
 279                                              *ale-options.php_psalm_use_global*
 280                                                    *g:ale_php_psalm_use_global*
 281                                                    *b:ale_php_psalm_use_global*
 282 php_psalm_use_global
 283 g:ale_php_psalm_use_global
 284   Type: |Boolean|
 285   Default: `get(g:, 'ale_use_global_executables', 0)`
 286
 287   See |ale-integrations-local-executables|
 288
 289
 290 ===============================================================================
 291 php-cs-fixer                                             *ale-php-php-cs-fixer*
 292
 293                                           *ale-options.php_cs_fixer_executable*
 294                                                 *g:ale_php_cs_fixer_executable*
 295                                                 *b:ale_php_cs_fixer_executable*
 296 php_cs_fixer_executable
 297 g:ale_php_cs_fixer_executable
 298   Type: |String|
 299   Default: `'php-cs-fixer'`
 300
 301   This variable sets executable used for php-cs-fixer.
 302
 303                                              *ale-options.php_cs_fixer_options*
 304                                                    *g:ale_php_cs_fixer_options*
 305                                                    *b:ale_php_cs_fixer_options*
 306 php_cs_fixer_options
 307 g:ale_php_cs_fixer_options
 308   Type: |String|
 309   Default: `''`
 310
 311   This variable can be set to pass additional options to php-cs-fixer.
 312
 313                                           *ale-options.php_cs_fixer_use_global*
 314                                                 *g:ale_php_cs_fixer_use_global*
 315                                                 *b:ale_php_cs_fixer_use_global*
 316 php_cs_fixer_use_global
 317 g:ale_php_cs_fixer_use_global
 318   Type: |Boolean|
 319   Default: `get(g:, 'ale_use_global_executables', 0)`
 320
 321   See |ale-integrations-local-executables|
 322
 323
 324 ===============================================================================
 325 php                                                               *ale-php-php*
 326
 327                                                *ale-options.php_php_executable*
 328                                                      *g:ale_php_php_executable*
 329                                                      *b:ale_php_php_executable*
 330 php_php_executable
 331 g:ale_php_php_executable
 332   Type: |String|
 333   Default: `'php'`
 334
 335   This variable sets the executable used for php.
 336
 337
 338 ===============================================================================
 339 pint                                                             *ale-php-pint*
 340
 341                                               *ale-options.php_pint_executable*
 342                                                     *g:ale_php_pint_executable*
 343                                                     *b:ale_php_pint_executable*
 344 php_pint_executable
 345 g:ale_php_pint_executable
 346   Type: |String|
 347   Default: `'pint'`
 348
 349   This variable sets the executable used for pint.
 350
 351                                                  *ale-options.php_pint_options*
 352                                                        *g:ale_php_pint_options*
 353                                                        *b:ale_php_pint_options*
 354 php_pint_options
 355 g:ale_php_pint_options
 356   Type: |String|
 357   Default: `''`
 358
 359   This variable can be set to pass additional options to pint.
 360
 361                                               *ale-options.php_pint_use_global*
 362                                                     *g:ale_php_pint_use_global*
 363                                                     *b:ale_php_pint_use_global*
 364 php_pint_use_global
 365 g:ale_php_pint_use_global
 366   Type: |Boolean|
 367   Default: `get(g:, 'ale_use_global_executables', 0)`
 368
 369   See |ale-integrations-local-executables|
 370
 371
 372 ===============================================================================
 373 tlint                                                           *ale-php-tlint*
 374
 375                                              *ale-options.php_tlint_executable*
 376                                                    *g:ale_php_tlint_executable*
 377                                                    *b:ale_php_tlint_executable*
 378 php_tlint_executable
 379 g:ale_php_tlint_executable
 380   Type: |String|
 381   Default: `'tlint'`
 382
 383   See |ale-integrations-local-executables|
 384
 385                                              *ale-options.php_tlint_use_global*
 386                                                    *g:ale_php_tlint_use_global*
 387                                                    *b:ale_php_tlint_use_global*
 388 php_tlint_use_global
 389 g:ale_php_tlint_use_global
 390   Type: |Number|
 391   Default: `get(g:, 'ale_use_global_executables', 0)`
 392
 393   See |ale-integrations-local-executables|
 394
 395                                                 *ale-options.php_tlint_options*
 396                                                       *g:ale_php_tlint_options*
 397                                                       *b:ale_php_tlint_options*
 398 php_tlint_options
 399 g:ale_php_tlint_options
 400   Type: |String|
 401   Default: `''`
 402
 403   This variable can be set to pass additional options to tlint
 404
 405
 406 ===============================================================================
 407 intelephense                                             *ale-php-intelephense*
 408
 409                                       *ale-options.php_intelephense_executable*
 410                                             *g:ale_php_intelephense_executable*
 411                                             *b:ale_php_intelephense_executable*
 412 php_intelephense_executable
 413 g:ale_php_intelephense_executable
 414   Type: |String|
 415   Default: `'intelephense'`
 416
 417   The variable can be set to configure the executable that will be used for
 418   running the intelephense language server. `node_modules` directory
 419   executable will be preferred instead of this setting if
 420   |g:ale_php_intelephense_use_global| is `0`.
 421
 422   See: |ale-integrations-local-executables|
 423
 424                                       *ale-options.php_intelephense_use_global*
 425                                             *g:ale_php_intelephense_use_global*
 426                                             *b:ale_php_intelephense_use_global*
 427 php_intelephense_use_global
 428 g:ale_php_intelephense_use_global
 429   Type: |Number|
 430   Default: `get(g:, 'ale_use_global_executables', 0)`
 431
 432   This variable can be set to `1` to force the language server to be run with
 433   the executable set for |g:ale_php_intelephense_executable|.
 434
 435   See: |ale-integrations-local-executables|
 436
 437                                           *ale-options.php_intelephense_config*
 438                                                 *g:ale_php_intelephense_config*
 439                                                 *b:ale_php_intelephense_config*
 440 php_intelephense_config
 441 g:ale_php_intelephense_config
 442   Type: |Dictionary|
 443   Default: `{}`
 444
 445   The initialization options config specified by Intelephense. Refer to the
 446   installation docs provided by intelephense (github.com/bmewburn/intelephense
 447   -docs).
 448
 449
 450 ===============================================================================
 451   vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: