PageRenderTime 26ms CodeModel.GetById 16ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/registering_models.html

https://bitbucket.org/forcreation/django-categories
HTML | 249 lines | 235 code | 14 blank | 0 comment | 0 complexity | 61f851cce9822814f90e2a3c41cb4a38 MD5 | raw file
    

  1. 

  2. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3. 

  3.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    4. 

  4. 

  5. <html xmlns="http://www.w3.org/1999/xhtml">
    6. 

  6.   <head>
    7. 

  7.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    8. 

  8.     
    9. 

  9.     <title>Registering Models &mdash; Django Categories v1.1 documentation</title>
    10. 

  10.     <link rel="stylesheet" href="_static/default.css" type="text/css" />
    11. 

  11.     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    12. 

  12.     <script type="text/javascript">
    13. 

  13.       var DOCUMENTATION_OPTIONS = {
    14. 

  14.         URL_ROOT:    '',
    15. 

  15.         VERSION:     '1.1',
    16. 

  16.         COLLAPSE_INDEX: false,
    17. 

  17.         FILE_SUFFIX: '.html',
    18. 

  18.         HAS_SOURCE:  true
    19. 

  19.       };
    20. 

  20.     </script>
    21. 

  21.     <script type="text/javascript" src="_static/jquery.js"></script>
    22. 

  22.     <script type="text/javascript" src="_static/underscore.js"></script>
    23. 

  23.     <script type="text/javascript" src="_static/doctools.js"></script>
    24. 

  24.     <link rel="top" title="Django Categories v1.1 documentation" href="index.html" />
    25. 

  25.     <link rel="next" title="Adding the fields to the database" href="adding_the_fields.html" />
    26. 

  26.     <link rel="prev" title="Using categories in templates" href="usage.html" /> 
    27. 

  27.   </head>
    28. 

  28.   <body>
    29. 

  29. <div id="docstitle">
    30. 

  30. 	<p>Django Categories v1.1 documentation</p>
    31. 

  31. </div>
    32. 

  32. <div id="header">
    33. 

  33. 	<div id="title"><h1>Registering Models</h1></div>
    34. 

  34. 	<ul id="headerButtons">
    35. 

  35. 		<li id="toc_button"><div class="headerButton"><a href="#">Table of Contents</a></div></li>
    36. 

  36. 		<li id="page_buttons">
    37. 

  37. 			<div class="headerButton"><a href="genindex.html" title="General Index" accesskey="I">index</a></div>
    38. 

  38. 			<div class="headerButton"><a href="adding_the_fields.html" title="Adding the fields to the database" accesskey="N">next</a></div>
    39. 

  39. 			<div class="headerButton"><a href="usage.html" title="Using categories in templates" accesskey="P">previous</a></div>
    40. 

  40. 		</li>
    41. 

  41. 	</ul>
    42. 

  42. </div>
    43. 

  43. 

  44. <div id="sphinxsidebar">
    45. 

  45.   <div class="sphinxsidebarwrapper">
    46. 

  46. 	<ul><li class="toctree-l1"><a href="index.html">Main Page</a></li></ul>
    47. 

  47. 	<ul class="current">
    48. 

  48. <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
    49. 

  49. <li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting Started</a></li>
    50. 

  50. <li class="toctree-l1"><a class="reference internal" href="usage.html">Using categories in templates</a></li>
    51. 

  51. <li class="toctree-l1 current"><a class="current reference internal" href="">Registering Models</a><ul>
    52. 

  52. <li class="toctree-l2"><a class="reference internal" href="#registering-models-in-settings-py">Registering models in settings.py</a></li>
    53. 

  53. <li class="toctree-l2"><a class="reference internal" href="#registering-a-many-to-one-relationship">Registering a many-to-one relationship</a></li>
    54. 

  54. <li class="toctree-l2"><a class="reference internal" href="#registering-a-many-to-many-relationship">Registering a many-to-many relationship</a></li>
    55. 

  55. </ul>
    56. 

  56. </li>
    57. 

  57. <li class="toctree-l1"><a class="reference internal" href="adding_the_fields.html">Adding the fields to the database</a></li>
    58. 

  58. <li class="toctree-l1"><a class="reference internal" href="custom_categories.html">Creating Custom Categories</a></li>
    59. 

  59. <li class="toctree-l1"><a class="reference internal" href="reference/index.html">Reference</a></li>
    60. 

  60. </ul>
    61. 

  61. 

  62.       <h3>This Page</h3>
    63. 

  63.       <ul class="this-page-menu">
    64. 

  64.         <li><a href="_sources/registering_models.txt"
    65. 

  65.                rel="nofollow">Show Source</a></li>
    66. 

  66.       </ul>
    67. 

  67.     <div id="searchbox" style="display: none">
    68. 

  68.       
    69. 

  69.         <form class="search" action="search.html" method="get">
    70. 

  70. 			<div class="search-wrapper">
    71. 

  71. 			<span class="search-left"></span>
    72. 

  72. 			<input class="prettysearch" type="text" name="q" size="18" />
    73. 

  73. 			<span class="search-right">&nbsp;</span>
    74. 

  74. 			</div>
    75. 

  75.           <input type="submit" value="Search" class="searchbutton" />
    76. 

  76.           <input type="hidden" name="check_keywords" value="yes" />
    77. 

  77.           <input type="hidden" name="area" value="default" />
    78. 

  78.         </form>
    79. 

  79.         <p class="searchtip" style="font-size: 90%">
    80. 

  80.         Enter search terms or a module, class or function name.
    81. 

  81.         </p>
    82. 

  82.     </div>
    83. 

  83.     <script type="text/javascript">$('#searchbox').show(0);</script>
    84. 

  84.   </div>
    85. 

  85. </div>
    86. 

  86. 

  87. 

  88. 

  89.     <div class="document">
    90. 

  90.       <div class="documentwrapper">
    91. 

  91.         <div class="bodywrapper">
    92. 

  92.           <div class="body">
    93. 

  93.             
    94. 

  94.   <div class="section" id="registering-models">
    95. 

  95. <span id="id1"></span><h1>Registering Models<a class="headerlink" href="#registering-models" title="Permalink to this headline"></a></h1>
    96. 

  96. <div class="section" id="registering-models-in-settings-py">
    97. 

  97. <h2>Registering models in settings.py<a class="headerlink" href="#registering-models-in-settings-py" title="Permalink to this headline"></a></h2>
    98. 

  98. <p>It is nice to not have to modify the code of applications to add a relation to categories. You can therefore do all the registering in <tt class="docutils literal"><span class="pre">settings.py</span></tt>. For example:</p>
    99. 

  99. <div class="highlight-python"><div class="highlight"><pre><span class="n">CATEGORIES_SETTINGS</span> <span class="o">=</span> <span class="p">{</span>
    100. 

  100.     <span class="s">&#39;FK_REGISTRY&#39;</span><span class="p">:</span> <span class="p">{</span>
    101. 

  101.         <span class="s">&#39;app.AModel&#39;</span><span class="p">:</span> <span class="s">&#39;category&#39;</span><span class="p">,</span>
    102. 

  102.         <span class="s">&#39;app.MyModel&#39;</span><span class="p">:</span> <span class="p">(</span>
    103. 

  103.             <span class="s">&#39;primary_category&#39;</span><span class="p">,</span>
    104. 

  104.             <span class="p">{</span><span class="s">&#39;name&#39;</span><span class="p">:</span> <span class="s">&#39;secondary_category&#39;</span><span class="p">,</span> <span class="s">&#39;related_name&#39;</span><span class="p">:</span> <span class="s">&#39;mymodel_sec_cat&#39;</span><span class="p">},</span> <span class="p">)</span>
    105. 

  105.     <span class="p">},</span>
    106. 

  106.     <span class="s">&#39;M2M_REGISTRY&#39;</span><span class="p">:</span> <span class="p">{</span>
    107. 

  107.         <span class="s">&#39;app.BModel&#39;</span><span class="p">:</span> <span class="s">&#39;categories&#39;</span><span class="p">,</span>
    108. 

  108.         <span class="s">&#39;app.MyModel&#39;</span><span class="p">:</span> <span class="p">(</span><span class="s">&#39;other_categories&#39;</span><span class="p">,</span> <span class="s">&#39;more_categories&#39;</span><span class="p">,</span> <span class="p">),</span>
    109. 

  109.     <span class="p">}</span>
    110. 

  110. <span class="p">}</span>
    111. 

  111. </pre></div>
    112. 

  112. </div>
    113. 

  113. <p>The <tt class="docutils literal"><span class="pre">FK_REGISTRY</span></tt> is a dictionary whose keys are the model to which to add the new field(s). The value is a string or tuple of strings or dictionaries specifying the necessary information for each field.</p>
    114. 

  114. <p>The <tt class="docutils literal"><span class="pre">M2M_REGISTRY</span></tt> is a dictionary whose keys are the model to which to add the new field(s). The value is a string or tuple of strings specifying the necessary information for each field.</p>
    115. 

  115. <div class="section" id="registering-one-category-field-to-model">
    116. 

  116. <h3>Registering one Category field to model<a class="headerlink" href="#registering-one-category-field-to-model" title="Permalink to this headline"></a></h3>
    117. 

  117. <p>The simplest way is to specify the name of the field, such as:</p>
    118. 

  118. <div class="highlight-python"><div class="highlight"><pre><span class="n">CATEGORIES_SETTINGS</span> <span class="o">=</span> <span class="p">{</span>
    119. 

  119.     <span class="s">&#39;FK_REGISTRY&#39;</span><span class="p">:</span> <span class="p">{</span>
    120. 

  120.         <span class="s">&#39;app.AModel&#39;</span><span class="p">:</span> <span class="s">&#39;category&#39;</span>
    121. 

  121.     <span class="p">}</span>
    122. 

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

  123. </pre></div>
    124. 

  124. </div>
    125. 

  125. <p>This is equivalent to adding the following the <tt class="docutils literal"><span class="pre">AModel</span></tt> of <tt class="docutils literal"><span class="pre">app</span></tt>:</p>
    126. 

  126. <div class="highlight-python"><div class="highlight"><pre><span class="n">category</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">ForeignKey</span><span class="p">(</span><span class="n">Category</span><span class="p">)</span>
    127. 

  127. </pre></div>
    128. 

  128. </div>
    129. 

  129. <p>If you want more control over the new field, you can use a dictionary and pass other <tt class="docutils literal"><span class="pre">ForeignKey</span></tt> options. The <tt class="docutils literal"><span class="pre">name</span></tt> key is required:</p>
    130. 

  130. <div class="highlight-python"><div class="highlight"><pre><span class="n">CATEGORIES_SETTINGS</span> <span class="o">=</span> <span class="p">{</span>
    131. 

  131.     <span class="s">&#39;FK_REGISTRY&#39;</span><span class="p">:</span> <span class="p">{</span>
    132. 

  132.         <span class="s">&#39;app.AModel&#39;</span><span class="p">:</span> <span class="p">{</span><span class="s">&#39;name&#39;</span><span class="p">:</span> <span class="s">&#39;category&#39;</span><span class="p">,</span> <span class="s">&#39;related_name&#39;</span><span class="p">:</span> <span class="s">&#39;amodel_cats&#39;</span><span class="p">}</span>
    133. 

  133.     <span class="p">}</span>
    134. 

  134. <span class="p">}</span>
    135. 

  135. </pre></div>
    136. 

  136. </div>
    137. 

  137. <p>This is equivalent to adding the following the <tt class="docutils literal"><span class="pre">AModel</span></tt> of <tt class="docutils literal"><span class="pre">app</span></tt>:</p>
    138. 

  138. <div class="highlight-python"><div class="highlight"><pre><span class="n">category</span> <span class="o">=</span> <span class="n">models</span><span class="o">.</span><span class="n">ForeignKey</span><span class="p">(</span><span class="n">Category</span><span class="p">,</span> <span class="n">related_name</span><span class="o">=</span><span class="s">&#39;amodel_cats&#39;</span><span class="p">)</span>
    139. 

  139. </pre></div>
    140. 

  140. </div>
    141. 

  141. </div>
    142. 

  142. <div class="section" id="registering-two-or-more-category-fields-to-a-model">
    143. 

  143. <h3>Registering two or more Category fields to a Model<a class="headerlink" href="#registering-two-or-more-category-fields-to-a-model" title="Permalink to this headline"></a></h3>
    144. 

  144. <p>When you want more than one relation to <tt class="docutils literal"><span class="pre">Category</span></tt>, all but one of the fields must specify a <tt class="docutils literal"><span class="pre">related_name</span></tt> to avoid conflicts, like so:</p>
    145. 

  145. <div class="highlight-python"><pre>CATEGORIES_SETTINGS = {
    146. 

  146.     'FK_REGISTRY': {
    147. 

  147.         'app.MyModel': (
    148. 

  148.             'primary_category',
    149. 

  149.             {'name': 'secondary_category', 'related_name': 'mymodel_sec_cat'}, )
    150. 

  150.     },</pre>
    151. 

  151. </div>
    152. 

  152. </div>
    153. 

  153. <div class="section" id="registering-one-or-more-many-to-many-category-fields-to-a-model">
    154. 

  154. <h3>Registering one or more Many-to-Many Category fields to a Model<a class="headerlink" href="#registering-one-or-more-many-to-many-category-fields-to-a-model" title="Permalink to this headline"></a></h3>
    155. 

  155. <div class="highlight-python"><div class="highlight"><pre><span class="n">CATEGORIES_SETTINGS</span> <span class="o">=</span> <span class="p">{</span>
    156. 

  156.     <span class="s">&#39;M2M_REGISTRY&#39;</span><span class="p">:</span> <span class="p">{</span>
    157. 

  157.         <span class="s">&#39;app.AModel&#39;</span><span class="p">:</span> <span class="s">&#39;categories&#39;</span><span class="p">,</span>
    158. 

  158.         <span class="s">&#39;app.MyModel&#39;</span><span class="p">:</span> <span class="p">(</span>
    159. 

  159.             <span class="p">{</span><span class="s">&#39;name&#39;</span><span class="p">:</span> <span class="s">&#39;other_categories&#39;</span><span class="p">,</span> <span class="s">&#39;related_name&#39;</span><span class="p">:</span> <span class="s">&#39;other_cats&#39;</span><span class="p">},</span>
    160. 

  160.             <span class="p">{</span><span class="s">&#39;name&#39;</span><span class="p">:</span> <span class="s">&#39;more_categories&#39;</span><span class="p">,</span> <span class="s">&#39;related_name&#39;</span><span class="p">:</span> <span class="s">&#39;more_cats&#39;</span><span class="p">},</span>
    161. 

  161.         <span class="p">),</span>
    162. 

  162.     <span class="p">}</span>
    163. 

  163. <span class="p">}</span>
    164. 

  164. </pre></div>
    165. 

  165. </div>
    166. 

  166. </div>
    167. 

  167. </div>
    168. 

  168. <div class="section" id="registering-a-many-to-one-relationship">
    169. 

  169. <span id="registering-a-m2one-relationship"></span><h2>Registering a many-to-one relationship<a class="headerlink" href="#registering-a-many-to-one-relationship" title="Permalink to this headline"></a></h2>
    170. 

  170. <p>To create a many-to-one relationship (foreign key) between a model and Django Categories, you register your model with the <tt class="docutils literal"><span class="pre">register_fk</span></tt> function.</p>
    171. 

  171. <dl class="function">
    172. 

  172. <dt id="register_fk">
    173. 

  173. <tt class="descname">register_fk</tt><big>(</big><em>model, field_name='category', extra_params={}]</em><big>)</big><a class="headerlink" href="#register_fk" title="Permalink to this definition"></a></dt>
    174. 

  174. <dd><table class="docutils field-list" frame="void" rules="none">
    175. 

  175. <col class="field-name" />
    176. 

  176. <col class="field-body" />
    177. 

  177. <tbody valign="top">
    178. 

  178. <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    179. 

  179. <li><strong>model</strong> &#8211; The Django Model to link to Django Categories</li>
    180. 

  180. <li><strong>field_name</strong> &#8211; Optional name for the field <strong>default:</strong> category</li>
    181. 

  181. <li><strong>extra_params</strong> &#8211; Optional dictionary of extra parameters passed to the <tt class="docutils literal"><span class="pre">ForeignKey</span></tt> class.</li>
    182. 

  182. </ul>
    183. 

  183. </td>
    184. 

  184. </tr>
    185. 

  185. </tbody>
    186. 

  186. </table>
    187. 

  187. </dd></dl>
    188. 

  188. 

  189. <p>Example, in your <tt class="docutils literal"><span class="pre">models.py</span></tt>:</p>
    190. 

  190. <div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">categories</span>
    191. 

  191. <span class="n">categories</span><span class="o">.</span><span class="n">register_fk</span><span class="p">(</span><span class="n">MyModel</span><span class="p">)</span>
    192. 

  192. </pre></div>
    193. 

  193. </div>
    194. 

  194. <p>If you want more than one field on a model you have to have some extra arguments:</p>
    195. 

  195. <div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">categories</span>
    196. 

  196. <span class="n">categories</span><span class="o">.</span><span class="n">register_fk</span><span class="p">(</span><span class="n">MyModel</span><span class="p">,</span> <span class="s">&#39;primary_category&#39;</span><span class="p">)</span>
    197. 

  197. <span class="n">categories</span><span class="o">.</span><span class="n">register_fk</span><span class="p">(</span><span class="n">MyModel</span><span class="p">,</span> <span class="s">&#39;secondary_category&#39;</span><span class="p">,</span> <span class="p">{</span><span class="s">&#39;related_name&#39;</span><span class="p">:</span><span class="s">&#39;mymodel_sec_cat&#39;</span><span class="p">})</span>
    198. 

  198. </pre></div>
    199. 

  199. </div>
    200. 

  200. <p>The <tt class="docutils literal"><span class="pre">extra_args</span></tt> allows you to specify the related_name of one of the fields so it doesn&#8217;t clash.</p>
    201. 

  201. </div>
    202. 

  202. <div class="section" id="registering-a-many-to-many-relationship">
    203. 

  203. <h2>Registering a many-to-many relationship<a class="headerlink" href="#registering-a-many-to-many-relationship" title="Permalink to this headline"></a></h2>
    204. 

  204. <p>To create a many-to-many relationship between a model and Django Categories, you register your model with the <tt class="docutils literal"><span class="pre">register_m2m</span></tt> function.</p>
    205. 

  205. <dl class="function">
    206. 

  206. <dt id="register_m2m">
    207. 

  207. <tt class="descname">register_m2m</tt><big>(</big><em>model, field_name='categories', extra_params={}]</em><big>)</big><a class="headerlink" href="#register_m2m" title="Permalink to this definition"></a></dt>
    208. 

  208. <dd><table class="docutils field-list" frame="void" rules="none">
    209. 

  209. <col class="field-name" />
    210. 

  210. <col class="field-body" />
    211. 

  211. <tbody valign="top">
    212. 

  212. <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
    213. 

  213. <li><strong>model</strong> &#8211; The Django Model to link to Django Categories</li>
    214. 

  214. <li><strong>field_name</strong> &#8211; Optional name for the field <strong>default:</strong> categories</li>
    215. 

  215. <li><strong>extra_params</strong> &#8211; Optional dictionary of extra parameters passed to the <tt class="docutils literal"><span class="pre">ManyToManyField</span></tt> class.</li>
    216. 

  216. </ul>
    217. 

  217. </td>
    218. 

  218. </tr>
    219. 

  219. </tbody>
    220. 

  220. </table>
    221. 

  221. </dd></dl>
    222. 

  222. 

  223. <p>Example, in your <tt class="docutils literal"><span class="pre">models.py</span></tt>:</p>
    224. 

  224. <div class="highlight-python"><div class="highlight"><pre><span class="kn">import</span> <span class="nn">categories</span>
    225. 

  225. <span class="n">categories</span><span class="o">.</span><span class="n">register_m2m</span><span class="p">(</span><span class="n">MyModel</span><span class="p">)</span>
    226. 

  226. </pre></div>
    227. 

  227. </div>
    228. 

  228. </div>
    229. 

  229. </div>
    230. 

  230. 

  231. 

  232.           </div> 
    233. 

  233.         </div>
    234. 

  234.       </div>
    235. 

  235.     <div class="footer">
    236. 

  236.     <p>
    237. 

  237.       &copy; Copyright 2010-2012, Corey Oordt.
    238. 

  238.       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
    239. 

  239. 	</p>
    240. 

  240.     </div>
    241. 

  241.       <div class="clearer"></div>
    242. 

  242.     </div>
    243. 

  243. 	<div id="breadcrumbs">
    244. 

  244. 		Registering Models
    245. 

  245. 		</ul>
    246. 

  246. 	</div>
    247. 

  247. 	<script type="text/javascript" charset="utf-8" src="_static/toc.js"></script>
    248. 

  248.   </body>
    249. 

  249. </html>
    250.