1: <?php
 2: 
 3: /**
 4:  * The interface for all complex data types
 5:  * 
 6:  * @package alpha::model::types
 7:  * @since 1.0
 8:  * @author John Collins <dev@alphaframework.org>
 9:  * @version $Id: AlphaTypeInterface.inc 1496 2012-02-12 20:32:21Z alphadev $
10:  * @license http://www.opensource.org/licenses/bsd-license.php The BSD License
11:  * @copyright Copyright (c) 2012, John Collins (founder of Alpha Framework).  
12:  * All rights reserved.
13:  * 
14:  * <pre>
15:  * Redistribution and use in source and binary forms, with or 
16:  * without modification, are permitted provided that the 
17:  * following conditions are met:
18:  * 
19:  * * Redistributions of source code must retain the above 
20:  *   copyright notice, this list of conditions and the 
21:  *   following disclaimer.
22:  * * Redistributions in binary form must reproduce the above 
23:  *   copyright notice, this list of conditions and the 
24:  *   following disclaimer in the documentation and/or other 
25:  *   materials provided with the distribution.
26:  * * Neither the name of the Alpha Framework nor the names 
27:  *   of its contributors may be used to endorse or promote 
28:  *   products derived from this software without specific 
29:  *   prior written permission.
30:  *   
31:  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 
32:  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 
33:  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
34:  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
35:  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 
36:  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
37:  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
38:  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
39:  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
40:  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
41:  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 
42:  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
43:  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
44:  * </pre>
45:  *  
46:  */
47: interface AlphaTypeInterface {
48:     /**
49:      * Set the value of the type
50:      * 
51:      * @param $val mixed
52:      * @since 1.0
53:      */
54:     public function setValue($val);
55:     
56:     /**
57:      * Get the value
58:      * 
59:      * @return mixed
60:      * @since 1.0
61:      */
62:     public function getValue();
63:     
64:     /**
65:      * Set the validation helper text
66:      * 
67:      * @param string $helper
68:      * @since 1.0
69:      */
70:     public function setHelper($helper);
71:     
72:     /**
73:      * Get the validation helper text
74:      * 
75:      * @return string
76:      * @since 1.0
77:      */
78:     public function getHelper();
79:     
80:     /**
81:      * Convert the valud of the complex type to a string 
82:      * 
83:      * @return string
84:      * @since 1.0
85:      */
86:     public function __toString();
87: }
88: 
89: ?>