Subversion Repositories PHPX

Rev

Rev 34 | Rev 60 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
34 PointedEar 1 
<?php
2 
 
59 PointedEar 3 
namespace PointedEars\PHPX;
34 PointedEar 4 
 
5 
/**
59 PointedEar 6 
 * Base class providing generic wrappers for reading from and
7 
 * and writing to inaccessible properties.
34 PointedEar 8 
 *
59 PointedEar 9 
 * For each such property there must exist a public dynamically
10 
 * bound method (the PHP default) in the inheriting class whose
11 
 * name is prefixed with 'get' (a <i>getter</i>, for read access)
12 
 * and/or with 'set' (a <i>setter</i>, for write access) followed
13 
 * by the property name.  (It is recommended to write the first
14 
 * letter of the property name in the method name in uppercase.
15 
 * For runtime-efficiency, underscores in the property name are
16 
 * <em>not</em> converted to camel-case ["property_name" requires
17 
 * "getProperty_name", <em>not</em> "getPropertyName"].)
18 
 *
19 
 * The getter or setter would then access the non-public property
20 
 * whose name is the name of the accessed property prefixed with
21 
 * underscore ('_'), called the <em>underscore property</em>.
22 
 * It can make sure that the value of the underscore property is
23 
 * of a specific type or within a specific range, i. e. perform
24 
 * automatic type conversion, normalize values that are out of
25 
 * range when the property is read, and reject/ignore attempts
26 
 * to set unsuitable property values.  This is particularly useful
27 
 * with instances of model classes; see {@link AbstractModel} and
28 
 * {@link Model}.
29 
 *
30 
 * Properties that do not have a getter are not available
31 
 * from unprivileged context, and an exception is thrown
32 
 * when attempting to read from them there.
33 
 *
34 
 * Properties that do not have a setter are effectively
35 
 * <em>read-only</em> from unprivileged context, and
36 
 * an exception is thrown when attempting to write to them there.
37 
 *
34 PointedEar 38 
 * @author Thomas 'PointedEars' Lahn
39 
 */
40 
abstract class Base
41 
{
42 
  /**
43 
   * Retrieves a property value.
44 
   *
59 PointedEar 45 
   *
34 PointedEar 46 
   * @param string $name
47 
   *   Property name
48 
   * @throws InvalidArgumentException
59 PointedEar 49 
   *   if the underscore property for the property
50 
   *   named <code><var>$name</var></code> does not exist
51 
   *   or has no getter
34 PointedEar 52 
   * @return mixed
59 PointedEar 53 
   *   Return value of the property-specific getter
34 PointedEar 54 
   */
55 
  public function __get ($name)
56 
  {
57 
    $getter = 'get' . ucfirst($name);
58 
    if (method_exists($this, $getter))
59 
    {
60 
      return $this->$getter();
61 
    }
62 
 
63 
    if (property_exists($this, "_$name"))
64 
    {
59 PointedEar 65 
      throw new \InvalidArgumentException("Property '{$name}' has no getter");
34 PointedEar 66 
    }
67 
 
59 PointedEar 68 
    throw new \InvalidArgumentException("No such property: '{$name}'");
34 PointedEar 69 
  }
70 
 
71 
  /**
72 
   * Sets a property value.
73 
   *
59 PointedEar 74 
   * Called when attempting to write data to inaccessible
75 
   * (usually protected or private) properties.
76 
   *
34 PointedEar 77 
   * @param string $name
78 
   *   Property name
79 
   * @param mixed $value
80 
   *   Property value
81 
   * @throws InvalidArgumentException
59 PointedEar 82 
   *   if the protected underscore property for the property
83 
   *   named <code><var>$name</var></code> does not exist
84 
   *   or has no setter (is read-only)
34 PointedEar 85 
   * @return mixed
86 
   *   Return value of the property-specific setter
87 
   */
88 
  public function __set ($name, $value)
89 
  {
90 
    $setter = 'set' . ucfirst($name);
91 
    if (method_exists($this, $setter))
92 
    {
93 
      return $this->$setter($value);
94 
    }
95 
 
96 
    if (property_exists($this, "_$name"))
97 
    {
59 PointedEar 98 
      throw new \InvalidArgumentException("Property '{$name}' has no setter");
34 PointedEar 99 
    }
100 
 
59 PointedEar 101 
    throw new \InvalidArgumentException("No such property: '{$name}'");
34 PointedEar 102 
  }
103 
}