Sometimes we try to solve the small problem with our own function instead of a built-in PHP function that provides the functionality.<\/p>\n
Solution:<\/strong> A magic number is a number in code which does not have any explanation and name. For example: in the following code, 10 is a magic number:<\/p>\n In this code, it is not clear why it will execute 10 times.<\/p>\n Solution:<\/strong> Not creating functions is a typical problem for developers mainly for beginners. The problem stems from the fact that a programmer can write multiple lines of PHP scripts without having to encrypt parts of the code into tasks. This is problematic because it is difficult to understand what the code actually does without going deeper into it, and the developer may repeat himself unintentionally.<\/p>\n Solution:<\/strong> If you are writing the same code more than one or two times then there will be something wrong with the code. In this way you are violating the important rule of modern code writing: Do not Repeat Yourself (DRY)<\/strong>. This is important because if the code is finished and one code is written more than one time and after that, if there need to make changes, then you have to make more efforts to make changes in all the places.<\/p>\n Solution:<\/strong> An effective function can do only one job and it can be called from different places in the code because it is ideal and performs a specific functioning for which task it is created. Answer is <\/p>\n string '<p>18001234567<\/p>' (length=18) As we can see, the function validates the phone number and then wraps the result in HTML. This means that we cannot use the function every time we want to check the validity of a phone number because it does not return a boolean (true or false) value, but returns HTML. The effect is serious because we have to repeat ourselves and rewrite the authentication code repeatedly in each application which requires checking the validity of a phone number.<\/p>\n Solution:-<\/strong> Write down the code into a separate function. The first is check validation and the second is wrap in HTML. Many times, the use of nested conditions (like nested if-else condition) makes the code disorganized and difficult to read.<\/p>\n
\nPHP provides many useful functions that remove the need to \u201crefresh the wheel\u201d, and will often complete the work much better than anything typed by a standard program. Therefore, if you are experiencing the need to write complex tasks that you think may already exist, it is best to search the Internet (and PHP scripts in particular) before you start writing your code.<\/p>\nProblem 2: Using Magic Numbers and Strings<\/h3>\n
<?php
\nfor($i=1; $i<10; $i++)\n{\n \/\/code;\n}<\/code><\/p>\n
\nTo make it meaningful and readable we can give the variable with a useful name. For example:
\n<?php
\n$checks=10;
\nfor($i=1; $i<$checks; $i++)\n{\n \/\/your code;\n}<\/code>
\nSimilarly, magic strings are the strings in the code which do not have any explanation. In this case also, it is recommended to set a meaningful name for a variable.<\/p>\nProblem 3: Not creating functions<\/h3>\n
\nDividing the functions into small individual functions is a good solution to this problem.<\/p>\nProblem 4: Code Duplication<\/h3>\n
\nWrap the code in a function is a good way to avoid duplication. Then the function can be called whenever needed.<\/p>\nProblem 5: Functions that do more than one thing<\/h3>\n
\nfunction phone_number($number)
\n{
\n $digits = preg_replace('\/[^0-9]\/','',$number);
\n $len = strlen($digits);
\n $isValidPhoneNumber = ($len >= 7 && $len <= 14); \n if(!$isValidPhoneNumber) $digits = \"Not a phone number\"; \n \/\/ return the phone number wrapped in html\n return \"<p>{$digits}<\/p>\";
\n}
\nvar_dump(phone_number(\"1-800-123-4567\"));
\nvar_dump(phone_number(\"1-800-123-45678910\"));<\/code><\/p>\n
\nstring '<p>Not a phone number<\/p>' (length=25)<\/em><\/p>\n
\nfunction validate_Phone_Number($string)
\n{
\n \/\/replace all the non-digit characters
\n $onlyDigits = preg_replace('\/[^0-9]\/','',$string);
\n \/\/ check if the remaining string is 7-14 characters long and return boolean (true\/false) value
\n $onlyDigitsLen = strlen($onlyDigits);
\n return $isValidPhoneNumber = ($onlyDigitsLen >= 7 && $onlyDigitsLen <= 14);\n} \nfunction wrapInHtml($string)\n{\n \/\/ return the string wrapped in html\n return \"<p>{$string}<\/p>\";
\n}
\n\/\/ check the two functions
\n$string = \"1-800-123-4567\";
\n$isValidPhoneNumber = validate_Phone_Number($string);
\nvar_dump(($isValidPhoneNumber)? wrapInHtml($string) : wrapInHtml(\"Not a valid phone number\"));<\/code><\/p>\nProblem 6: Too many nested conditions<\/h3>\n