www.aleph1.co.uk Git - yaffs-website/blob - vendor/egulias/email-validator/README.md

   1 #EmailValidator
   2 [![Build Status](https://travis-ci.org/egulias/EmailValidator.png?branch=master)](https://travis-ci.org/egulias/EmailValidator) [![Coverage Status](https://coveralls.io/repos/egulias/EmailValidator/badge.png?branch=master)](https://coveralls.io/r/egulias/EmailValidator?branch=master) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/egulias/EmailValidator/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/egulias/EmailValidator/?branch=master) [![SensioLabsInsight](https://insight.sensiolabs.com/projects/22ba6692-9c02-42e5-a65d-1c5696bfffc6/small.png)](https://insight.sensiolabs.com/projects/22ba6692-9c02-42e5-a65d-1c5696bfffc6)
   3 =============================
   4 With the help of
   5
   6 ![Powered by PhpStorm](https://www.jetbrains.com/phpstorm/documentation/docs/logo_phpstorm.png)
   7 ##Installation##
   8
   9 Run the command below to install via Composer
  10
  11 ```shell
  12 composer require egulias/email-validator "~1.2"
  13 ```
  14
  15 ##Usage##
  16
  17 Simple example:
  18
  19 ```php
  20 <?php
  21
  22 use Egulias\EmailValidator\EmailValidator;
  23
  24 $validator = new EmailValidator;
  25 if ($validator->isValid($email)) {
  26         echo $email . ' is a valid email address';
  27 }
  28 ```
  29
  30 More advanced example (returns detailed diagnostic error codes):
  31
  32 ```php
  33 <?php
  34
  35 use Egulias\EmailValidator\EmailValidator;
  36
  37 $validator = new EmailValidator;
  38 $email = 'dominic@sayers.cc';
  39 $result = $validator->isValid($email);
  40
  41 if ($result) {
  42         echo $email . ' is a valid email address';
  43 } else if ($validator->hasWarnings()) {
  44         echo 'Warning! ' . $email . ' has unusual/deprecated features (result code ' . var_export($validator->getWarnings(), true) . ')';
  45 } else {
  46         echo $email . ' is not a valid email address (result code ' . $validator->getError() . ')';
  47 }
  48 ```
  49
  50 ##Contributors##
  51 As this is a port from another library and work, here are other people related to the previous:
  52
  53 * Ricard Clau [@ricardclau](http://github.com/ricardclau):              Performance against PHP built-in filter_var
  54 * Josepf Bielawski [@stloyd](http://github.com/stloyd):                 For its first re-work of Dominic's lib
  55 * Dominic Sayers [@dominicsayers](http://github.com/dominicsayers):     The original isemail function
  56
  57 ##License##
  58 Released under the MIT License attached with this code.
  59