فهرست منبع

[MANUAL] English:

- first fix for r22773

git-svn-id: http://framework.zend.com/svn/framework/standard/trunk@22784 44c647ce-9c0f-0410-b52a-842ac1e357ba
thomas 15 سال پیش
والد
کامیت
1c64f7fffd

+ 13 - 11
documentation/manual/en/module_specs/Zend_Service_WindowsAzure.xml

@@ -26,9 +26,9 @@
             <listitem>
             <listitem>
                 <para>
                 <para>
                     You can develop your application using
                     You can develop your application using
-                    <classname>Zend_Service_WindowsAzure</classname> and the Windows Azure SDK,
-                    which provides a local developent environment of the services provided by
-                    Windows Azure's cloud infrastructure.
+                    <classname>Zend_Service_WindowsAzure</classname> and the Windows Azure
+                    <acronym>SDK</acronym>, which provides a local developent environment of the
+                    services provided by Windows Azure's cloud infrastructure.
                 </para>
                 </para>
             </listitem>
             </listitem>
 
 
@@ -45,8 +45,8 @@
             The first case requires you to install the <ulink
             The first case requires you to install the <ulink
                 url="http://www.microsoft.com/downloads/details.aspx?FamilyID=6967ff37-813e-47c7-b987-889124b43abd&displaylang=en">Windows
                 url="http://www.microsoft.com/downloads/details.aspx?FamilyID=6967ff37-813e-47c7-b987-889124b43abd&displaylang=en">Windows
                 Azure SDK</ulink> on your development machine.  It is currently only available for
                 Azure SDK</ulink> on your development machine.  It is currently only available for
-            Windows environments; progress is being made on a Java-based version of the SDK which
-            can run on any platform.
+            Windows environments; progress is being made on a Java-based version of the
+            <acronym>SDK</acronym> which can run on any platform.
         </para>
         </para>
 
 
         <para>
         <para>
@@ -59,13 +59,13 @@
         <title>API Documentation</title>
         <title>API Documentation</title>
 
 
         <para>
         <para>
-            The <classname>Zend_Service_WindowsAzure</classname> class provides the PHP wrapper to
+            The <classname>Zend_Service_WindowsAzure</classname> class provides the
+            <acronym>PHP</acronym> wrapper to
             the Windows Azure <acronym>REST</acronym> interface. Please consult the <ulink
             the Windows Azure <acronym>REST</acronym> interface. Please consult the <ulink
                 url="http://msdn.microsoft.com/en-us/library/dd179355.aspx">REST
                 url="http://msdn.microsoft.com/en-us/library/dd179355.aspx">REST
                 documentation</ulink> for detailed description of the service. You will need to be
                 documentation</ulink> for detailed description of the service. You will need to be
             familiar with basic concepts in order to use this service.
             familiar with basic concepts in order to use this service.
         </para>
         </para>
-    
     </sect2>
     </sect2>
 
 
     <sect2 id="zend.service.windowsazure.features">
     <sect2 id="zend.service.windowsazure.features">
@@ -78,14 +78,15 @@
         <itemizedlist>
         <itemizedlist>
             <listitem>
             <listitem>
                 <para>
                 <para>
-                    PHP classes for Windows Azure Blobs, Tables and Queues (for
+                    <acronym>PHP</acronym> classes for Windows Azure Blobs, Tables and Queues (for
                     <acronym>CRUD</acronym> operations)
                     <acronym>CRUD</acronym> operations)
                 </para>
                 </para>
             </listitem>
             </listitem>
 
 
             <listitem>
             <listitem>
                 <para>
                 <para>
-                    Helper Classes for HTTP transport, AuthN/AuthZ, REST and Error Management
+                    Helper Classes for <acronym>HTTP</acronym> transport, AuthN/AuthZ,
+                    <acronym>REST</acronym> and Error Management
                 </para>
                 </para>
             </listitem>
             </listitem>
 
 
@@ -102,8 +103,9 @@
 
 
         <para>
         <para>
             <classname>Zend_Service_WindowsAzure</classname> provides access to Windows Azure's
             <classname>Zend_Service_WindowsAzure</classname> provides access to Windows Azure's
-            storage, computation and management interfaces by abstracting the REST/XML interface
-            Windows Azure provides into a simple PHP API.
+            storage, computation and management interfaces by abstracting the
+            <acronym>REST</acronym>/<acronym>XML</acronym> interface Windows Azure provides into a
+            simple <acronym>PHP</acronym> <acronym>API</acronym>.
         </para>
         </para>
 
 
         <para>
         <para>

+ 59 - 54
documentation/manual/en/module_specs/Zend_Service_WindowsAzure_Blob.xml

@@ -10,9 +10,9 @@
     </para>
     </para>
 
 
     <para>
     <para>
-        Blob Storage is offered by Windows Azure as a <acronym>REST</acronym> API which is
-        wrapped by the <classname>Zend_Service_WindowsAzure_Storage_Blob</classname> class in
-        order to provide a native PHP interface to the storage account.
+        Blob Storage is offered by Windows Azure as a <acronym>REST</acronym> <acronym>API</acronym>
+        which is wrapped by the <classname>Zend_Service_WindowsAzure_Storage_Blob</classname> class
+        in order to provide a native <acronym>PHP</acronym> interface to the storage account.
     </para>
     </para>
 
 
     <sect2 id="zend.service.windowsazure.storage.blob.api">
     <sect2 id="zend.service.windowsazure.storage.blob.api">
@@ -21,8 +21,8 @@
         <para>
         <para>
             This topic lists some examples of using the
             This topic lists some examples of using the
             <classname>Zend_Service_WindowsAzure_Storage_Blob</classname> class.  Other features are
             <classname>Zend_Service_WindowsAzure_Storage_Blob</classname> class.  Other features are
-            available in the download package, as well as a detailed API documentation of those
-            features.
+            available in the download package, as well as a detailed <acronym>API</acronym>
+            documentation of those features.
         </para>
         </para>
 
 
         <sect3 id="zend.service.windowsazure.storage.blob.api.create-container">
         <sect3 id="zend.service.windowsazure.storage.blob.api.create-container">
@@ -33,7 +33,7 @@
                 storage.
                 storage.
             </para>
             </para>
 
 
-            <example id="zend.service.windowsazure.storage.blob.api.create-container">
+            <example id="zend.service.windowsazure.storage.blob.api.create-container.example">
                 <title>Creating a storage container</title>
                 <title>Creating a storage container</title>
 
 
                 <programlisting language="php"><![CDATA[
                 <programlisting language="php"><![CDATA[
@@ -53,7 +53,7 @@ echo 'Container name is: ' . $result->Name;
                 storage.
                 storage.
             </para>
             </para>
 
 
-            <example id="zend.service.windowsazure.storage.blob.api.delete-container">
+            <example id="zend.service.windowsazure.storage.blob.api.delete-container.example">
                 <title>Deleting a storage container</title>
                 <title>Deleting a storage container</title>
 
 
                 <programlisting language="php"><![CDATA[
                 <programlisting language="php"><![CDATA[
@@ -71,7 +71,7 @@ $storageClient->deleteContainer('testcontainer');
                 development storage. Note that the container has already been created before.
                 development storage. Note that the container has already been created before.
             </para>
             </para>
 
 
-            <example id="zend.service.windowsazure.storage.blob.api.storing-blob">
+            <example id="zend.service.windowsazure.storage.blob.api.storing-blob.example">
                 <title>Storing a blob</title>
                 <title>Storing a blob</title>
 
 
                 <programlisting language="php"><![CDATA[
                 <programlisting language="php"><![CDATA[
@@ -91,13 +91,13 @@ echo 'Blob name is: ' . $result->Name;
             <title>Copying a blob</title>
             <title>Copying a blob</title>
 
 
             <para>
             <para>
-                Using the following code, a blob can be copied from inside the storage account.  The
+                Using the following code, a blob can be copied from inside the storage account. The
                 advantage of using this method is that the copy operation occurs in the Azure cloud
                 advantage of using this method is that the copy operation occurs in the Azure cloud
                 and does not involve downloading the blob. Note that the container has already been
                 and does not involve downloading the blob. Note that the container has already been
                 created before.
                 created before.
             </para>
             </para>
 
 
-            <example id="zend.service.windowsazure.storage.blob.api.copy-blob">
+            <example id="zend.service.windowsazure.storage.blob.api.copy-blob.example">
                 <title>Copying a blob</title>
                 <title>Copying a blob</title>
 
 
                 <programlisting language="php"><![CDATA[
                 <programlisting language="php"><![CDATA[
@@ -122,7 +122,7 @@ echo 'Copied blob name is: ' . $result->Name;
                 blob has been uploaded.
                 blob has been uploaded.
             </para>
             </para>
 
 
-            <example id="zend.service.windowsazure.storage.blob.api.download-blob">
+            <example id="zend.service.windowsazure.storage.blob.api.download-blob.example">
                 <title>Downloading a blob</title>
                 <title>Downloading a blob</title>
 
 
                 <programlisting language="php"><![CDATA[
                 <programlisting language="php"><![CDATA[
@@ -151,7 +151,7 @@ $storageClient->getBlob(
                 storage. Note that the container has already been created before.
                 storage. Note that the container has already been created before.
             </para>
             </para>
 
 
-            <example id="zend.service.windowsazure.storage.blob.api.public-blob">
+            <example id="zend.service.windowsazure.storage.blob.api.public-blob.example">
                 <title>Making a blob publicly available</title>
                 <title>Making a blob publicly available</title>
 
 
                 <programlisting language="php"><![CDATA[
                 <programlisting language="php"><![CDATA[
@@ -163,33 +163,33 @@ $storageClient->setContainerAcl('testcontainer', Zend_Service_WindowsAzure_Stora
             </example>
             </example>
         </sect3>
         </sect3>
     </sect2>
     </sect2>
-  
+
     <sect2 id="zend.service.windowsazure.storage.blob.root">
     <sect2 id="zend.service.windowsazure.storage.blob.root">
         <title>Root container</title>
         <title>Root container</title>
 
 
         <para>
         <para>
-            Windows Azure Blob Storage provides support to work with a "root container". 
-            This means that a blob can be stored in the root of your storage account, 
-            i.e. <code>http://myaccount.blob.core.windows.net/somefile.txt</code>.
+            Windows Azure Blob Storage provides support to work with a "root container".
+            This means that a blob can be stored in the root of your storage account,
+            i.e. <filename>http://myaccount.blob.core.windows.net/somefile.txt</filename>.
         </para>
         </para>
-        
+
         <para>
         <para>
             In order to work with the root container, it should first be created using the
             In order to work with the root container, it should first be created using the
             <methodname>createContainer()</methodname> method, naming the container
             <methodname>createContainer()</methodname> method, naming the container
-            <varname>$root</varname>.  All other operations on the root container should be issued
+            <varname>$root</varname>. All other operations on the root container should be issued
             with the container name set to <varname>$root</varname>.
             with the container name set to <varname>$root</varname>.
         </para>
         </para>
     </sect2>
     </sect2>
-  
+
     <sect2 id="zend.service.windowsazure.storage.blob.wrapper">
     <sect2 id="zend.service.windowsazure.storage.blob.wrapper">
         <title>Blob storage stream wrapper</title>
         <title>Blob storage stream wrapper</title>
 
 
         <para>
         <para>
-            The Windows Azure SDK for PHP provides support for registering a blob storage
-            client as a PHP file stream wrapper. The blob storage stream wrapper provides
-            support for using regular file operations on Windows Azure Blob Storage.
-            For example, one can open a file from Windows Azure Blob Storage with
-            the <functionname>fopen()</functionname> function:
+            The Windows Azure <acronym>SDK</acronym> for <acronym>PHP</acronym> provides support
+            for registering a blob storage client as a <acronym>PHP</acronym> file stream wrapper.
+            The blob storage stream wrapper provides support for using regular file operations on
+            Windows Azure Blob Storage. For example, one can open a file from Windows Azure Blob
+            Storage with the <methodname>fopen()</methodname> function:
         </para>
         </para>
 
 
         <example id="zend.service.windowsazure.storage.blob.wrapper.sample">
         <example id="zend.service.windowsazure.storage.blob.wrapper.sample">
@@ -203,11 +203,11 @@ $fileHandle = fopen('azure://mycontainer/myfile.txt', 'r');
 fclose($fileHandle);
 fclose($fileHandle);
 ]]></programlisting>
 ]]></programlisting>
         </example>
         </example>
-    
+
         <para>
         <para>
-            In order to do this, the Windows Azure SDK for PHP blob storage client
-            must be registered as a stream wrapper. This can be done by calling the
-            <methodname>registerStreamWrapper()</methodname> method:
+            In order to do this, the Windows Azure <acronym>SDK</acronym> for <acronym>PHP</acronym>
+            blob storage client must be registered as a stream wrapper. This can be done by calling
+            the <methodname>registerStreamWrapper()</methodname> method:
         </para>
         </para>
 
 
         <example id="zend.service.windowsazure.storage.blob.wrapper.register">
         <example id="zend.service.windowsazure.storage.blob.wrapper.register">
@@ -215,14 +215,17 @@ fclose($fileHandle);
 
 
             <programlisting language="php"><![CDATA[
             <programlisting language="php"><![CDATA[
 $storageClient = new Zend_Service_WindowsAzure_Storage_Blob();
 $storageClient = new Zend_Service_WindowsAzure_Storage_Blob();
-$storageClient->registerStreamWrapper(); // registers azure:// on this storage client
+
+// registers azure:// on this storage client
+$storageClient->registerStreamWrapper();
 
 
 // or:
 // or:
 
 
-$storageClient->registerStreamWrapper('blob://'); // regiters blob:// on this storage client
+// regiters blob:// on this storage client
+$storageClient->registerStreamWrapper('blob://');
 ]]></programlisting>
 ]]></programlisting>
         </example>
         </example>
-    
+
         <para>
         <para>
             To unregister the stream wrapper, the <methodname>unregisterStreamWrapper()</methodname>
             To unregister the stream wrapper, the <methodname>unregisterStreamWrapper()</methodname>
             method can be used.
             method can be used.
@@ -240,20 +243,20 @@ $storageClient->registerStreamWrapper('blob://'); // regiters blob:// on this st
             assigned on a container or a blob and given to a specific client using an URL-based
             assigned on a container or a blob and given to a specific client using an URL-based
             model.
             model.
         </para>
         </para>
-        
+
         <para>
         <para>
             An example would be the following signature:
             An example would be the following signature:
         </para>
         </para>
-        
+
         <literallayout>
         <literallayout>
 http://phpstorage.blob.core.windows.net/phpazuretestshared1?st=2009-08-17T09%3A06%3A17Z&amp;se=2009-08-17T09%3A56%3A17Z&amp;sr=c&amp;sp=w&amp;sig=hscQ7Su1nqd91OfMTwTkxabhJSaspx%2BD%2Fz8UqZAgn9s%3D
 http://phpstorage.blob.core.windows.net/phpazuretestshared1?st=2009-08-17T09%3A06%3A17Z&amp;se=2009-08-17T09%3A56%3A17Z&amp;sr=c&amp;sp=w&amp;sig=hscQ7Su1nqd91OfMTwTkxabhJSaspx%2BD%2Fz8UqZAgn9s%3D
         </literallayout>
         </literallayout>
-        
+
         <para>
         <para>
             The above signature gives write access to the "phpazuretestshared1"
             The above signature gives write access to the "phpazuretestshared1"
             container of the "phpstorage" account.
             container of the "phpstorage" account.
         </para>
         </para>
-    
+
         <sect3 id="zend.service.windowsazure.storage.blob.sharedaccesssig.generate">
         <sect3 id="zend.service.windowsazure.storage.blob.sharedaccesssig.generate">
             <title>Generating a Shared Access Signature</title>
             <title>Generating a Shared Access Signature</title>
 
 
@@ -264,7 +267,7 @@ http://phpstorage.blob.core.windows.net/phpazuretestshared1?st=2009-08-17T09%3A0
                 <classname>Zend_Service_WindowsAzure_Storage_Blob</classname> storage client can be
                 <classname>Zend_Service_WindowsAzure_Storage_Blob</classname> storage client can be
                 used.
                 used.
             </para>
             </para>
-            
+
             <para>
             <para>
                 The following example code will generate a Shared Access Signature for write access
                 The following example code will generate a Shared Access Signature for write access
                 in a container named "container1", within a timeframe of 3000 seconds.
                 in a container named "container1", within a timeframe of 3000 seconds.
@@ -278,14 +281,14 @@ $storageClient   = new Zend_Service_WindowsAzure_Storage_Blob();
 $sharedAccessUrl = $storageClient->generateSharedAccessUrl(
 $sharedAccessUrl = $storageClient->generateSharedAccessUrl(
     'container1',
     'container1',
     '',
     '',
-    'c', 
+    'c',
     'w',
     'w',
     $storageClient ->isoDate(time() - 500),
     $storageClient ->isoDate(time() - 500),
     $storageClient ->isoDate(time() + 3000)
     $storageClient ->isoDate(time() + 3000)
 );
 );
 ]]></programlisting>
 ]]></programlisting>
             </example>
             </example>
-            
+
             <para>
             <para>
                 The following example code will generate a Shared Access Signature for read access
                 The following example code will generate a Shared Access Signature for read access
                 in a blob named <filename>test.txt</filename> in a container named "container1"
                 in a blob named <filename>test.txt</filename> in a container named "container1"
@@ -300,7 +303,7 @@ $storageClient   = new Zend_Service_WindowsAzure_Storage_Blob();
 $sharedAccessUrl = $storageClient->generateSharedAccessUrl(
 $sharedAccessUrl = $storageClient->generateSharedAccessUrl(
     'container1',
     'container1',
     'test.txt',
     'test.txt',
-    'b', 
+    'b',
     'r',
     'r',
     $storageClient ->isoDate(time() - 500),
     $storageClient ->isoDate(time() - 500),
     $storageClient ->isoDate(time() + 3000)
     $storageClient ->isoDate(time() + 3000)
@@ -308,20 +311,21 @@ $sharedAccessUrl = $storageClient->generateSharedAccessUrl(
 ]]></programlisting>
 ]]></programlisting>
             </example>
             </example>
         </sect3>
         </sect3>
-        
+
         <sect3 id="zend.service.windowsazure.storage.blob.sharedaccesssig.consume">
         <sect3 id="zend.service.windowsazure.storage.blob.sharedaccesssig.consume">
             <title>Working with Shared Access Signatures from others</title>
             <title>Working with Shared Access Signatures from others</title>
 
 
             <para>
             <para>
                 When you receive a Shared Access Signature from someone else, you can use the
                 When you receive a Shared Access Signature from someone else, you can use the
-                Windows Azure SDK for PHP to work with the addressed resource.  For example, the
-                following signature can be retrieved from the owner of a storage account:
+                Windows Azure <acronym>SDK</acronym> for <acronym>PHP</acronym> to work with the
+                addressed resource. For example, the following signature can be retrieved from the
+                owner of a storage account:
             </para>
             </para>
-            
+
             <literallayout>
             <literallayout>
 http://phpstorage.blob.core.windows.net/phpazuretestshared1?st=2009-08-17T09%3A06%3A17Z&amp;se=2009-08-17T09%3A56%3A17Z&amp;sr=c&amp;sp=w&amp;sig=hscQ7Su1nqd91OfMTwTkxabhJSaspx%2BD%2Fz8UqZAgn9s%3D
 http://phpstorage.blob.core.windows.net/phpazuretestshared1?st=2009-08-17T09%3A06%3A17Z&amp;se=2009-08-17T09%3A56%3A17Z&amp;sr=c&amp;sp=w&amp;sig=hscQ7Su1nqd91OfMTwTkxabhJSaspx%2BD%2Fz8UqZAgn9s%3D
             </literallayout>
             </literallayout>
-            
+
             <para>
             <para>
                 The above signature gives write access to the "phpazuretestshared1" "container" of
                 The above signature gives write access to the "phpazuretestshared1" "container" of
                 the phpstorage account. Since the shared key for the account is not known, the
                 the phpstorage account. Since the shared key for the account is not known, the
@@ -334,25 +338,26 @@ http://phpstorage.blob.core.windows.net/phpazuretestshared1?st=2009-08-17T09%3A0
                 <programlisting language="php"><![CDATA[
                 <programlisting language="php"><![CDATA[
 $storageClient = new Zend_Service_WindowsAzure_Storage_Blob(
 $storageClient = new Zend_Service_WindowsAzure_Storage_Blob(
     'blob.core.windows.net', 'phpstorage', ''
     'blob.core.windows.net', 'phpstorage', ''
-); 
-$storageClient->setCredentials( 
-    new Zend_Service_WindowsAzure_Credentials_SharedAccessSignature() 
 );
 );
-$storageClient->getCredentials()->setPermissionSet(array( 
-    'http://phpstorage.blob.core.windows.net/phpazuretestshared1?st=2009-08-17T09%3A06%3A17Z&se=2009-08-17T09%3A56%3A17Z&sr=c&sp=w&sig=hscQ7Su1nqd91OfMTwTkxabhJSaspx%2BD%2Fz8UqZAgn9s%3D' 
+$storageClient->setCredentials(
+    new Zend_Service_WindowsAzure_Credentials_SharedAccessSignature()
+);
+$storageClient->getCredentials()->setPermissionSet(array(
+    'http://phpstorage.blob.core.windows.net/phpazuretestshared1?st=2009-08-17T09%3A06%3A17Z&se=2009-08-17T09%3A56%3A17Z&sr=c&sp=w&sig=hscQ7Su1nqd91OfMTwTkxabhJSaspx%2BD%2Fz8UqZAgn9s%3D'
 ));
 ));
 $storageClient->putBlob(
 $storageClient->putBlob(
     'phpazuretestshared1', 'NewBlob.txt', 'C:\Files\dataforazure.txt'
     'phpazuretestshared1', 'NewBlob.txt', 'C:\Files\dataforazure.txt'
 );
 );
 ]]></programlisting>
 ]]></programlisting>
             </example>
             </example>
-            
+
             <para>
             <para>
                 Note that there was no explicit permission to write to a specific blob. Instead, the
                 Note that there was no explicit permission to write to a specific blob. Instead, the
-                Windows Azure SDK for PHP determined that a permission was required to either write
-                to that specific blob, or to write to its container. Since only a signature was
-                available for the latter, the Windows Azure SDK for PHP chose those credentials to
-                perform the request on Windows Azure blob storage.
+                Windows Azure <acronym>SDK</acronym> for <acronym>PHP</acronym> determined that a
+                permission was required to either write to that specific blob, or to write to its
+                container. Since only a signature was available for the latter, the Windows Azure
+                <acronym>SDK</acronym> for <acronym>PHP</acronym> chose those credentials to perform
+                the request on Windows Azure blob storage.
             </para>
             </para>
         </sect3>
         </sect3>
     </sect2>
     </sect2>