vendor/zendframework/zend-uri/src/Mailto.php

   1 <?php
   2 /**
   3  * @see       https://github.com/zendframework/zend-uri for the canonical source repository
   4  * @copyright Copyright (c) 2005-2018 Zend Technologies USA Inc. (https://www.zend.com)
   5  * @license   https://github.com/zendframework/zend-uri/blob/master/LICENSE.md New BSD License
   6  */
   7
   8 namespace Zend\Uri;
   9
  10 use Zend\Validator\EmailAddress as EmailValidator;
  11 use Zend\Validator\ValidatorInterface;
  12
  13 /**
  14  * "Mailto" URI handler
  15  *
  16  * The 'mailto:...' scheme is loosely defined in RFC-1738
  17  */
  18 class Mailto extends Uri
  19 {
  20     protected static $validSchemes = ['mailto'];
  21
  22     /**
  23      * Validator for use when validating email address
  24      * @var ValidatorInterface
  25      */
  26     protected $emailValidator;
  27
  28     /**
  29      * Check if the URI is a valid Mailto URI
  30      *
  31      * This applies additional specific validation rules beyond the ones
  32      * required by the generic URI syntax
  33      *
  34      * @return bool
  35      * @see    Uri::isValid()
  36      */
  37     public function isValid()
  38     {
  39         if ($this->host || $this->userInfo || $this->port) {
  40             return false;
  41         }
  42
  43         if (empty($this->path)) {
  44             return false;
  45         }
  46
  47         if (0 === strpos($this->path, '/')) {
  48             return false;
  49         }
  50
  51         $validator = $this->getValidator();
  52         return $validator->isValid($this->path);
  53     }
  54
  55     /**
  56      * Set the email address
  57      *
  58      * This is in fact equivalent to setPath() - but provides a more clear interface
  59      *
  60      * @param  string $email
  61      * @return Mailto
  62      */
  63     public function setEmail($email)
  64     {
  65         return $this->setPath($email);
  66     }
  67
  68     /**
  69      * Get the email address
  70      *
  71      * This is infact equivalent to getPath() - but provides a more clear interface
  72      *
  73      * @return string
  74      */
  75     public function getEmail()
  76     {
  77         return $this->getPath();
  78     }
  79
  80     /**
  81      * Set validator to use when validating email address
  82      *
  83      * @param  ValidatorInterface $validator
  84      * @return Mailto
  85      */
  86     public function setValidator(ValidatorInterface $validator)
  87     {
  88         $this->emailValidator = $validator;
  89         return $this;
  90     }
  91
  92     /**
  93      * Retrieve validator for use with validating email address
  94      *
  95      * If none is currently set, an EmailValidator instance with default options
  96      * will be used.
  97      *
  98      * @return ValidatorInterface
  99      */
 100     public function getValidator()
 101     {
 102         if (null === $this->emailValidator) {
 103             $this->setValidator(new EmailValidator());
 104         }
 105         return $this->emailValidator;
 106     }
 107 }