Monday, 24 November 2014

PHP regular expressions

PHP regular expressions seems to be a quite complicated area especially if you are not an experienced Unix user. Historically regular expressions were originally designed to help working with strings under Unix systems.
Using regular expressions you can easy find a pattern in a string and/or replace it if you want. This is a very powerful tool in your hand, but be careful as it is slower than the standard string manipulation functions. 
Regular expression types 
There are 2 types of  regular expressions:
  • POSIX Extended
  • Perl Compatible
The ereg, eregi, ... are the POSIX versions and preg_match, preg_replace, ... are the Perl version. It is important that using Perl compatible regular expressions the expression should be enclosed in the delimiters, a forward slash (/), for example. However this version is more powerful and faster as well than the POSIX one.
The regular expressions basic syntax
To use regular expressions first you need to learn the syntax of the patterns. We can group the characters inside a pattern like this:
  • Normal characters which match themselves like hello
  • Start and end indicators as ^ and $
  • Count indicators like +,*,?
  • Logical operator like |
  • Grouping with {},(),[]
An example pattern to check valid emails looks like this:
Code:
^[a-zA-Z0-9._-]+@[a-zA-Z0-9-]+\.[a-zA-Z.]{2,5}$
The code to check the email using Perl compatible regular expression looks like this:
Code:
  1. $pattern = "/^[a-zA-Z0-9._-]+@[a-zA-Z0-9-]+\.[a-zA-Z.]{2,5}$/";
  2. $email = "jim@demo.com";
  3.  
  4. if (preg_match($pattern,$email)) echo "Match";
  5. else echo "Not match";
And very similar in case of POSIX extended regular expressions:
Code:
  1. $pattern = "^[a-zA-Z0-9._-]+@[a-zA-Z0-9-]+\.[a-zA-Z.]{2,5}$";
  2. $email = "jim@demo.com";
  3.  
  4. if (eregi($pattern,$email)) echo "Match";
  5. else echo "Not match";

Now let's see a detailed pattern syntax reference:
Regular expression (pattern)
Match (subject)
Not match (subject)
Comment
worldHello worldHello JimMatch if the pattern is present anywhere in the subject
^worldworld classHello worldMatch if the pattern is present at the beginning of the subject
world$Hello worldworld classMatch if the pattern is present at the end of the subject
world/iThis WoRLdHello JimMakes a search in case insensitive mode
^world$worldHello worldThe string contains only the "world"
world*worl, world, worldddworThere is 0 or more "d" after "worl"
world+world, worldddworlThere is at least 1 "d" after "worl"
world?worl, world, worlywor, woryThere is 0 or 1 "d" after "worl"
world{1}worldworlyThere is 1 "d" after "worl"
world{1,}world, worldddworlyThere is 1 ore more "d" after "worl"
world{2,3}worldd, worldddworldThere are 2 or 3 "d" after "worl"
wo(rld)*wo, world, worldoldwaThere is 0 or more "rld" after "wo"
earth|worldearth, worldsunThe string contains the "earth" or the "world"
w.rldworld, wwrldwrldAny character in place of the dot.
^.{5}$world, earthsunA string with exactly 5 characters
[abc]abc, bbacccsunThere is an "a" or "b" or "c" in the string
[a-z]worldWORLDThere are any lowercase letter in the string
[a-zA-Z]world, WORLD, Worl12123There are any lower- or uppercase letter in the string
[^wW]earthw, WThe actual character can not be a "w" or "W"


 Complex regular expression examples


PHP regular expression tutorial
Now as you know the theory and basic syntax of PHP regular expressions it's time to create and analyze some more complex cases.
User name check with regular expression
First start with a user name check. In case of a registration form you may want to control available user names a bit. Let's suppose you don't want to allow any special character in the name except "_.-" and of course letters and numbers. Besides this you may want to control the length of the user name to be between 4 and 20.
First we need to define the available characters. This can be realised with the following code:
[a-zA-Z0-9_.-] 
After that we need to limit the number of characters with the following code:
{4,20}
At least we need to put it together:
^[a-zA-Z-0-9_.-]{4,20}$ 
In case of Perl compatible regular expression surround it with '/'. At the end the PHP code looks like this:
Code:
  1. $pattern = '/^[a-zA-Z0-9_.-]{4,20}$/';
  2. $username = "this.is.a-demo_-";
  3.  
  4. if (preg_match($pattern,$username)) echo "Match";
  5. else echo "Not match";

Check hexadecimal color codes with regular expression
A hexadecimal color code looks like this: #5A332C or you can use a short form like #C5F. In both case it starts with a # and follows with exactly 3 or 6 numbers or letters from a-f.
So the first it starts as:
^#
the following character range is:
[a-fA-F0-9]
and the length can be 3 or 6. The complete pattern is the following:
^#(([a-fA-F0-9]{3}$)|([a-fA-F0-9]{6}$))
Here we use an or statement first check the #123 form and then the #123456 form. At the end the PHP code looks like this:
Code:
  1. $pattern = '/^#(([a-fA-F0-9]{3}$)|([a-fA-F0-9]{6}$))/';
  2. $color = "#1AA";
  3.  
  4. if (preg_match($pattern,$color)) echo "Match";
  5. else echo "Not match";
  6.  

Email check with regular expression 
At least let's see how we can check an email address with regular expressions. First take a careful look at the following example emails:
  • john.demo@demo.com
  • john@demo.us
  • john_123.demo_.name@demo.info
What we can see is that the @ is a mandatory element in an email. Besides this there must be some character before and some after it. More precisely there must be a valid domain name after the @.  
So the first part must be a string with letters a numbers or some special characters like _-. In pattern we can write it as follows:
^[a-zA-Z0-9_.-]+
The domain name always have a let's say name and tld. The tld is the .com, .us. .info and the name can be any string with valid characters. It means that the domain pattern looks like this:
[a-zA-Z0-9-]+\.[a-zA-Z.]{2,4}$
Now we only need to put together the 2 parts with the @ and get the complete pattern:
^[a-zA-Z0-9._-]+@[a-zA-Z0-9-]+\.[a-zA-Z.]{2,5}$
The PHP code looks like this:
Code:
  1. $pattern = '/^[a-zA-Z0-9._-]+@[a-zA-Z0-9-]+\.[a-zA-Z.]{2,5}$/';
  2. $email = "john123.demo_.name@demo.info";
  3.  
  4. if (preg_match($pattern,$email)) echo "Match";
  5. else echo "Not match";

0 comments:

Post a Comment