1 <?php
2
3 /**
4 * The MIT License
5 *
6 * Copyright 2014 George Marques <george at georgemarques.com.br>.
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 * THE SOFTWARE.
25 */
26
27 namespace Flikore\Validator;
28
29 /**
30 * Represents a specific field in a set. To be used inside a ValidatorValue, representing
31 * a property in the object being validated instead of raw immediate value.
32 *
33 * @author George Marques <george at georgemarques.com.br>
34 * @version 0.5.2
35 * @since 0.4.0
36 * @license http://opensource.org/licenses/MIT MIT
37 * @copyright (c) 2014, George Marques
38 * @package Flikore\Validator
39 */
40 class ValidationKey
41 {
42 /**
43 * The name of the key to pull from the validated object.
44 * @var string The name of the key to pull from the validated object.
45 */
46 protected $key;
47
48 /**
49 * Creates a new ValidationValue object.
50 * @param string $key The name of the key to pull from the validated object.
51 */
52 public function __construct($key)
53 {
54 if(is_null($key))
55 {
56 throw new \InvalidArgumentException('The key name must not be null');
57 }
58 if(!is_string($key))
59 {
60 if(is_array($key) || (is_object($key) && !method_exists($key, '__toString')))
61 {
62 throw new \InvalidArgumentException('The key name must be convertible to string');
63 }
64 $key = (string) $key;
65 }
66
67 $this->key = $key;
68 }
69
70 /**
71 * Gets the name of the key to pull from the validated object.
72 * @return string The key.
73 */
74 public function getKey()
75 {
76 return $this->key;
77 }
78 }
79