Example analysis of PHP code and file naming conventions

Naming convention

During the development process, you should try to follow the following naming convention:

• Class files are all suffixed with .class.php (here refers to The class library file used internally by ThinkPHP does not represent the class library file loaded externally), use camel case naming, and the first letter is capitalized, such as DbMysql.class.php;

• The namespace address of the class is consistent with the path address where it is located. For example, Home\Controller\UserControllerThe path where the class is located should be Application/ Home/Controller/UserController.class.php；

• Ensure that the file naming and calling case are consistent, because on Unix-like systems, the Case is sensitive (ThinkPHP, in debug mode, will strictly check case even on the Windows platform);

• The class name and the file name are consistent (including the case mentioned above) ), for example, the file name of the UserController class is UserController.class.php, the file name of the InfoModel class is InfoModel.class.php, and are different There are certain standards for class naming in class libraries;

• functions, configuration files and other class library files are generally named .php Suffix (not required if introduced by a third party);

• Use lowercase letters and underscores when naming functions, such as get_client_ip;

• Methods are named using camel case, and the first letter is lowercase or the underscore "_" is used, such as getUserName, _parseType, usually Methods starting with an underscore are private methods;

• attributes are named using camel case, and the first letter is lowercase or an underscore "_" is used, such as tableName, _instance, usually attributes starting with an underscore are private attributes;

• Functions or methods starting with a double underscore "__" are used as magic methods. For example __call and __autoload;

• ##constants are in uppercase letters Letters and underscores are used in naming, such as

  HAS_ONE and MANY_TO_MANY;

• Configuration parameters are in uppercase letters Named with letters and underscores, for example

  HTML_CACHE_ON;

• Language variables are named with uppercase letters and underscores, for example

  MY_LANG, language variables starting with an underscore Usually used for system language variables, such as _CLASS_NOT_EXIST_;

• There is no mandatory specification for the naming of variables, and it can be done according to team specifications;

• ThinkPHP’s template file defaults to

  .html as the suffix (can be modified through configuration);

• Data tables and fields are named in lowercase and underlined, and note that field names do not start with an underscore, such as

  think_user table and user_name The fields are written correctly. Data table fields like _username may be filtered.

Process Statement Specification

The curly braces of all process statements occupy a separate line. Reason: If you encounter more complex business logic, there will be a lot of nesting of curly braces, so we will confuse the corresponding curly braces!

1. Branch statement

if($age >= 18 && $age <= 30) 
{
  echo &#39;young man&#39;;
}
else if($age > 30 && $age <= 60)
{
  echo &#39;middle aged&#39;;
}
else
{
  echo &#39;old man&#39;;
}
 
//下面这段代码高手我们一个问题，在if语句中，即使在可以不要花括号的情况下，花括号也是要写上的
if($age > 60)
{
  echo &#39;I am very old&#39;;
}
 
switch($status)
{
  case &#39;forbiden&#39;：
    echo &#39;login forbidden&#39;;
    break;
     
  case &#39;normal&#39;:
    echo &#39;login in&#39;;
    break;
     
  default:
    echo &#39;status is wrong&#39; ：
    break;
}

2. Loop statement

while($condition)
{
  statesments......;
}
 
foreach($arrayList as $arrayKey => $arrayItem)
{
  states......;
}
do
{
  statements......; 
}
while($condition)
 
 
for($start; condition; changenumber)
{
  statements......;
}

General rules must be followed

During the development process, following the following rules will make your development easier:

• Follow the naming convention and directory convention of the framework;

• During the development process, try to turn on the debugging mode to detect problems early;

• Develop a good habit of using the I function to obtain input variables;

• The first problem encountered after updating or changing the environment is to clear the Runtime directory;

The above is the detailed content of Example analysis of PHP code and file naming conventions. For more information, please follow other related articles on the PHP Chinese website!