/doc/source/_templates/sphinxdoc/examples/animals.html

https://github.com/riquito/Baobab · HTML · 124 lines · 102 code · 22 blank · 0 comment · 0 complexity · 9e58846c8f9e9ec75d225f4e7feee8b5 MD5 · raw file 

    

  1. <div class="highlight"><pre><span class="cp">&lt;?php</span>
    2. 

  2. 

  3. <span class="k">class</span> <span class="nc">AnimalsBaobab</span> <span class="k">extends</span> <span class="nx">Baobab</span> <span class="p">{</span>
    4. 

  4.     
    5. 

  5.     <span class="c1">// override build function to create the table the way we want it</span>
    6. 

  6.     <span class="k">public</span> <span class="k">function</span> <span class="nf">build</span><span class="p">()</span> <span class="p">{</span>
    7. 

  7.         <span class="k">if</span> <span class="p">(</span><span class="k">parent</span><span class="o">::</span><span class="na">build</span><span class="p">())</span> <span class="p">{</span> <span class="c1">// the table wasn&#39;t existing and has been built</span>
    8. 

  8.             
    9. 

  9.             <span class="nv">$result</span> <span class="o">=</span> <span class="nv">$this</span><span class="o">-&gt;</span><span class="na">db</span><span class="o">-&gt;</span><span class="na">query</span><span class="p">(</span><span class="s2">&quot;</span>
    10. 

  10. <span class="s2">                ALTER TABLE </span><span class="si">{</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">forest_name</span><span class="si">}</span><span class="s2"></span>
    11. 

  11. <span class="s2">                ADD COLUMN name VARCHAR(50) NOT NULL</span>
    12. 

  12. <span class="s2">                &quot;</span>
    13. 

  13.             <span class="p">);</span>
    14. 

  14.             <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nv">$result</span><span class="p">)</span> <span class="k">throw</span> <span class="k">new</span> <span class="nx">sp_MySQL_Error</span><span class="p">(</span><span class="nv">$this</span><span class="o">-&gt;</span><span class="na">db</span><span class="p">);</span>
    15. 

  15.         <span class="p">}</span>
    16. 

  16.     <span class="p">}</span>
    17. 

  17. <span class="p">}</span>
    18. 

  18. 

  19. <span class="k">function</span> <span class="nf">start_over</span><span class="p">(</span><span class="nv">$conn</span><span class="p">,</span><span class="nv">$forestName</span><span class="p">){</span>
    20. 

  20.     <span class="nv">$tree</span><span class="o">=</span><span class="k">new</span> <span class="nx">AnimalsBaobab</span><span class="p">(</span><span class="nv">$conn</span><span class="p">,</span><span class="nv">$forestName</span><span class="p">);</span>
    21. 

  21.     <span class="nv">$tree</span><span class="o">-&gt;</span><span class="na">destroy</span><span class="p">(</span><span class="k">TRUE</span><span class="p">);</span>
    22. 

  22.     <span class="nv">$tree</span><span class="o">-&gt;</span><span class="na">build</span><span class="p">();</span>
    23. 

  23. <span class="p">}</span>
    24. 

  24. 

  25. <span class="k">function</span> <span class="nf">main</span><span class="p">(</span><span class="nv">$conn</span><span class="p">){</span> <span class="c1">// $conn is a mysqli connection object</span>
    26. 

  26.     
    27. 

  27.     <span class="nv">$forestName</span><span class="o">=</span><span class="s2">&quot;animals&quot;</span><span class="p">;</span>
    28. 

  28.     <span class="nx">start_over</span><span class="p">(</span><span class="nv">$conn</span><span class="p">,</span><span class="nv">$forestName</span><span class="p">);</span>
    29. 

  29.     
    30. 

  30.     <span class="c1">// Create a tree in the forest. It will get automatically his id</span>
    31. 

  31.     <span class="c1">//  (you could read it via the public member &quot;tree_id&quot; ) and we will leave</span>
    32. 

  32.     <span class="c1">//  it alone. A table called $forestName will be created if not yet exists</span>
    33. 

  33.     <span class="nv">$tree</span><span class="o">=</span><span class="k">new</span> <span class="nx">AnimalsBaobab</span><span class="p">(</span><span class="nv">$conn</span><span class="p">,</span><span class="nv">$forestName</span><span class="p">);</span>
    34. 

  34.     
    35. 

  35.     <span class="cm">/*</span>
    36. 

  36. <span class="cm">    </span>
    37. 

  37. <span class="cm">    We could import some well constructed data structure, but we&#39;re doing</span>
    38. 

  38. <span class="cm">    it the long and clumsy way to show some functions.</span>
    39. 

  39. <span class="cm">    </span>
    40. 

  40. <span class="cm">    Say we want to map this tree ...</span>
    41. 

  41. <span class="cm">    </span>
    42. 

  42. <span class="cm">    Animals</span>
    43. 

  43. <span class="cm">        ┣━━ Vertebrates</span>
    44. 

  44. <span class="cm">        ┃    ┣━━━ Mollusks</span>
    45. 

  45. <span class="cm">        ┃    ┗━━━ Insects</span>
    46. 

  46. <span class="cm">        ┃             ┗━━━ Mantis</span>
    47. 

  47. <span class="cm">        ┗━━ Invertebrates</span>
    48. 

  48. <span class="cm">              ┗━━━ Mammals</span>
    49. 

  49. <span class="cm">                      ┣━━━ Tiger</span>
    50. 

  50. <span class="cm">                      ┗━━━  Horse</span>
    51. 

  51. <span class="cm">    </span>
    52. 

  52. <span class="cm">    */</span>
    53. 

  53.     
    54. 

  54.     <span class="c1">// utility function to have something more readable later</span>
    55. 

  55.     
    56. 

  56.     <span class="c1">// Append the tree children, each node asks the parent id first, </span>
    57. 

  57.     <span class="c1">// and the values later</span>
    58. 

  58.     <span class="nv">$root_id</span><span class="o">=</span><span class="nv">$tree</span><span class="o">-&gt;</span><span class="na">appendChild</span><span class="p">(</span><span class="k">NULL</span><span class="p">,</span><span class="k">array</span><span class="p">(</span><span class="s2">&quot;name&quot;</span><span class="o">=&gt;</span><span class="s1">&#39;Animals&#39;</span><span class="p">));</span>
    59. 

  59.     
    60. 

  60.     <span class="nv">$vertebrates_id</span>   <span class="o">=</span> <span class="nv">$tree</span><span class="o">-&gt;</span><span class="na">appendChild</span><span class="p">(</span><span class="nv">$root_id</span><span class="p">,</span><span class="k">array</span><span class="p">(</span><span class="s2">&quot;name&quot;</span><span class="o">=&gt;</span><span class="s2">&quot;Vertebrates&quot;</span><span class="p">));</span>
    61. 

  61.     <span class="nv">$invertebrates_id</span> <span class="o">=</span> <span class="nv">$tree</span><span class="o">-&gt;</span><span class="na">appendChild</span><span class="p">(</span><span class="nv">$root_id</span><span class="p">,</span><span class="k">array</span><span class="p">(</span><span class="s2">&quot;name&quot;</span><span class="o">=&gt;</span><span class="s2">&quot;Invertebrates&quot;</span><span class="p">));</span>
    62. 

  62.     
    63. 

  63.     <span class="c1">// add vertebrates first ...</span>
    64. 

  64.     <span class="nv">$mollusks_id</span> <span class="o">=</span> <span class="nv">$tree</span><span class="o">-&gt;</span><span class="na">appendChild</span><span class="p">(</span><span class="nv">$vertebrates_id</span><span class="p">,</span><span class="k">array</span><span class="p">(</span><span class="s2">&quot;name&quot;</span><span class="o">=&gt;</span><span class="s2">&quot;Mollusks&quot;</span><span class="p">));</span>
    65. 

  65.     <span class="nv">$insects_id</span>  <span class="o">=</span> <span class="nv">$tree</span><span class="o">-&gt;</span><span class="na">appendChild</span><span class="p">(</span><span class="nv">$vertebrates_id</span><span class="p">,</span><span class="k">array</span><span class="p">(</span><span class="s2">&quot;name&quot;</span><span class="o">=&gt;</span><span class="s2">&quot;Insects&quot;</span><span class="p">));</span>
    66. 

  66.     
    67. 

  67.     <span class="nv">$mantis_id</span> <span class="o">=</span> <span class="nv">$tree</span><span class="o">-&gt;</span><span class="na">appendChild</span><span class="p">(</span><span class="nv">$insects_id</span><span class="p">,</span><span class="k">array</span><span class="p">(</span><span class="s2">&quot;name&quot;</span><span class="o">=&gt;</span><span class="s2">&quot;Mantis&quot;</span><span class="p">));</span>
    68. 

  68.     
    69. 

  69.     <span class="c1">// and invertebrates next ...</span>
    70. 

  70.     <span class="nv">$mammals_id</span> <span class="o">=</span> <span class="nv">$tree</span><span class="o">-&gt;</span><span class="na">appendChild</span><span class="p">(</span><span class="nv">$root_id</span><span class="p">,</span><span class="k">array</span><span class="p">(</span><span class="s2">&quot;name&quot;</span><span class="o">=&gt;</span><span class="s2">&quot;Mammals&quot;</span><span class="p">));</span>
    71. 

  71.     
    72. 

  72.     <span class="c1">// (we skip intentionally &#39;tiger&#39;)</span>
    73. 

  73.     <span class="nv">$horse_id</span> <span class="o">=</span> <span class="nv">$tree</span><span class="o">-&gt;</span><span class="na">appendChild</span><span class="p">(</span><span class="nv">$mammals_id</span><span class="p">,</span><span class="k">array</span><span class="p">(</span><span class="s2">&quot;name&quot;</span><span class="o">=&gt;</span><span class="s2">&quot;Horse&quot;</span><span class="p">));</span>
    74. 

  74.     
    75. 

  75.     <span class="c1">// Add tiger before &#39;horse&#39;. We could have done it earlier with an</span>
    76. 

  76.     <span class="c1">// appendChild but you&#39;re learning here. Indexes start from 0.</span>
    77. 

  77.     <span class="nv">$tiger_id</span> <span class="o">=</span> <span class="nv">$tree</span><span class="o">-&gt;</span><span class="na">insertBefore</span><span class="p">(</span><span class="nv">$horse_id</span><span class="p">,</span><span class="k">array</span><span class="p">(</span><span class="s2">&quot;name&quot;</span><span class="o">=&gt;</span><span class="s2">&quot;Tiger&quot;</span><span class="p">));</span>
    78. 

  78.     
    79. 

  79.     <span class="cm">/*</span>
    80. 

  80. <span class="cm">    Now the content of the &#39;animals&#39; table is</span>
    81. 

  81. <span class="cm">    </span>
    82. 

  82. <span class="cm">    =======  ==  ===  ===  =============</span>
    83. 

  83. <span class="cm">    tree_id  id  lft  rgt  name     </span>
    84. 

  84. <span class="cm">    =======  ==  ===  ===  =============</span>
    85. 

  85. <span class="cm">          1   1    1   18  Animals</span>
    86. 

  86. <span class="cm">          1   2    2    9  Vertebrates</span>
    87. 

  87. <span class="cm">          1   3   10   11  Invertebrates     </span>
    88. 

  88. <span class="cm">          1   4    3    4  Mollusks</span>
    89. 

  89. <span class="cm">          1   5    5    8  Insects </span>
    90. 

  90. <span class="cm">          1   6    6    7  Mantis      </span>
    91. 

  91. <span class="cm">          1   7   12   17  Mammals      </span>
    92. 

  92. <span class="cm">          1   8   15   16  Horse</span>
    93. 

  93. <span class="cm">          1   9   13   14  Tiger</span>
    94. 

  94. <span class="cm">    =======  ==  ===  ===  =============</span>
    95. 

  95. <span class="cm">    </span>
    96. 

  96. <span class="cm">    */</span>
    97. 

  97.     
    98. 

  98.     <span class="c1">// To obtain all the elements beetween root and a node ...</span>
    99. 

  99.     <span class="nv">$parts</span><span class="o">=</span><span class="nv">$tree</span><span class="o">-&gt;</span><span class="na">getPath</span><span class="p">(</span><span class="nv">$insects_id</span><span class="p">);</span>
    100. 

  100.     <span class="nb">print_r</span><span class="p">(</span><span class="nb">json_encode</span><span class="p">(</span><span class="nv">$parts</span><span class="p">));</span>
    101. 

  101.     <span class="c1">// output: [{&quot;id&quot;:&quot;1&quot;},{&quot;id&quot;:&quot;2&quot;},{&quot;id&quot;:&quot;5&quot;}]</span>
    102. 

  102.     <span class="k">echo</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">;</span>
    103. 

  103.     
    104. 

  104.     <span class="c1">// To obtain all the elements beetween root and a node filtering by a field...</span>
    105. 

  105.     <span class="nv">$filtered_parts</span><span class="o">=</span><span class="nv">$tree</span><span class="o">-&gt;</span><span class="na">getPath</span><span class="p">(</span><span class="nv">$insects_id</span><span class="p">,</span><span class="s1">&#39;name&#39;</span><span class="p">,</span><span class="k">TRUE</span><span class="p">);</span>
    106. 

  106.     <span class="nb">print_r</span><span class="p">(</span><span class="nb">join</span><span class="p">(</span><span class="s2">&quot; » &quot;</span><span class="p">,</span><span class="nv">$filtered_parts</span><span class="p">));</span>
    107. 

  107.     <span class="c1">// output: Animals » Vertebrates » Insects</span>
    108. 

  108.     <span class="k">echo</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">;</span>
    109. 

  109.     
    110. 

  110.     <span class="c1">// Get the crystalized state of the tree, either as a class instance ...</span>
    111. 

  111.     <span class="nv">$rootTreeState</span><span class="o">=</span><span class="nv">$tree</span><span class="o">-&gt;</span><span class="na">getTree</span><span class="p">();</span>
    112. 

  112.     <span class="nb">print_r</span><span class="p">(</span><span class="nv">$rootTreeState</span><span class="o">-&gt;</span><span class="na">children</span><span class="p">);</span>
    113. 

  113.     <span class="k">echo</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">;</span>
    114. 

  114.     
    115. 

  115.     <span class="c1">// ... or as a JSON string</span>
    116. 

  116.     <span class="nb">print_r</span><span class="p">(</span><span class="nv">$tree</span><span class="o">-&gt;</span><span class="na">export</span><span class="p">(</span><span class="nv">$conn</span><span class="p">,</span><span class="nv">$forestName</span><span class="p">));</span>
    117. 

  117.     <span class="k">echo</span> <span class="s2">&quot;</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">;</span>
    118. 

  118.     
    119. 

  119.     <span class="c1">// Next time you want to access this tree, if you&#39;re using a table to store</span>
    120. 

  120.     <span class="c1">// a single tree then pass -1 as tree id</span>
    121. 

  121.     <span class="nv">$treeLoadedAgain</span><span class="o">=</span><span class="k">new</span> <span class="nx">AnimalsBaobab</span><span class="p">(</span><span class="nv">$conn</span><span class="p">,</span><span class="nv">$forestName</span><span class="p">,</span><span class="o">-</span><span class="mi">1</span><span class="p">);</span>
    122. 

  122.     <span class="c1">// (otherwise you would need to know his tree id [check the documentation])</span>
    123. 

  123. <span class="p">}</span>
    124. 

  124. </pre></div>
    125.