cdocutils.nodes document q)q}q(U nametypesq}q(X update imageqNXa note on schema classesqNXsetupqNXget image detailsq NXimagesq NX list imagesq NX delete imageq NuUsubstitution_defsq }qUparse_messagesq]qUcurrent_sourceqNU decorationqNUautofootnote_startqKUnameidsq}q(hU update-imageqhUa-note-on-schema-classesqhUsetupqh Uget-image-detailsqh Uimagesqh U list-imagesqh U delete-imagequUchildrenq]qcdocutils.nodes section q)q }q!(U rawsourceq"UUparentq#hUsourceq$XH/Users/jamie/projects/php/php-opencloud/doc/services/image/Images.md.rstq%Utagnameq&Usectionq'U attributesq(}q)(Udupnamesq*]Uclassesq+]Ubackrefsq,]Uidsq-]q.haUnamesq/]q0h auUlineq1KUdocumentq2hh]q3(cdocutils.nodes title q4)q5}q6(h"XImagesq7h#h h$h%h&Utitleq8h(}q9(h*]h+]h,]h-]h/]uh1Kh2hh]q:cdocutils.nodes Text q;XImagesq(h"h7h#h5ubaubcdocutils.nodes paragraph q?)q@}qA(h"XA virtual machine image is a single file which contains a virtual disk that has an installed bootable operating system. In the Cloud Images API, an image is represented by a JSON-encoded data structure (the image schema) and its raw binary data (the image file).qBh#h h$h%h&U paragraphqCh(}qD(h*]h+]h,]h-]h/]uh1Kh2hh]qEh;XA virtual machine image is a single file which contains a virtual disk that has an installed bootable operating system. In the Cloud Images API, an image is represented by a JSON-encoded data structure (the image schema) and its raw binary data (the image file).qFqG}qH(h"hBh#h@ubaubh?)qI}qJ(h"XHAn Image is represented by the ``OpenCloud\Image\Resource\Image`` class.qKh#h h$h%h&hCh(}qL(h*]h+]h,]h-]h/]uh1K h2hh]qM(h;XAn Image is represented by the qNqO}qP(h"XAn Image is represented by the h#hIubcdocutils.nodes literal qQ)qR}qS(h"X"``OpenCloud\Image\Resource\Image``h(}qT(h*]h+]h,]h-]h/]uh#hIh]qUh;XOpenCloud\Image\Resource\ImageqVqW}qX(h"Uh#hRubah&UliteralqYubh;X class.qZq[}q\(h"X class.h#hIubeubh)q]}q^(h"Uh#h h$h%h&h'h(}q_(h*]h+]h,]h-]q`hah/]qahauh1K h2hh]qb(h4)qc}qd(h"XSetupqeh#h]h$h%h&h8h(}qf(h*]h+]h,]h-]h/]uh1K h2hh]qgh;XSetupqhqi}qj(h"heh#hcubaubh?)qk}ql(h"XYou instantiate an Image object from its ``OpenCloud\Image\Service`` class, which is available from the OpenStack/Rackspace client:h#h]h$h%h&hCh(}qm(h*]h+]h,]h-]h/]uh1Kh2hh]qn(h;X)You instantiate an Image object from its qoqp}qq(h"X)You instantiate an Image object from its h#hkubhQ)qr}qs(h"X``OpenCloud\Image\Service``h(}qt(h*]h+]h,]h-]h/]uh#hkh]quh;XOpenCloud\Image\Serviceqvqw}qx(h"Uh#hrubah&hYubh;X? class, which is available from the OpenStack/Rackspace client:qyqz}q{(h"X? class, which is available from the OpenStack/Rackspace client:h#hkubeubcdocutils.nodes literal_block q|)q}}q~(h"X7$service = $client->imageService('cloudImages', 'IAD');h#h]h$h%h&U literal_blockqh(}q(U xml:spaceqUpreserveqh-]h,]h*]h+]q(UcodeqXphpqeh/]uh1Kh2hh]qcdocutils.nodes inline q)q}q(h"X7$service = $client->imageService('cloudImages', 'IAD');h(}q(h*]h+]qUotherqah,]h-]h/]uh#h}h]qh;X7$service = $client->imageService('cloudImages', 'IAD');qq}q(h"Uh#hubah&Uinlinequbaubh?)q}q(h"XhView the guides for more information about `clients <../Clients.md>`__ or `services <../Services.md>`__.h#h]h$h%h&hCh(}q(h*]h+]h,]h-]h/]uh1Kh2hh]q(h;X+View the guides for more information about qq}q(h"X+View the guides for more information about h#hubcdocutils.nodes reference q)q}q(h"X`clients <../Clients.md>`__h(}q(UnameXclientsUrefuriqX ../Clients.mdh-]h,]h*]h+]h/]uh#hh]qh;Xclientsqq}q(h"Uh#hubah&U referencequbh;X or qq}q(h"X or h#hubh)q}q(h"X`services <../Services.md>`__h(}q(UnameXserviceshX../Services.mdh-]h,]h*]h+]h/]uh#hh]qh;Xservicesqq}q(h"Uh#hubah&hubh;X.q}q(h"X.h#hubeubeubh)q}q(h"Uh#h h$h%h&h'h(}q(h*]h+]h,]h-]qhah/]qh auh1Kh2hh]q(h4)q}q(h"X List imagesqh#hh$h%h&h8h(}q(h*]h+]h,]h-]h/]uh1Kh2hh]qh;X List imagesqq}q(h"hh#hubaubh|)q}q(h"Xy$images = $service->listImages(); foreach ($images as $image) { /** @param $image OpenCloud\Image\Resource\Image */ }h#hh$h%h&hh(}q(hhh-]h,]h*]h+]q(hXphpqeh/]uh1K"h2hh]qh)q}q(h"Xy$images = $service->listImages(); foreach ($images as $image) { /** @param $image OpenCloud\Image\Resource\Image */ }h(}q(h*]h+]qUotherqah,]h-]h/]uh#hh]qh;Xy$images = $service->listImages(); foreach ($images as $image) { /** @param $image OpenCloud\Image\Resource\Image */ }qɅq}q(h"Uh#hubah&hubaubh?)q}q(h"XpFor more information about working with iterators, please see the `iterators documentation <../Iterators.md>`__.h#hh$h%h&hCh(}q(h*]h+]h,]h-]h/]uh1K#h2hh]q(h;XBFor more information about working with iterators, please see the qЅq}q(h"XBFor more information about working with iterators, please see the h#hubh)q}q(h"X-`iterators documentation <../Iterators.md>`__h(}q(UnameXiterators documentationhX../Iterators.mdh-]h,]h*]h+]h/]uh#hh]qh;Xiterators documentationqׅq}q(h"Uh#hubah&hubh;X.q}q(h"X.h#hubeubeubh)q}q(h"Uh#h h$h%h&h'h(}q(h*]h+]h,]h-]qhah/]qh auh1K'h2hh]q(h4)q}q(h"XGet image detailsqh#hh$h%h&h8h(}q(h*]h+]h,]h-]h/]uh1K'h2hh]qh;XGet image detailsq煁q}q(h"hh#hubaubh|)q}q(h"X^/** @param $image OpenCloud\Image\Resource\Image */ $image = $service->getImage('');h#hh$h%h&hh(}q(hhh-]h,]h*]h+]q(hXphpqeh/]uh1K-h2hh]qh)q}q(h"X^/** @param $image OpenCloud\Image\Resource\Image */ $image = $service->getImage('');h(}q(h*]h+]qUotherqah,]h-]h/]uh#hh]qh;X^/** @param $image OpenCloud\Image\Resource\Image */ $image = $service->getImage('');qq}q(h"Uh#hubah&hubaubh)q}q(h"Uh#hh$h%h&h'h(}q(h*]h+]h,]h-]qhah/]qhauh1K/h2hh]q(h4)q}r(h"XA note on schema classesrh#hh$h%h&h8h(}r(h*]h+]h,]h-]h/]uh1K/h2hh]rh;XA note on schema classesrr}r(h"jh#hubaubh?)r}r(h"XBoth ``OpenCloud\Image\Resource\Image`` and ``OpenCloud\Image\Resource\Member`` extend the ``AbstractSchemaResource`` abstract class, which offers some unique functionality.h#hh$h%h&hCh(}r (h*]h+]h,]h-]h/]uh1K1h2hh]r (h;XBoth r r }r (h"XBoth h#jubhQ)r}r(h"X"``OpenCloud\Image\Resource\Image``h(}r(h*]h+]h,]h-]h/]uh#jh]rh;XOpenCloud\Image\Resource\Imagerr}r(h"Uh#jubah&hYubh;X and rr}r(h"X and h#jubhQ)r}r(h"X#``OpenCloud\Image\Resource\Member``h(}r(h*]h+]h,]h-]h/]uh#jh]rh;XOpenCloud\Image\Resource\Memberrr}r(h"Uh#jubah&hYubh;X extend the rr }r!(h"X extend the h#jubhQ)r"}r#(h"X``AbstractSchemaResource``h(}r$(h*]h+]h,]h-]h/]uh#jh]r%h;XAbstractSchemaResourcer&r'}r((h"Uh#j"ubah&hYubh;X8 abstract class, which offers some unique functionality.r)r*}r+(h"X8 abstract class, which offers some unique functionality.h#jubeubh?)r,}r-(h"XBecause these resources are inherently dynamic - i.e. they are modelled on dynamic JSON schema - you need to access their state in a way different than conventional getter/setter methods, and even class properties. For this reason, they implement SPL's native ```ArrayAccess`` `__ interface which allows you to access their state as a conventional array:h#hh$h%h&hCh(}r.(h*]h+]h,]h-]h/]uh1K6h2hh]r/(h;XBecause these resources are inherently dynamic - i.e. they are modelled on dynamic JSON schema - you need to access their state in a way different than conventional getter/setter methods, and even class properties. For this reason, they implement SPL's native r0r1}r2(h"XBecause these resources are inherently dynamic - i.e. they are modelled on dynamic JSON schema - you need to access their state in a way different than conventional getter/setter methods, and even class properties. For this reason, they implement SPL's native h#j,ubhQ)r3}r4(h"X```ArrayAccess``h(}r5(h*]h+]h,]h-]h/]uh#j,h]r6h;X `ArrayAccessr7r8}r9(h"Uh#j3ubah&hYubh;X (h"X2http://www.php.net/manual/en/class.arrayaccess.phpr?h(}r@(Urefurij?h-]h,]h*]h+]h/]uh#j,h]rAh;X2http://www.php.net/manual/en/class.arrayaccess.phprBrC}rD(h"Uh#j=ubah&hubh;XN>`__ interface which allows you to access their state as a conventional array:rErF}rG(h"XN>`__ interface which allows you to access their state as a conventional array:h#j,ubeubh|)rH}rI(h"XW$image = $service->getImage(''); $id = $image['id']; $tags = $image['tags'];h#hh$h%h&hh(}rJ(hhh-]h,]h*]h+]rK(hXphprLeh/]uh1KDh2hh]rMh)rN}rO(h"XW$image = $service->getImage(''); $id = $image['id']; $tags = $image['tags'];h(}rP(h*]h+]rQUotherrRah,]h-]h/]uh#jHh]rSh;XW$image = $service->getImage(''); $id = $image['id']; $tags = $image['tags'];rTrU}rV(h"Uh#jNubah&hubaubeubeubh)rW}rX(h"Uh#h h$h%h&h'h(}rY(h*]h+]h,]h-]rZhah/]r[hauh1KFh2hh]r\(h4)r]}r^(h"X Update imager_h#jWh$h%h&h8h(}r`(h*]h+]h,]h-]h/]uh1KFh2hh]rah;X Update imagerbrc}rd(h"j_h#j]ubaubh?)re}rf(h"XYou can only update your own custom images - you cannot update or delete base images. The way in which you may update your image is dictated by its `schema `__.h#jWh$h%h&hCh(}rg(h*]h+]h,]h-]h/]uh1KHh2hh]rh(h;XYou can only update your own custom images - you cannot update or delete base images. The way in which you may update your image is dictated by its rirj}rk(h"XYou can only update your own custom images - you cannot update or delete base images. The way in which you may update your image is dictated by its h#jeubh)rl}rm(h"X`schema `__h(}rn(UnameXschemahX Schemas.mdh-]h,]h*]h+]h/]uh#jeh]roh;Xschemarprq}rr(h"Uh#jlubah&hubh;X.rs}rt(h"X.h#jeubeubh?)ru}rv(h"XAlthough you should be able to add new and replace existing properties, always prepare yourself for a situation where it might be forbidden:rwh#jWh$h%h&hCh(}rx(h*]h+]h,]h-]h/]uh1KLh2hh]ryh;XAlthough you should be able to add new and replace existing properties, always prepare yourself for a situation where it might be forbidden:rzr{}r|(h"jwh#juubaubh|)r}}r~(h"Xuse OpenCloud\Common\Exceptions\ForbiddenOperationException; try { $image->update(array( 'name' => 'foo', 'newProperty' => 'bar' )); } catch (ForbiddenOperationException $e) { // A 403 Forbidden was returned }h#jWh$h%h&hh(}r(hhh-]h,]h*]h+]r(hXphpreh/]uh1K[h2hh]rh)r}r(h"Xuse OpenCloud\Common\Exceptions\ForbiddenOperationException; try { $image->update(array( 'name' => 'foo', 'newProperty' => 'bar' )); } catch (ForbiddenOperationException $e) { // A 403 Forbidden was returned }h(}r(h*]h+]rUotherrah,]h-]h/]uh#j}h]rh;Xuse OpenCloud\Common\Exceptions\ForbiddenOperationException; try { $image->update(array( 'name' => 'foo', 'newProperty' => 'bar' )); } catch (ForbiddenOperationException $e) { // A 403 Forbidden was returned }rr}r(h"Uh#jubah&hubaubh?)r}r(h"XGThere are three operations that can take place for each Image property:rh#jWh$h%h&hCh(}r(h*]h+]h,]h-]h/]uh1K\h2hh]rh;XGThere are three operations that can take place for each Image property:rr}r(h"jh#jubaubcdocutils.nodes bullet_list r)r}r(h"Uh#jWh$h%h&U bullet_listrh(}r(UbulletrX-h-]h,]h*]h+]h/]uh1K^h2hh]r(cdocutils.nodes list_item r)r}r(h"X}If a ``false`` or ``null`` value is provided, a ``REMOVE`` operation will occur, removing the property from the JSON documenth#jh$h%h&U list_itemrh(}r(h*]h+]h,]h-]h/]uh1Nh2hh]rh?)r}r(h"X}If a ``false`` or ``null`` value is provided, a ``REMOVE`` operation will occur, removing the property from the JSON documenth#jh$h%h&hCh(}r(h*]h+]h,]h-]h/]uh1K^h]r(h;XIf a rr}r(h"XIf a h#jubhQ)r}r(h"X ``false``h(}r(h*]h+]h,]h-]h/]uh#jh]rh;Xfalserr}r(h"Uh#jubah&hYubh;X or rr}r(h"X or h#jubhQ)r}r(h"X``null``h(}r(h*]h+]h,]h-]h/]uh#jh]rh;Xnullrr}r(h"Uh#jubah&hYubh;X value is provided, a rr}r(h"X value is provided, a h#jubhQ)r}r(h"X ``REMOVE``h(}r(h*]h+]h,]h-]h/]uh#jh]rh;XREMOVErr}r(h"Uh#jubah&hYubh;XC operation will occur, removing the property from the JSON documentrr}r(h"XC operation will occur, removing the property from the JSON documenth#jubeubaubj)r}r(h"XrIf a non-false value is provided and the property does not exist, an ``ADD`` operation will add it to the documenth#jh$h%h&jh(}r(h*]h+]h,]h-]h/]uh1Nh2hh]rh?)r}r(h"XrIf a non-false value is provided and the property does not exist, an ``ADD`` operation will add it to the documenth#jh$h%h&hCh(}r(h*]h+]h,]h-]h/]uh1K`h]r(h;XEIf a non-false value is provided and the property does not exist, an rr}r(h"XEIf a non-false value is provided and the property does not exist, an h#jubhQ)r}r(h"X``ADD``h(}r(h*]h+]h,]h-]h/]uh#jh]rh;XADDrr}r(h"Uh#jubah&hYubh;X& operation will add it to the documentrr}r(h"X& operation will add it to the documenth#jubeubaubj)r}r(h"XIf a non-false value is provided and the property does exist, a ``REPLACE`` operation will modify the property in the document h#jh$h%h&jh(}r(h*]h+]h,]h-]h/]uh1Nh2hh]rh?)r}r(h"X~If a non-false value is provided and the property does exist, a ``REPLACE`` operation will modify the property in the documenth#jh$h%h&hCh(}r(h*]h+]h,]h-]h/]uh1Kbh]r(h;X@If a non-false value is provided and the property does exist, a rr}r(h"X@If a non-false value is provided and the property does exist, a h#jubhQ)r}r(h"X ``REPLACE``h(}r(h*]h+]h,]h-]h/]uh#jh]rh;XREPLACErr}r(h"Uh#jubah&hYubh;X3 operation will modify the property in the documentrr}r(h"X3 operation will modify the property in the documenth#jubeubaubeubeubh)r}r(h"Uh#h h$h%h&h'h(}r(h*]h+]h,]h-]rhah/]rh auh1Kfh2hh]r(h4)r}r(h"X Delete imagerh#jh$h%h&h8h(}r(h*]h+]h,]h-]h/]uh1Kfh2hh]rh;X Delete imagerr}r(h"jh#jubaubh|)r}r(h"X$image->delete();h#jh$h%h&hh(}r(hhh-]h,]h*]h+]r(hXphpreh/]uh1Kkh2hh]rh)r}r(h"X$image->delete();h(}r(h*]h+]rUotherrah,]h-]h/]uh#jh]r h;X$image->delete();r r }r (h"Uh#jubah&hubaubeubeubah"UU transformerr NU footnote_refsr}rUrefnamesr}rUsymbol_footnotesr]rUautofootnote_refsr]rUsymbol_footnote_refsr]rU citationsr]rh2hU current_linerNUtransform_messagesr]rUreporterrNUid_startrKU 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_backlinksr0Uentryr1U language_coder2Uenr3U datestampr4NU report_levelr5KU _destinationr6NU halt_levelr7KU strip_classesr8Nh8NUerror_encoding_error_handlerr9Ubackslashreplacer:Udebugr;NUembed_stylesheetr<Uoutput_encoding_error_handlerr=Ustrictr>U sectnum_xformr?KUdump_transformsr@NU docinfo_xformrAKUwarning_streamrBNUpep_file_url_templaterCUpep-%04drDUexit_status_levelrEKUconfigrFNUstrict_visitorrGNUcloak_email_addressesrHUtrim_footnote_reference_spacerIUenvrJNUdump_pseudo_xmlrKNUexpose_internalsrLNUsectsubtitle_xformrMU source_linkrNNUrfc_referencesrONUoutput_encodingrPUutf-8rQU source_urlrRNUinput_encodingrSU utf-8-sigrTU_disable_configrUNU id_prefixrVUU tab_widthrWKUerror_encodingrXUUTF-8rYU_sourcerZh%Ugettext_compactr[U generatorr\NUdump_internalsr]NU smart_quotesr^U pep_base_urlr_Uhttp://www.python.org/dev/peps/r`Usyntax_highlightraUlongrbUinput_encoding_error_handlerrcj>Uauto_id_prefixrdUidreUdoctitle_xformrfUstrip_elements_with_classesrgNU _config_filesrh]Ufile_insertion_enabledriU raw_enabledrjKU dump_settingsrkNubUsymbol_footnote_startrlKUidsrm}rn(hjhhhjWhhhh]hh hhuUsubstitution_namesro}rph&h2h(}rq(h*]h-]h,]Usourceh%h+]h/]uU footnotesrr]rsUrefidsrt}ruub.