€cdocutils.nodes document q)q}q(U nametypesq}q(Xgetting startedqNXC3. create a container for your objects (also referred to as files).qNX object storeqNX%4. upload an object to the container.q NX next stepsq NX01. instantiate an openstack or rackspace client.q NX92. obtain an object store service object from the client.q NuUsubstitution_defsq }qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hUgetting-startedqhU=create-a-container-for-your-objects-also-referred-to-as-filesqhU object-storeqh U!upload-an-object-to-the-containerqh U next-stepsqh U,instantiate-an-openstack-or-rackspace-clientqh U5obtain-an-object-store-service-object-from-the-clientquUchildrenq]qcdocutils.nodes section q)q }q!(U rawsourceq"UUparentq#hUsourceq$XO/Users/jamie/projects/php/php-opencloud/doc/services/object-store/README.md.rstq%Utagnameq&Usectionq'U attributesq(}q)(Udupnamesq*]Uclassesq+]Ubackrefsq,]Uidsq-]q.haUnamesq/]q0hauUlineq1KUdocumentq2hh]q3(cdocutils.nodes title q4)q5}q6(h"X Object Storeq7h#h h$h%h&Utitleq8h(}q9(h*]h+]h,]h-]h/]uh1Kh2hh]q:cdocutils.nodes Text q;X Object Storeq<…q=}q>(h"h7h#h5ubaubcdocutils.nodes paragraph q?)q@}qA(h"Xj**Object Store** is an object-based storage system that stores content and metadata as objects in a cloud.h#h h$h%h&U paragraphqBh(}qC(h*]h+]h,]h-]h/]uh1Kh2hh]qD(cdocutils.nodes strong qE)qF}qG(h"X**Object Store**h(}qH(h*]h+]h,]h-]h/]uh#h@h]qIh;X Object StoreqJ…qK}qL(h"Uh#hFubah&UstrongqMubh;XZ is an object-based storage system that stores content and metadata as objects in a cloud.qN…qO}qP(h"XZ is an object-based storage system that stores content and metadata as objects in a cloud.h#h@ubeubh?)qQ}qR(h"XáSpecifically, a cloud is made up of one or more regions. Each region can have several **containers**, created by a user. Each container can container several **objects** (sometimes referred to as files), uploaded by the user.h#h h$h%h&hBh(}qS(h*]h+]h,]h-]h/]uh1Kh2hh]qT(h;XVSpecifically, a cloud is made up of one or more regions. Each region can have several qU…qV}qW(h"XVSpecifically, a cloud is made up of one or more regions. Each region can have several h#hQubhE)qX}qY(h"X**containers**h(}qZ(h*]h+]h,]h-]h/]uh#hQh]q[h;X containersq\…q]}q^(h"Uh#hXubah&hMubh;X:, created by a user. Each container can container several q_…q`}qa(h"X:, created by a user. Each container can container several h#hQubhE)qb}qc(h"X **objects**h(}qd(h*]h+]h,]h-]h/]uh#hQh]qeh;Xobjectsqf…qg}qh(h"Uh#hbubah&hMubh;X8 (sometimes referred to as files), uploaded by the user.qi…qj}qk(h"X8 (sometimes referred to as files), uploaded by the user.h#hQubeubh)ql}qm(h"Uh#h h$h%h&h'h(}qn(h*]h+]h,]h-]qohah/]qphauh1K h2hh]qq(h4)qr}qs(h"XGetting startedqth#hlh$h%h&h8h(}qu(h*]h+]h,]h-]h/]uh1K h2hh]qvh;XGetting startedqw…qx}qy(h"hth#hrubaubh)qz}q{(h"Uh#hlh$h%h&h'h(}q|(h*]h+]h,]h-]q}hah/]q~h auh1Kh2hh]q(h4)q€}q(h"X01. Instantiate an OpenStack or Rackspace client.q‚h#hzh$h%h&h8h(}qƒ(h*]h+]h,]h-]h/]uh1Kh2hh]q„h;X01. Instantiate an OpenStack or Rackspace client.q……q†}q‡(h"h‚h#h€ubaubh?)qˆ}q‰(h"X(Choose one of the following two options:qŠh#hzh$h%h&hBh(}q‹(h*]h+]h,]h-]h/]uh1Kh2hh]qŒh;X(Choose one of the following two options:q…qŽ}q(h"hŠh#hˆubaubcdocutils.nodes bullet_list q)q‘}q’(h"Uh#hzh$h%h&U bullet_listq“h(}q”(Ubulletq•X-h-]h,]h*]h+]h/]uh1Kh2hh]q–(cdocutils.nodes list_item q—)q˜}q™(h"X^If you are working with a vanilla OpenStack cloud, instantiate an ``OpenCloud\OpenStack`` client as shown below. .. code:: php use OpenCloud\OpenStack; $client = new OpenStack('', array( 'username' => '', 'password' => '' )); h#h‘h$Nh&U list_itemqšh(}q›(h*]h+]h,]h-]h/]uh1Nh2hh]qœ(h?)q}qž(h"XpIf you are working with a vanilla OpenStack cloud, instantiate an ``OpenCloud\OpenStack`` client as shown below.h#h˜h$h%h&hBh(}qŸ(h*]h+]h,]h-]h/]uh1Kh]q (h;XBIf you are working with a vanilla OpenStack cloud, instantiate an q¡…q¢}q£(h"XBIf you are working with a vanilla OpenStack cloud, instantiate an h#hubcdocutils.nodes literal q¤)q¥}q¦(h"X``OpenCloud\OpenStack``h(}q§(h*]h+]h,]h-]h/]uh#hh]q¨h;XOpenCloud\OpenStackq©…qª}q«(h"Uh#h¥ubah&Uliteralq¬ubh;X client as shown below.q­…q®}q¯(h"X client as shown below.h#hubeubcdocutils.nodes literal_block q°)q±}q²(h"XÈuse OpenCloud\OpenStack; $client = new OpenStack('', array( 'username' => '', 'password' => '' ));h(}q³(U xml:spaceq´Upreserveqµh-]h,]h*]h+]q¶(Ucodeq·Xphpq¸eh/]uh#h˜h]q¹cdocutils.nodes inline qº)q»}q¼(h"XÈuse OpenCloud\OpenStack; $client = new OpenStack('', array( 'username' => '', 'password' => '' ));h(}q½(h*]h+]q¾Uotherq¿ah,]h-]h/]uh#h±h]qÀh;XÈuse OpenCloud\OpenStack; $client = new OpenStack('', array( 'username' => '', 'password' => '' ));qÁ…qÂ}qÃ(h"Uh#h»ubah&UinlineqÄubah&U literal_blockqÅubeubh—)qÆ}qÇ(h"XeIf you are working with the Rackspace cloud, instantiate a ``OpenCloud\Rackspace`` client as shown below. .. code:: php use OpenCloud\Rackspace; $client = new Rackspace(Rackspace::US_IDENTITY_ENDPOINT, array( 'username' => '', 'apiKey' => '' )); h#h‘h$Nh&hšh(}qÈ(h*]h+]h,]h-]h/]uh1Nh2hh]qÉ(h?)qÊ}qË(h"XiIf you are working with the Rackspace cloud, instantiate a ``OpenCloud\Rackspace`` client as shown below.h#hÆh$h%h&hBh(}qÌ(h*]h+]h,]h-]h/]uh1K h]qÍ(h;X;If you are working with the Rackspace cloud, instantiate a qÎ…qÏ}qÐ(h"X;If you are working with the Rackspace cloud, instantiate a h#hÊubh¤)qÑ}qÒ(h"X``OpenCloud\Rackspace``h(}qÓ(h*]h+]h,]h-]h/]uh#hÊh]qÔh;XOpenCloud\RackspaceqÕ…qÖ}q×(h"Uh#hÑubah&h¬ubh;X client as shown below.qØ…qÙ}qÚ(h"X client as shown below.h#hÊubeubh°)qÛ}qÜ(h"XÖuse OpenCloud\Rackspace; $client = new Rackspace(Rackspace::US_IDENTITY_ENDPOINT, array( 'username' => '', 'apiKey' => '' ));h(}qÝ(h´hµh-]h,]h*]h+]qÞ(h·Xphpqßeh/]uh#hÆh]qàhº)qá}qâ(h"XÖuse OpenCloud\Rackspace; $client = new Rackspace(Rackspace::US_IDENTITY_ENDPOINT, array( 'username' => '', 'apiKey' => '' ));h(}qã(h*]h+]qäUotherqåah,]h-]h/]uh#hÛh]qæh;XÖuse OpenCloud\Rackspace; $client = new Rackspace(Rackspace::US_IDENTITY_ENDPOINT, array( 'username' => '', 'apiKey' => '' ));qç…qè}qé(h"Uh#háubah&hÄubah&hÅubeubeubeubh)qê}që(h"Uh#hlh$h%h&h'h(}qì(h*]h+]h,]h-]qíhah/]qîh auh1K-h2hh]qï(h4)qð}qñ(h"X92. Obtain an Object Store service object from the client.qòh#hêh$h%h&h8h(}qó(h*]h+]h,]h-]h/]uh1K-h2hh]qôh;X92. Obtain an Object Store service object from the client.qõ…qö}q÷(h"hòh#hðubaubh°)qø}qù(h"XR$region = 'DFW'; $objectStoreService = $client->objectStoreService(null, $region);h#hêh$h%h&hÅh(}qú(h´hµh-]h,]h*]h+]qû(h·Xphpqüeh/]uh1K3h2hh]qýhº)qþ}qÿ(h"XR$region = 'DFW'; $objectStoreService = $client->objectStoreService(null, $region);h(}r(h*]h+]rUotherrah,]h-]h/]uh#høh]rh;XR$region = 'DFW'; $objectStoreService = $client->objectStoreService(null, $region);r…r}r(h"Uh#hþubah&hÄubaubh?)r}r(h"X¿In the example above, you are connecting to the ``DFW`` region of the cloud. Any containers and objects created with this ``$objectStoreService`` instance will be stored in that cloud region.h#hêh$h%h&hBh(}r (h*]h+]h,]h-]h/]uh1K4h2hh]r (h;X0In the example above, you are connecting to the r …r }r (h"X0In the example above, you are connecting to the h#jubh¤)r}r(h"X``DFW``h(}r(h*]h+]h,]h-]h/]uh#jh]rh;XDFWr…r}r(h"Uh#jubah&h¬ubh;XC region of the cloud. Any containers and objects created with this r…r}r(h"XC region of the cloud. Any containers and objects created with this h#jubh¤)r}r(h"X``$objectStoreService``h(}r(h*]h+]h,]h-]h/]uh#jh]rh;X$objectStoreServicer…r}r(h"Uh#jubah&h¬ubh;X. instance will be stored in that cloud region.r…r }r!(h"X. instance will be stored in that cloud region.h#jubeubeubh)r"}r#(h"Uh#hlh$h%h&h'h(}r$(h*]h+]h,]h-]r%hah/]r&hauh1K9h2hh]r'(h4)r(}r)(h"XC3. Create a container for your objects (also referred to as files).r*h#j"h$h%h&h8h(}r+(h*]h+]h,]h-]h/]uh1K9h2hh]r,h;XC3. Create a container for your objects (also referred to as files).r-…r.}r/(h"j*h#j(ubaubh°)r0}r1(h"X($container = $objectStoreService->createContainer('logos'); **Note:** when working with names that contain non-standard alphanumerical characters (such as spaces or non-English characters), you must ensure they are encoded with ```urlencode`` `__ before passing them inh#j"h$h%h&hÅh(}r2(h´hµh-]h,]h*]h+]r3(h·Xphpr4eh/]uh1KCh2hh]r5hº)r6}r7(h"X($container = $objectStoreService->createContainer('logos'); **Note:** when working with names that contain non-standard alphanumerical characters (such as spaces or non-English characters), you must ensure they are encoded with ```urlencode`` `__ before passing them inh(}r8(h*]h+]r9Uotherr:ah,]h-]h/]uh#j0h]r;h;X($container = $objectStoreService->createContainer('logos'); **Note:** when working with names that contain non-standard alphanumerical characters (such as spaces or non-English characters), you must ensure they are encoded with ```urlencode`` `__ before passing them inr<…r=}r>(h"Uh#j6ubah&hÄubaubeubh)r?}r@(h"Uh#hlh$h%h&h'h(}rA(h*]h+]h,]h-]rBhah/]rCh auh1KEh2hh]rD(h4)rE}rF(h"X%4. Upload an object to the container.rGh#j?h$h%h&h8h(}rH(h*]h+]h,]h-]h/]uh1KEh2hh]rIh;X%4. Upload an object to the container.rJ…rK}rL(h"jGh#jEubaubh°)rM}rN(h"X¹$localFileName = '/path/to/local/php-elephant.jpg'; $remoteFileName = 'php-elephant.jpg'; $fileData = fopen($localFileName, 'r'); $container->uploadObject($remoteFileName, $fileData);h#j?h$h%h&hÅh(}rO(h´hµh-]h,]h*]h+]rP(h·XphprQeh/]uh1KNh2hh]rRhº)rS}rT(h"X¹$localFileName = '/path/to/local/php-elephant.jpg'; $remoteFileName = 'php-elephant.jpg'; $fileData = fopen($localFileName, 'r'); $container->uploadObject($remoteFileName, $fileData);h(}rU(h*]h+]rVUotherrWah,]h-]h/]uh#jMh]rXh;X¹$localFileName = '/path/to/local/php-elephant.jpg'; $remoteFileName = 'php-elephant.jpg'; $fileData = fopen($localFileName, 'r'); $container->uploadObject($remoteFileName, $fileData);rY…rZ}r[(h"Uh#jSubah&hÄubaubh?)r\}r](h"X\[ `Get the executable PHP script for this example `__ ]h#j?h$h%h&hBh(}r^(h*]h+]h,]h-]h/]uh1KOh2hh]r_(h;X[ r`…ra}rb(h"X[ h#j\ubcdocutils.nodes reference rc)rd}re(h"XX`Get the executable PHP script for this example `__h(}rf(UnameX.Get the executable PHP script for this exampleUrefurirgX#/samples/ObjectStore/quickstart.phph-]h,]h*]h+]h/]uh#j\h]rhh;X.Get the executable PHP script for this exampleri…rj}rk(h"Uh#jdubah&U referencerlubh;X ]rm…rn}ro(h"X ]h#j\ubeubeubeubh)rp}rq(h"Uh#h h$h%h&h'h(}rr(h*]h+]h,]h-]rshah/]rth auh1KSh2hh]ru(h4)rv}rw(h"X Next stepsrxh#jph$h%h&h8h(}ry(h*]h+]h,]h-]h/]uh1KSh2hh]rzh;X Next stepsr{…r|}r}(h"jxh#jvubaubh?)r~}r(h"X‡There is a lot more you can do with containers and objects. See the `complete user guide to the Object Store service `__.h#jph$h%h&hBh(}r€(h*]h+]h,]h-]h/]uh1KUh2hh]r(h;XDThere is a lot more you can do with containers and objects. See the r‚…rƒ}r„(h"XDThere is a lot more you can do with containers and objects. See the h#j~ubjc)r…}r†(h"XB`complete user guide to the Object Store service `__h(}r‡(UnameX/complete user guide to the Object Store servicejgX USERGUIDE.mdh-]h,]h*]h+]h/]uh#j~h]rˆh;X/complete user guide to the Object Store servicer‰…rŠ}r‹(h"Uh#j…ubah&jlubh;X.…rŒ}r(h"X.h#j~ubeubeubeubah"UU transformerrŽNU footnote_refsr}rUrefnamesr‘}r’Usymbol_footnotesr“]r”Uautofootnote_refsr•]r–Usymbol_footnote_refsr—]r˜U citationsr™]ršh2hU current_liner›NUtransform_messagesrœ]rUreporterržNUid_startrŸKU autofootnotesr ]r¡U citation_refsr¢}r£Uindirect_targetsr¤]r¥Usettingsr¦(cdocutils.frontend Values r§or¨}r©(Ufootnote_backlinksrªKUrecord_dependenciesr«NU rfc_base_urlr¬Uhttp://tools.ietf.org/html/r­U tracebackr®ˆUpep_referencesr¯NUstrip_commentsr°NU toc_backlinksr±Uentryr²U language_coder³Uenr´U datestamprµNU report_levelr¶KU _destinationr·NU halt_levelr¸KU strip_classesr¹Nh8NUerror_encoding_error_handlerrºUbackslashreplacer»Udebugr¼NUembed_stylesheetr½‰Uoutput_encoding_error_handlerr¾Ustrictr¿U sectnum_xformrÀKUdump_transformsrÁNU docinfo_xformrÂKUwarning_streamrÃNUpep_file_url_templaterÄUpep-%04drÅUexit_status_levelrÆKUconfigrÇNUstrict_visitorrÈNUcloak_email_addressesrɈUtrim_footnote_reference_spacerʉUenvrËNUdump_pseudo_xmlrÌNUexpose_internalsrÍNUsectsubtitle_xformrΉU source_linkrÏNUrfc_referencesrÐNUoutput_encodingrÑUutf-8rÒU source_urlrÓNUinput_encodingrÔU utf-8-sigrÕU_disable_configrÖNU id_prefixr×UU tab_widthrØKUerror_encodingrÙUUTF-8rÚU_sourcerÛh%Ugettext_compactr܈U generatorrÝNUdump_internalsrÞNU smart_quotesr߉U pep_base_urlràUhttp://www.python.org/dev/peps/ráUsyntax_highlightrâUlongrãUinput_encoding_error_handlerräj¿Uauto_id_prefixråUidræUdoctitle_xformrç‰Ustrip_elements_with_classesrèNU _config_filesré]rêUfile_insertion_enabledrëˆU raw_enabledrìKU dump_settingsríNubUsymbol_footnote_startrîKUidsrï}rð(hhlhhzhjphhêhh hj?hj"uUsubstitution_namesrñ}ròh&h2h(}ró(h*]h-]h,]Usourceh%h+]h/]uU footnotesrô]rõUrefidsrö}r÷ub.