<?php
/**
 * Pimf_Model
 *
 * PHP Version 5
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.
 * It is also available through the world-wide-web at this URL:
 * http://krsteski.de/new-bsd-license/
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to hide@address.com so we can send you a copy immediately.
 *
 * @copyright Copyright (c) 2010-2011 Gjero Krsteski (http://krsteski.de)
 * @license http://krsteski.de/new-bsd-license New BSD License
 */

/**
 * Returns only protected and public properties of the given model-object. You have to extend it.
 *
 * Normally you will use ArrayObject and than method getArrayCopy() to turn Classes to Array, but
 * with Pimf_Model_ToArray you have the opportunity to easily intercept the setting of the values at the array.
 *
 * Sure if you need it - otherwise please prefers using ArrayObject - is much faster!
 *
 * @package Pimf_Model_ToArray
 * @author Gjero Krsteski <hide@address.com>
 */
abstract class Pimf_Model_ToArray
{
  /**
   * Returns only protected and public properties of the given model-object.
   * For another properties output format, please override this method.
   * @return array A list of properties.
   */
  public function toArray()
  {
    return $this->mapProperties(
      $this->fetchClassVars()
    );
  }

  /**
   * Get the default properties of the class.
   * @return array
   */
  protected function fetchClassVars()
  {
    return get_class_vars(get_class($this));
  }

  /**
   * Maps the properties to array with actual values.
   * For another properties-mapping, please override this method.
   * @param array $properties
   * @return array
   */
  protected function mapProperties(array $properties)
  {
    $propertiesMap = array();

    foreach ($properties as $name => $defaultVal) {
      $propertiesMap[$name] = (true === empty($this->$name)) ? $defaultVal : $this->$name;
    }

    return $propertiesMap;
  }
}