Add PHP code beautification tool to EditPlus using PHPCB
PHP code formatting tool that can be integrated in EditPlus or other editors: phpCodeBeautifier, referred to as phpCB.
It can beautify the PHP code format and make the chaotic PHP code neat.
After installing EditPlusr, in the menu bar, there is a menu of [Tools (T)] -> [Configure User Tools]. After opening it, we click [User Tools] ->[Add Tool] -> [Application 】.
The menu text reads: PHP code beautification; command: select the local save address of phpCB.
Write parameters: $(FilePath) or the following content (the command is one line), please refer to the phpCodeBeautifier User Manual for details.
--space-after-if --optimize-eol --space-after-switch --space-after-while --space-before-start-angle-bracket --space-after-end-angle-bracket -- extra-padding-for-case-statement --glue-amperscore --change-shell-comment-to-double-slashes-comment --indent-with-tab --force-large-php-code-tag --force -true-false-null-contant-lowercase --comment-rendering-style PEAR --equal-align-position 50 --padding-char-count 1 "$(FilePath)"
Initial directory filling: $(FileDir)
Finally, pay attention to the selection: "Run text filtering" and select "Replace" in the drop-down box,
In this way, our PHP code beautification tool has been added,
When you need to use it, you only need to select the PHP code beautification tool in the menu bar,
Then the program will automatically organize our messy code, making our code more beautiful and easier to read and analyze.
http://www.waterproof.fr/products/phpCodeBeautifier/manual.php
phpCodeBeautifier User Manual
Options
--space-after-start-bracket: Allow to insert a space after start bracket "(".
With --space-after-start-bracket Without --space-after-start-bracket
if ( $condition) {
}
?>
if ($condition) {
}
?>
--space-before-end-bracket: Allow to insert a space before end bracket ")".
With --space-before-end-bracket Without --space-before-end-bracket
if ($condition ) {
}
?>
if ($condition) {
}
?>
--space-after-if: Allow to insert a space after "if" keyword.
With --space-after-if Without --space-after-if
if ($condition) {
}
?>
if($condition) {
}
?>
--space-after-switch: Allow to insert a space after "switch" keyword.
With --space-after-switch Without --space-after-switch
switch ($condition) {
}
?>
switch($condition) {
}
?>
--space-after-while: Allow to insert a space after "while" keyword.
With --space-after-while Without --space-after-while
while ($condition) {
}
?>
while($condition) {
}
?>
--space-before-start-angle-bracket: Allow to insert a space before starting angle bracket "{".
With --space-before-start-angle-bracket Without --space-before-start-angle-bracket
while($condition) {
}
?>
while($condition){
}
?>
--space-after-end-angle-bracket: Allow to insert a space after starting angle bracket "}".
With --space-after-end-angle-bracket Without --space-after-end-angle-bracket
while($condition){
} // end of while
?>
while($condition){
}//end of while
?>
--extra-padding-for-case-statement: Increase padding before case statements.
With --extra-padding-for-case-statement Without --extra-padding-for-case-statement
switch($condition){
Case 1:
action1();
break;
Case 2:
action2();
break;
Default:
defaultaction();
break;
}
?>
switch($condition){
case 1:
Action1();
Break;
case 2:
Action2();
Break;
default:
defaultaction();
Break;
}
?>
--one-true-brace-function-declaration: Use "One true brace" formating for functions.
With --one-true-brace-function-declaration Without --one-true-brace-function-declaration
function aFunction($param)
{
// function content
}
?>
function aFunction($param) {
// function content
}
?>
--glue-amperscore: Glue "&" to following item.
With --glue-amperscore Without --glue-amperscore
$value = &$objectInstance;
?>
$value = & $objectInstance;
?>
--change-shell-comment-to-double-slashes-comment: Change "# ..." comment into "// ..." comments.
Source With --change-shell-comment-to-double-slashes-comment Without --change-shell-comment-to-double-slashes-comment
#comment content
//another comment
?>
// comment content
// another comment
?>
# comment content
// another comment
?>
--indent-with-tab: If selected, tabulation (ASCII #9) character is used to indent text, elsewhere space (ASCII #32) character is used.
--force-large-php-code-tag: Change "" and "<%" tokens into "" into "?>".
Source With --force-large-php-code-tag Without --force-large-php-code-tag
?>
<%
%>
?>
?>
?>
<%
%>
--force-true-false-null-contant-lowercase: Lowercase for NULL, TRUE and FALSE constants as encouraged in PEAR coding standards.
Source With --force-true-false-null-contant-lowercase Without --force-true-false-null-contant-lowercase
if(TRUE){
if(FALSE){
$value = NULL;
}
}
?>
if(true){
if(false){
$value = null;
}
}
?>
if(TRUE){
if(FALSE){
$value = NULL;
}
}
?>
--align-equal-statements: Align all assignement statements.
Source With --align-equal-statements
$noError = true;
$feildEmpty = false;
$showMessage = false;
$showMessage = false;
$anotherVariable[0123] = 'bla bla bla';
$showBlaBlaBlaMessage = false;
?>
$noError = true;
$feildEmpty = false;
$showMessage = false;
$showMessage = false;
$anotherVariable[0123] = 'bla bla bla';
$showBlaBlaBlaMessage = false;
?>
--align-equal-statements-to-fixed-pos: Align all assignement statements to a fixed position.
Source With --align-equal-statements-to-fixed-pos 30
$noError = true;
$feildEmpty = false;
$showMessage = false;
$showMessage = false;
$anotherVariable[0123] = 'bla bla bla';
$showBlaBlaBlaMessage = false;
?>
$noError = true;
$feildEmpty = false;
$showMessage = false;
$showMessage = false;
$anotherVariable[0123] = 'bla bla bla';
$showBlaBlaBlaMessage = false;
?>
Comment rendering style
The following style of comment formating are available:
--comment-rendering-style PEAR --comment-rendering-style PHPDoc
/**
* bla bla bla
*
* @access public
*/
?>
/**
* bla bla bla
*
* @access public
*/
?>
PEAR Coding standards Tips
To follow PEAR coding standards, I recommend you to use the following configuration:
Option State
--space-after-start-bracket -
--space-before-end-bracket -
--space-after-if X
--space-after-switch X
--space-after-while X
--space-before-start-angle-bracket X
--space-after-end-angle-bracket X
--extra-padding-for-case-statement -
--one-true-brace-function-declaration X
--glue-amperscore X
--change-shell-comment-to-double-slashes-comment X
--indent-with-tab -
--force-large-php-code-tag X
--force-true-false-null-contant-lowercase X
--align-equal-statements X
--align-equal-statements-to-fixed-pos -
Use 4 for the padding character count to use.
Command Line
Command line syntax is the following:
phpCB.exe [options] [srcFile]
Where options is from the previous topic list and srcFile is the file to beautify. If no srcFile is given, standard input will be used. The transformed text will be outputted to standard output, you can redirect it to a file using the > symbol.
Example
This is a sample call of the command line version:
# phpCB --space-after-if
--space-after-switch
--space-after-while
--space-before-start-angle-bracket
--space-after-end-angle-bracket
--one-true-brace-function-declaration
--glue-amperscore
--change-shell-comment-to-double-slashes-comment
--force-large-php-code-tag
--force-true-false-null-contant-lowercase
--align-equal-statements
--comment-rendering-style PEAR
--equal-align-position 50
--padding-char-count 4
c:somepathtofile.php