<?php
/**
 * A metadata object, used by other components in Compute and Object Storage
 *
 * @copyright 2012 Rackspace Hosting, Inc.
 * See COPYING for licensing information
 *
 * @package phpOpenCloud
 * @version 1.0
 * @author Glen Campbell <hide@address.com>
 */

namespace OpenCloud;

require_once('base.inc');

/**
 * The Metadata class represents either Server or Image metadata
 *
 * @api
 * @author Glen Campbell <hide@address.com>
 */
class Metadata extends Base {

	private
		$_keylist=array();	// array holding the names of keys that were set

	/**
	 * This setter overrides the base one, since the metadata key can be
	 * anything
	 *
	 * @param string $key
	 * @param string $value
	 * @return void
	 */
	public function __set($key, $value) {
		// set the value and track the keys
		if (!in_array($key, $this->_keylist))
			$this->_keylist[] = $key;
		$this->$key = $value;
	}

	/**
	 * Returns the list of keys defined
	 *
	 * @return array
	 */
	public function Keylist() {
	    return $this->_keylist;
	}

	/**
	 * Sets metadata values from an array, with optional prefix
	 *
	 * If $prefix is provided, then only array keys that match the prefix
	 * are set as metadata values, and $prefix is stripped from the key name.
	 *
	 * @param array $values an array of key/value pairs to set
	 * @param string $prefix if provided, a prefix that is used to identify
	 *      metadata values. For example, you can set values from headers
	 *      for a Container by using $prefix='X-Container-Meta-'.
	 * @return void
	 */
	public function SetArray($values, $prefix=NULL) {
	    foreach($values as $key => $value) {
	        if ($prefix) {
	            if (strpos($key, $prefix) === 0) {
	                $name = substr($key, strlen($prefix));
	                $this->debug(_('Setting [%s] to [%s]'), $name, $value);
	                $this->$name = $value;
	            }
	        }
	        else
	            $this->$key = $value;
	    }
	}

} // class Metadata