no_useless_sprintf.rst 1.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. ===========================
  2. Rule ``no_useless_sprintf``
  3. ===========================
  4. There must be no ``sprintf`` calls with only the first argument.
  5. Warning
  6. -------
  7. Using this rule is risky
  8. ~~~~~~~~~~~~~~~~~~~~~~~~
  9. Risky when if the ``sprintf`` function is overridden.
  10. Examples
  11. --------
  12. Example #1
  13. ~~~~~~~~~~
  14. .. code-block:: diff
  15. --- Original
  16. +++ New
  17. <?php
  18. -$foo = sprintf('bar');
  19. +$foo = 'bar';
  20. Rule sets
  21. ---------
  22. The rule is part of the following rule sets:
  23. - `@PhpCsFixer:risky <./../../ruleSets/PhpCsFixerRisky.rst>`_
  24. - `@Symfony:risky <./../../ruleSets/SymfonyRisky.rst>`_
  25. References
  26. ----------
  27. - Fixer class: `PhpCsFixer\\Fixer\\FunctionNotation\\NoUselessSprintfFixer <./../../../src/Fixer/FunctionNotation/NoUselessSprintfFixer.php>`_
  28. - Test class: `PhpCsFixer\\Tests\\Fixer\\FunctionNotation\\NoUselessSprintfFixerTest <./../../../tests/Fixer/FunctionNotation/NoUselessSprintfFixerTest.php>`_
  29. The test class defines officially supported behaviour. Each test case is a part of our backward compatibility promise.