Changeset 6959

Show
Ignore:
Timestamp:
08/30/07 03:11:39 (1 year ago)
Author:
nicobn
Message:

Added the Create key section in the unified registry section

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • doc/jaws2/en/books/internals/coress/sections/registry/normalkeys.xml

    r6958 r6959  
    157157   <para> 
    158158    <methodsynopsis> 
    159      <classname>Jaws_Registry_Key</classname><methodname>Jaws::getSubkey</methodname> 
     159     <classname>Jaws_Registry_Key</classname><methodname>Jaws_Registry::getSubkey</methodname> 
    160160     <methodparam><type>string</type><parameter>$name</parameter></methodparam> 
    161161    </methodsynopsis> 
    …… 
    312312  <para> 
    313313   To delete a key from the database, you must explicitly call the 
    314    <methodname>Jaws::deleteKey</methodname> method on the key itself. 
     314   <methodname>Jaws_Registry_Key::deleteKey</methodname> method on the key  
     315   itself. 
    315316  </para> 
    316317   
    …… 
    319320   <para> 
    320321    <methodsynopsis> 
    321      <type>void</type>><methodname>Jaws::deleteKey</methodname> 
     322     <type>void</type>><methodname>Jaws_Registry_Key::deleteKey</methodname> 
    322323     <void /> 
    323324    </methodsynopsis> 
    …… 
    355356   <para> 
    356357    <methodsynopsis> 
    357      <type>void</type>><methodname>Jaws::moveKey</methodname> 
     358     <type>void</type>><methodname>Jaws_Registry_Key::moveKey</methodname> 
    358359     <methodparam> 
    359360      <type>Jaws_Registry_Key</type><parameter>$newparent</parameter> 

  • doc/jaws2/en/books/internals/coress/sections/registry/unified.xml

    r6945 r6959  
    88<sect3> 
    99 <title>Unified registry interface</title> 
     10 <para> 
     11  The unified registry interface was designed to give an unique access point for 
     12  key by key operation. This is useful if you want to get a precise key or wish 
     13  to work with registry paths. The unified registry interface offers some 
     14  basic operations that will be explained in this section. 
     15 </para> 
     16  
     17 <para> 
     18  All the methods of the interface are accessible through the  
     19  <varname>Jaws::$Registry</varname> object. 
     20 </para> 
     21  
     22 <sect4> 
     23  <title>Create a key</title> 
     24  <para> 
     25   It is fairly easy to create a key with the unified interface. All you need to 
     26   provide is the registry path and the key type.  
     27  </para> 
     28 
     29  <sect5> 
     30   &reftitle.prototype; 
     31   <para> 
     32    <methodsynopsis> 
     33     <type>Jaws_Registry_Key</type>><methodname>Jaws_Registry::createKey</methodname> 
     34     <methodparam><type>string</type><parameter>$regpath</parameter> 
     35     <methodparam><type>int</type><parameter>$type</parameter> 
     36     </methodparam> 
     37    </methodsynopsis> 
     38   </para> 
     39  </sect5> 
     40     
     41  <para> 
     42   <variablelist> 
     43    <varlistentry> 
     44     <term><parameter>$regpath</parameter></term> 
     45     <listitem> 
     46      The registry path of the new key. 
     47     </listitem> 
     48    </varlistentry> 
     49   </variablelist> 
     50  </para>    
     51 
     52  <para>  
     53   Here is an example of usage. 
     54   <example> 
     55    <programlisting role="php">     
     56<![CDATA[ 
     57$root = Jaws::$Registry->createKey('\jaws', TYPE_FOLDER); 
     58$key = Jaws::$Registry->createKey('\jaws\foo', TYPE_INT); 
     59 
     60echo $key->getParent()->getName(); 
     61]]> 
     62    </programlisting> 
     63   </example> 
     64  </para> 
     65   
     66  <para> 
     67   This example creates the <literal>\jaws</literal> root key and the integer 
     68   <literal>\jaws\foo</literal> key and prints its parent, which will be  
     69   <literal>jaws</literal>. 
     70  </para> 
     71 </sect4> 
     72 
     73 <sect4> 
     74  <title>Move a key</title> 
     75 </sect4> 
     76 
     77 <sect4> 
     78  <title>Delete a key</title> 
     79 </sect4> 
     80 
     81 <sect4> 
     82  <title>Access a key</title> 
     83 </sect4> 
    1084</sect3>