tweet_live: comparison web/lib/Zend/Cloud/DocumentService/Adapter/WindowsAzure.php

equal deleted inserted replaced

-:2251fb41dbc7
+:1e110b03ae96
 * to license@zend.com so we can send you a copy immediately.
 *
 * @category   Zend
 * @package    Zend_Cloud
 * @subpackage DocumentService
-* @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
+* @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
 require_once 'Zend/Cloud/DocumentService/Adapter/AbstractAdapter.php';
 require_once 'Zend/Cloud/DocumentService/Adapter/WindowsAzure/Query.php';
 * SimpleDB adapter for document service.
 *
 * @category   Zend
 * @package    Zend_Cloud
 * @subpackage DocumentService
-* @copyright  Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
+* @copyright  Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
 * @license    http://framework.zend.com/license/new-bsd     New BSD License
 */
 class Zend_Cloud_DocumentService_Adapter_WindowsAzure
 extends Zend_Cloud_DocumentService_Adapter_AbstractAdapter
 {
 /*
 * Options array keys for the Azure adapter.
 */
 const PARTITION_KEY         = 'PartitionKey';
 const ROW_KEY               = 'RowKey';
 const VERIFY_ETAG           = "verify_etag";
 const TIMESTAMP_KEY         = "Timestamp";
 const DEFAULT_HOST          = Zend_Service_WindowsAzure_Storage::URL_CLOUD_TABLE;
 const DEFAULT_QUERY_CLASS   = 'Zend_Cloud_DocumentService_Adapter_WindowsAzure_Query';
 /**
 * Azure  service instance.
 *
 * @var Zend_Service_WindowsAzure_Storage_Table
 */
 protected $_storageClient;
 /**
 * Class to utilize for new query objects
 *
 * @var string
 */
 protected $_queryClass = 'Zend_Cloud_DocumentService_Adapter_WindowsAzure_Query';
 /**
 */
 protected $_defaultPartitionKey;
 /**
 * Constructor
 *
 * @param array $options
 * @return void
 */
 public function __construct($options = array())
 {
 if ($options instanceof Zend_Config) {
 $options = $options->toArray();
 }
 }
 }
 /**
 * Set the default partition key
 *
 * @param  string $key
 * @return Zend_Cloud_DocumentService_Adapter_WindowsAzure
 */
 public function setDefaultPartitionKey($key)
 {
 $this->_validateKey($key);
 return $this;
 }
 /**
 * Retrieve default partition key
 *
 * @return null|string
 */
 public function getDefaultPartitionKey()
 {
 return $this->_defaultPartitionKey;
 *
 * @param  string $name
 * @param  array  $options
 * @return boolean
 */
 public function createCollection($name, $options = null)
 {
 if (!preg_match('/^[A-Za-z][A-Za-z0-9]{2,}$/', $name)) {
 throw new Zend_Cloud_DocumentService_Exception('Invalid collection name; Windows Azure collection names must consist of alphanumeric characters only, and be at least 3 characters long');
 }
 try {
 *
 * @param  string $name
 * @param  array  $options
 * @return boolean
 */
 public function deleteCollection($name, $options = null)
 {
 try {
 $this->_storageClient->deleteTable($name);
 } catch(Zend_Service_WindowsAzure_Exception $e) {
 if (strpos($e->getMessage(), "does not exist") === false) {
 * List collections.
 *
 * @param  array  $options
 * @return array
 */
 public function listCollections($options = null)
 {
 try {
 $tables = $this->_storageClient->listTables();
 $restables = array();
 foreach ($tables as $table) {
 return $tables;
 }
 /**
 * Create suitable document from array of fields
 *
 * @param  array $document
 * @param  null|string $collectionName Collection to which this document belongs
 * @return Zend_Cloud_DocumentService_Document
 */
 protected function _getDocumentFromArray($document, $collectionName = null)
 }
 $documentClass = $this->getDocumentClass();
 return new $documentClass($document, $key);
 }
 /**
 * List all documents in a collection
 *
 * @param  string $collectionName
 * @param  null|array $options
 * @return Zend_Cloud_DocumentService_DocumentSet
 */
 public function listDocuments($collectionName, array $options = null)
 {
 $select = $this->select()->from($collectionName);
 */
 public function insertDocument($collectionName, $document, $options = null)
 {
 if (is_array($document)) {
 $document =  $this->_getDocumentFromArray($document, $collectionName);
 }
 if (!$document instanceof Zend_Cloud_DocumentService_Document) {
 throw new Zend_Cloud_DocumentService_Exception('Invalid document supplied');
 }
 $key = $this->_validateDocumentId($document->getId(), $collectionName);
 $document->setId($key);
 $this->_validateCompositeKey($key);
 $this->_validateFields($document);
 try {
 $entity = new Zend_Service_WindowsAzure_Storage_DynamicTableEntity($key[0], $key[1]);
 $entity->setAzureValues($document->getFields(), true);
 $this->_storageClient->insertEntity($collectionName, $entity);
 } catch(Zend_Service_WindowsAzure_Exception $e) {
 throw new Zend_Cloud_DocumentService_Exception('Error on document insertion: '.$e->getMessage(), $e->getCode(), $e);
 }
 }
 /**
 * Replace document.
 *
 * The new document replaces the existing document.
 *
 * @param  Zend_Cloud_DocumentService_Document $document
 * @param  array                         $options
 * @return boolean
 */
 public function replaceDocument($collectionName, $document, $options = null)
 {
 if (is_array($document)) {
 $document = $this->_getDocumentFromArray($document, $collectionName);
 }
 if (!$document instanceof Zend_Cloud_DocumentService_Document) {
 throw new Zend_Cloud_DocumentService_Exception('Invalid document supplied');
 }
 $key = $this->_validateDocumentId($document->getId(), $collectionName);
 $this->_validateFields($document);
 try {
 $entity = new Zend_Service_WindowsAzure_Storage_DynamicTableEntity($key[0], $key[1]);
 $entity->setAzureValues($document->getFields(), true);
 if (isset($options[self::VERIFY_ETAG])) {
 $entity->setEtag($options[self::VERIFY_ETAG]);
 }
 $this->_storageClient->updateEntity($collectionName, $entity, isset($options[self::VERIFY_ETAG]));
 } catch(Zend_Service_WindowsAzure_Exception $e) {
 throw new Zend_Cloud_DocumentService_Exception('Error on document replace: '.$e->getMessage(), $e->getCode(), $e);
 }
 }
 /**
 * Update document.
 *
 * The new document is merged the existing document.
 *
 * @param  string $collectionName
 * @param  mixed|Zend_Cloud_DocumentService_Document $documentId Document identifier or document contaiing updates
 * @param  null|array|Zend_Cloud_DocumentService_Document Fields to update (or new fields))
 $entity->setAzureValues($fieldset, true);
 if (isset($options[self::VERIFY_ETAG])) {
 $entity->setEtag($options[self::VERIFY_ETAG]);
 }
 $this->_storageClient->mergeEntity($collectionName, $entity, isset($options[self::VERIFY_ETAG]));
 } catch(Zend_Service_WindowsAzure_Exception $e) {
 throw new Zend_Cloud_DocumentService_Exception('Error on document update: '.$e->getMessage(), $e->getCode(), $e);
 }
 }
 /**
 * Delete document.
 *
 * @param  mixed  $document Document ID or Document object.
 * @param  array  $options
 }
 }
 /**
 * Fetch single document by ID
 *
 * @param  string $collectionName Collection name
 * @param  mixed $documentId Document ID, adapter-dependent
 * @param  array $options
 * @return Zend_Cloud_DocumentService_Document
 */
 return false;
 }
 throw new Zend_Cloud_DocumentService_Exception('Error on document fetch: '.$e->getMessage(), $e->getCode(), $e);
 }
 }
 /**
 * Query for documents stored in the document service. If a string is passed in
 * $query, the query string will be passed directly to the service.
 *
 * @param  string $collectionName Collection name
 }
 $setClass = $this->getDocumentSetClass();
 return new $setClass($resultSet);
 }
 /**
 * Create query statement
 *
 * @return Zend_Cloud_DocumentService_Query
 */
 if (!$query instanceof $defaultClass) {
 throw new Zend_Cloud_DocumentService_Exception('Query class must extend ' . self::DEFAULT_QUERY_CLASS);
 }
 $query->select($fields);
 return $query;
 }
 /**
 * Get the concrete service client
 *
 * @return Zend_Service_WindowsAzure_Storage_Table
 */
 public function getClient()
 {
 return $this->_storageClient;
 }
 /**
 * Resolve table values to attributes
 *
 * @param  Zend_Service_WindowsAzure_Storage_TableEntity $entity
 * @return array
 */
 protected function _resolveAttributes(Zend_Service_WindowsAzure_Storage_TableEntity $entity)
 {
 $result = array();
 foreach ($entity->getAzureValues() as $attr) {
 $result[$attr->Name] = $attr->Value;
 }
 return $result;
 }
 /**
 * Validate a partition or row key
 *
 * @param  string $key
 * @return void
 * @throws Zend_Cloud_DocumentService_Exception
 */
 protected function _validateKey($key)
 {
 }
 }
 /**
 * Validate a composite key
 *
 * @param  array $key
 * @return throws Zend_Cloud_DocumentService_Exception
 */
 protected function _validateCompositeKey(array $key)
 {
 if (2 != count($key)) {
 }
 /**
 * Validate a document identifier
 *
 * If the identifier is an array containing a valid partition and row key,
 * returns it. If the identifier is a string:
 * - if a default partition key is present, it creates an identifier using
 *   that and the provided document ID
 * - if a collection name is provided, it will use that for the partition key
 * - otherwise, it's invalid
 *
 * @param  array|string $documentId
 * @param  null|string $collectionName
 * @return array
 * @throws Zend_Cloud_DocumentService_Exception
 */
 protected function _validateDocumentId($documentId, $collectionName = false)
 {
 }
 /**
 * Validate a document's fields for well-formedness
 *
 * Since Azure uses Atom, and fieldnames are included as part of XML
 * element tag names, the field names must be valid XML names.
 *
 * @param  Zend_Cloud_DocumentService_Document|array $document
 * @return void
 * @throws Zend_Cloud_DocumentService_Exception
 }
 /**
 * Validate an individual field name for well-formedness
 *
 * Since Azure uses Atom, and fieldnames are included as part of XML
 * element tag names, the field names must be valid XML names.
 *
 * While we could potentially normalize names, this could also lead to
 * conflict with other field names -- which we should avoid. As such,
 * invalid field names will raise an exception.
 *
 * @param  string $key
 * @return void

changeset 886	1e110b03ae96
parent 807	877f952ae2bd
child 1230	68c69c656a2c