PHP Classes
elePHPant
Icontem

PHPF: Reformat PHP scripts according to code style

Recommend this page to a friend!
  Info   View files Documentation   View files View files (15)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Last Updated Ratings Unique User Downloads Download Rankings
2017-06-11 (4 months ago) RSS 2.0 feedNot enough user ratingsTotal: 207 All time: 7,955 This week: 584Up
Version License PHP version Categories
phpfmt 19.7.5Custom (specified...5.6PHP 5, Utilities and Tools, Parsers
Collaborate with this project Author

phpF - github.com

Description

This package can reformat PHP scripts according to code style.

It can take a PHP script and reformat it in different coding styles supported by the package.

Currently it can reformat code according to CakePHP style, PSR-1 or PSR-2.

It provides several options that control the format of the output script like:

- Reformat class constructors
- Save script to a file and the original to optional a backup file or just simulate actions
- Ignore names with certain format patterns
- Lint PHP code before reformatting
- Generate getters and setters
- Etc.

Innovation Award
PHP Programming Innovation award nominee
March 2017
Number 10
Many PHP developers are now writing code that follows PSR recommendations from the FIG (Framework Interoperability group), so it becomes easier to collaborate in projects on which all developers follow the same coding standard recommendation.

However, there are many developers that have not converted their code because it takes too much effort to do it manually.

This package can do it automatically for you. It can parse your PHP code and rewrite it to comply either PSR-1 or PSR-2 recommendations.

Manuel Lemos
  Performance   Level  
Name: Subin Siby is available for providing paid consulting. Contact Subin Siby .
Classes: 5 packages by
Country: India India
Age: 17
All time rank: 59533 in India India
Week rank: 86 Up9 in India India Up
Innovation award
Innovation award
Nominee: 2x

Winner: 1x

Details

phpF

Build Status

phpF formats PHP code by making it readable and helps your code to follow coding guidelines.

This is a fork of the project phpfmt.

Requirements

  • PHP 5.6 or newer

Usage

php phpf.phar <arguments>

Arguments

| Argument | Description | | -------- | ----------- | | --cache[=FILENAME] | cache file. Default: .php.tools.cache | | --cakephp | Apply CakePHP coding style | | --config=FILENAME | configuration file. Default: .phpf.ini | | --constructor=type | analyse classes for attributes and generate constructor - camel, snake, golang | | --dry-run | Runs the formatter without atually changing files; returns exit code 1 if changes would have been applied | | --enable_auto_align | disable auto align of ST_EQUAL and T_DOUBLE_ARROW | | --exclude=pass1,passN,... | disable specific passes | | --help-pass | show specific information for one pass | | --ignore=PATTERN-1,PATTERN-N,... | ignore file names whose names contain any PATTERN-N | | --indent_with_space=SIZE | use spaces instead of tabs for indentation. Default 4 | | --lint-before | lint files before pretty printing (PHP must be declared in %PATH%/$PATH) | | --list | list possible transformations | | --list-simple | list possible transformations - greppable | | --no-backup | no backup file (original.php~) | | --passes=pass1,passN,... | call specific compiler pass | | --profile=NAME | use one of profiles present in configuration file | | --psr | activate PSR1 and PSR2 styles | | --psr1 | activate PSR1 style | | --psr1-naming | activate PSR1 style - Section 3 and 4.3 - Class and method names case. | | --psr2 | activate PSR2 style | | --setters_and_getters=type | analyse classes for attributes and generate setters and getters - camel, snake, golang | | --smart_linebreak_after_curly | convert multistatement blocks into multiline blocks | | --visibility_order | fixes visibiliy order for method in classes - PSR-2 4.2 | | --yoda | yoda-style comparisons | | -h, --help | this help message | | -o=- | output the formatted code to standard output | | -o=file | output the formatted code to "file" | | -v | verbose |

Currently Supported Transformations:

* AddMissingParentheses Add extra parentheses in new instantiations. * AliasToMaster Replace function aliases to their masters - only basic syntax alias. * AlignConstVisibilityEquals Vertically align "=" of visibility and const blocks. * AlignDoubleArrow Vertically align T_DOUBLE_ARROW (=>). * AlignDoubleSlashComments Vertically align "//" comments. * AlignEquals Vertically align "=". * AlignGroupDoubleArrow Vertically align T_DOUBLE_ARROW (=>) by line groups. * AlignPHPCode Align PHP code within HTML block. * AlignPHPCode2 Align PHP code within opening and closing php block. * AlignTypehint Vertically align function type hints. * AllmanStyleBraces Transform all curly braces into Allman-style. * AutoPreincrement Automatically convert postincrement to preincrement. * AutoSemicolon Add semicolons in statements ends. * CakePHPStyle Applies CakePHP Coding Style * ClassToSelf "self" is preferred within class, trait or interface. * ClassToStatic "static" is preferred within class, trait or interface. * ConvertOpenTagWithEcho Convert from "<?=" to "<?php echo ". * DocBlockToComment Replace docblocks with regular comments when used in non structural elements. * DoubleToSingleQuote Convert from double to single quotes. * EchoToPrint Convert from T_ECHO to print. * EncapsulateNamespaces Encapsulate namespaces with curly braces * GeneratePHPDoc Automatically generates PHPDoc blocks * IndentTernaryConditions Applies indentation to ternary conditions. * JoinToImplode Replace implode() alias (join() -> implode()). * LeftWordWrap Word wrap at 80 columns - left justify. * LongArray Convert short to long arrays. * MergeElseIf Merge if with else. * SplitElseIf Merge if with else. * MergeNamespaceWithOpenTag Ensure there is no more than one linebreak before namespace * MildAutoPreincrement Automatically convert postincrement to preincrement. (Deprecated pass. Use AutoPreincrement instead). * NewLineBeforeReturn Add an empty line before T_RETURN. * OrganizeClass Organize class, interface and trait structure. * OrderAndRemoveUseClauses Order use block and remove unused imports. * OnlyOrderUseClauses Order use block - do not remove unused imports. * OrderMethod Organize class, interface and trait structure. * OrderMethodAndVisibility Organize class, interface and trait structure. * PHPDocTypesToFunctionTypehint Read variable types from PHPDoc blocks and add them in function signatures. * PrettyPrintDocBlocks Prettify Doc Blocks * PSR2EmptyFunction Merges in the same line of function header the body of empty functions. * PSR2MultilineFunctionParams Break function parameters into multiple lines. * ReindentAndAlignObjOps Align object operators. * ReindentSwitchBlocks Reindent one level deeper the content of switch blocks. * RemoveIncludeParentheses Remove parentheses from include declarations. * RemoveSemicolonAfterCurly Remove semicolon after closing curly brace. * RemoveUseLeadingSlash Remove leading slash in T_USE imports. * ReplaceBooleanAndOr Convert from "and"/"or" to "&&"/"||". Danger! This pass leads to behavior change. * ReplaceIsNull Replace is_null($a) with null === $a. * RestoreComments Revert any formatting of comments content. * ReturnNull Simplify empty returns. * ShortArray Convert old array into new array. (array() -> []) * SmartLnAfterCurlyOpen Add line break when implicit curly block is added. * SortUseNameSpace Organize use clauses by length and alphabetic order. * SpaceAroundControlStructures Add space around control structures. * SpaceAroundExclamationMark Add spaces around exclamation mark. * SpaceAroundParentheses Add spaces inside parentheses. * SpaceBetweenMethods Put space between methods. * StrictBehavior Activate strict option in array_search, base64_decode, in_array, array_keys, mb_detect_encoding. Danger! This pass leads to behavior change. * StrictComparison All comparisons are converted to strict. Danger! This pass leads to behavior change. * StripExtraCommaInArray Remove trailing commas within array blocks * StripNewlineAfterClassOpen Strip empty lines after class opening curly brace. * StripNewlineAfterCurlyOpen Strip empty lines after opening curly brace. * StripNewlineWithinClassBody Strip empty lines after class opening curly brace. * StripSpaces Remove all empty spaces * StripSpaceWithinControlStructures Strip empty lines within control structures. * TightConcat Ensure string concatenation does not have spaces, except when close to numbers. * TrimSpaceBeforeSemicolon Remove empty lines before semi-colon. UpgradeToPreg Upgrade ereg_ calls to preg_* * WordWrap Word wrap at 80 columns. * WrongConstructorName Update old constructor names into new ones. http://php.net/manual/en/language.oop5.decon.php * YodaComparisons Execute Yoda Comparisons.

  Files folder image Files  
File Role Description
Files folder imagesrc (1 file)
Files folder imagetesting (1 file, 1 directory)
Accessible without login Plain text file .travis.yml Data Auxiliary data
Accessible without login Plain text file build.php Example Example script
Accessible without login Plain text file CHANGELOG.md Data Auxiliary data
Accessible without login Plain text file LICENSE Lic. License text
Accessible without login Plain text file README.md Doc. Documentation
Accessible without login Plain text file README.src.md Doc. Documentation

  Files folder image Files  /  src  
File Role Description
  Plain text file phpf.php Class Class source

  Files folder image Files  /  testing  
File Role Description
Files folder imagetests (7 files)
  Accessible without login Plain text file phpunit.xml Data Auxiliary data

  Files folder image Files  /  testing  /  tests  
File Role Description
  Accessible without login Plain text file bootstrap.php Aux. Auxiliary script
  Accessible without login Plain text file TestAlignPHPCode.php Test Unit test script
  Accessible without login Plain text file TestAlignPHPCode2.php Test Unit test script
  Accessible without login Plain text file TestRemoveIncludeParentheses.php Test Unit test script
  Plain text file TestSpaceAroundControlStructures.php Class Class source
  Accessible without login Plain text file TestSpaceAroundExclamationMark.php Test Unit test script
  Accessible without login Plain text file TestSpaceAroundParentheses.php Test Unit test script

 Version Control Unique User Downloads Download Rankings  
 100%
Total:207
This week:0
All time:7,955
This week:584Up