Subversion Repositories PHPX

<?php

namespace PointedEars\PHPX;

/**
* Interface to be implemented if the model should be localizable
*/
interface ILocalizable
{
  /**
   * Localizes this model.  The actual implementation is left to
   * the model class implementing this interface.
   */
  function localize ();
}

/**
 * Abstract model class
 *
 * Provides a constructor to initialize properties using setters and getters.
 *
 * @author Thomas Lahn
 */
abstract class AbstractModel extends Base
{
  /**
   * Creates a new model object
   *
   * @param array $data
   *   Initialization data (optional)
   * @param array $mapping
   *   Mapping for initialization data (optional)
   * @param bool  $exclusiveMapping
   *   Exclusive mapping (optional; default: inclusive)
   * @see AbstractModel::map()
   */
  protected function __construct (
    array $data = null, array $mapping = null, $exclusiveMapping = false)
  {
    if (!is_null($data))
    {
      $this->map($data, $mapping, $exclusiveMapping);
    }
  }

  /**
   * Returns <code>true</code> if a variable name is a property variable name
   * (starts with <tt>$_</tt>), <code>false</code> otherwise.
   *
   * @param string $varName
   * @return boolean
   * @see getPropertyVars()
   */
  private static function _isPropertyVar ($varName)
  {
    return preg_match('/^_\\w/', $varName) > 0;
  }

  /**
   * Returns <code>true</code> if a variable name is a property variable name
   * (starts with <tt>$_</tt>), <code>false</code> otherwise.
   *
   * @param string $varName
   * @return string
   * @see getPropertyVars()
   */
  private static function _toPropertyVar ($varName)
  {
    return preg_replace('/^_(\\w)/', '\\1', $varName);
  }

  /**
   * Returns the public names of the property variables of a {@link Model}
   * as an array of strings
   *
   * @return array
   */
  public function getPropertyVars ()
  {
    return array_map(
      array('self', '_toPropertyVar'),
      array_filter(
        array_keys(get_object_vars($this)),
        array('self', '_isPropertyVar')
      )
    );
  }

  /**
   * Maps the values of an associative array to a model object
   *
   * @param array $data
   *   Data to be mapped to properties of the object
   * @param array $mapping = null
   *   <p>If <var>$mapping</var> is not provided, or <code>null</code> (default),
   *   the values of <var>$data</var> are mapped to properties of
   *   the model object as specified by the keys of <var>$data</var>.</p>
   *   <p>If <var>$mapping</var> is provided and an array, the keys of
   *   <var>$data</var> are mapped to properties as specified by
   *   the corresponding values of <var>$mapping</var>.  If a value of
   *   <var>$mapping</var> is <code>null</code>, the corresponding value
   *   in <var>$data</var> is not mapped; if a key is missing in
   *   <var>$mapping</var>, the value is mapped as if <var>$mapping</var>
   *   was <code>null</code>.</p>
   * @param bool $exclusive = false
   *   <p>If <code>true</code>, <em>only</em> the keys of <var>$data</var>
   *   that are present in <var>$mapping</var> are mapped.</p>
   * @return AbstractModel
   *   The modified object
   */
  public function map (array $data, array $mapping = null, $exclusive = false)
  {
    if (is_null($mapping))
    {
      foreach ($data as $key => $value)
      {
        $this->$key = $value;
      }
    }
    else
    {
      foreach ($data as $key => $value)
      {
        if (array_key_exists($key, $mapping))
        {
          if ($exclusive || !is_null($mapping[$key]))
          {
            $this->{$mapping[$key]} = $value;
          }
        }
        else
        {
          $this->$key = $value;
        }
      }
    }

    return $this;
  }
}