1: <?php
 2: 
 3: /**
 4:  * @copyright Copyright (c) 2009-2022 ThemeCatcher (https://www.themecatcher.net)
 5:  */
 6: class Quform_Validator_AlphaNumeric extends Quform_Validator_Abstract
 7: {
 8:     const INVALID = 'alphaNumericInvalid';
 9:     const NOT_ALNUM = 'notAlphaNumeric';
10: 
11:     /**
12:      * Alphanumeric filter used for validation
13:      *
14:      * @var Quform_Filter_AlphaNumeric
15:      */
16:     protected static $filter = null;
17: 
18:     /**
19:      * Returns true if the given value contains only alpha-numeric characters.
20:      * Return false otherwise.
21:      *
22:      * @param   string   $value
23:      * @return  boolean
24:      */
25:     public function isValid($value)
26:     {
27:         $this->reset();
28: 
29:         if ( ! is_string($value)) {
30:             $this->error(self::INVALID);
31:             return false;
32:         }
33: 
34:         if (self::$filter === null) {
35:             self::$filter = new Quform_Filter_AlphaNumeric;
36:         }
37: 
38:         self::$filter->setConfig('allowWhiteSpace', $this->config('allowWhiteSpace'));
39: 
40:         if ($value !== self::$filter->filter($value)) {
41:             $this->error(self::NOT_ALNUM, compact('value'));
42:             return false;
43:         }
44: 
45:         return true;
46:     }
47: 
48:     /**
49:      * Get all message templates or the single message with the given key
50:      *
51:      * @param   string|null   $key
52:      * @return  array|string
53:      */
54:     public static function getMessageTemplates($key = null)
55:     {
56:         $messageTemplates = array(
57:             self::INVALID => __('Invalid data type, string expected',  'quform'),
58:             self::NOT_ALNUM => __('Only alphanumeric characters are allowed',  'quform')
59:         );
60: 
61:         if (is_string($key)) {
62:             return array_key_exists($key, $messageTemplates) ? $messageTemplates[$key] : null;
63:         }
64: 
65:         return $messageTemplates;
66:     }
67: 
68:     /**
69:      * Get the default config for this validator
70:      *
71:      * @param   string|null  $key  Get the config by key, if omitted the full config is returned
72:      * @return  array
73:      */
74:     public static function getDefaultConfig($key = null)
75:     {
76:         $config = apply_filters('quform_default_config_validator_alpha_numeric', array(
77:             'allowWhiteSpace' => false,
78:             'messages' => array(
79:                 self::INVALID => '',
80:                 self::NOT_ALNUM => ''
81:             )
82:         ));
83: 
84:         $config['type'] = 'alphaNumeric';
85: 
86:         if (Quform::isNonEmptyString($key)) {
87:             return Quform::get($config, $key);
88:         }
89: 
90:         return $config;
91:     }
92: }
93: