mirror of
https://github.com/evennia/evennia.git
synced 2026-03-29 12:07:17 +02:00
Updated HTML docs
This commit is contained in:
Griatch
parent
86fb09d6bf
commit
86c930be7a
1221 changed files with 76528 additions and 29095 deletions
|
|
@ -30,6 +30,7 @@
|
|||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.website.views.objects</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
|
||||
<div class="document">
|
||||
|
|
@ -37,8 +38,181 @@
|
|||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<section id="evennia-web-website-views-objects">
|
||||
<h1>evennia.web.website.views.objects<a class="headerlink" href="#evennia-web-website-views-objects" title="Permalink to this headline">¶</a></h1>
|
||||
<section id="module-evennia.web.website.views.objects">
|
||||
<span id="evennia-web-website-views-objects"></span><h1>evennia.web.website.views.objects<a class="headerlink" href="#module-evennia.web.website.views.objects" title="Permalink to this headline">¶</a></h1>
|
||||
<p>Views for managing a specific object)</p>
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDetailView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.objects.</code><code class="sig-name descname">ObjectDetailView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/objects.html#ObjectDetailView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDetailView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <a class="reference internal" href="evennia.web.website.views.mixins.html#evennia.web.website.views.mixins.EvenniaDetailView" title="evennia.web.website.views.mixins.EvenniaDetailView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.mixins.EvenniaDetailView</span></code></a></p>
|
||||
<p>This is an important view.</p>
|
||||
<p>Any view you write that deals with displaying, updating or deleting a
|
||||
specific object will want to inherit from this. It provides the mechanisms
|
||||
by which to retrieve the object and make sure the user requesting it has
|
||||
permissions to actually <em>do</em> things to it.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDetailView.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDetailView.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDetailView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/object_detail.html'</em><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDetailView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDetailView.access_type">
|
||||
<code class="sig-name descname">access_type</code><em class="property"> = 'view'</em><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDetailView.access_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDetailView.attributes">
|
||||
<code class="sig-name descname">attributes</code><em class="property"> = ['name', 'desc']</em><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDetailView.attributes" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDetailView.get_context_data">
|
||||
<code class="sig-name descname">get_context_data</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/objects.html#ObjectDetailView.get_context_data"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDetailView.get_context_data" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Adds an ‘attributes’ list to the request context consisting of the
|
||||
attributes specified at the class level, and in the order provided.</p>
|
||||
<p>Django views do not provide a way to reference dynamic attributes, so
|
||||
we have to grab them all before we render the template.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><em>context (dict)</em> – Django context object</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDetailView.get_object">
|
||||
<code class="sig-name descname">get_object</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">queryset</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/objects.html#ObjectDetailView.get_object"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDetailView.get_object" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Override of Django hook that provides some important Evennia-specific
|
||||
functionality.</p>
|
||||
<p>Evennia does not natively store slugs, so where a slug is provided,
|
||||
calculate the same for the object and make sure it matches.</p>
|
||||
<p>This also checks to make sure the user has access to view/edit/delete
|
||||
this object!</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.objects.ObjectCreateView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.objects.</code><code class="sig-name descname">ObjectCreateView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/objects.html#ObjectCreateView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.objects.ObjectCreateView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.contrib.auth.mixins.LoginRequiredMixin</span></code>, <a class="reference internal" href="evennia.web.website.views.mixins.html#evennia.web.website.views.mixins.EvenniaCreateView" title="evennia.web.website.views.mixins.EvenniaCreateView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.mixins.EvenniaCreateView</span></code></a></p>
|
||||
<p>This is an important view.</p>
|
||||
<p>Any view you write that deals with creating a specific object will want to
|
||||
inherit from this. It provides the mechanisms by which to make sure the user
|
||||
requesting creation of an object is authenticated, and provides a sane
|
||||
default title for the page.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.objects.ObjectCreateView.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.views.objects.ObjectCreateView.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDeleteView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.objects.</code><code class="sig-name descname">ObjectDeleteView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/objects.html#ObjectDeleteView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDeleteView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.contrib.auth.mixins.LoginRequiredMixin</span></code>, <a class="reference internal" href="#evennia.web.website.views.objects.ObjectDetailView" title="evennia.web.website.views.objects.ObjectDetailView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.objects.ObjectDetailView</span></code></a>, <a class="reference internal" href="evennia.web.website.views.mixins.html#evennia.web.website.views.mixins.EvenniaDeleteView" title="evennia.web.website.views.mixins.EvenniaDeleteView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.mixins.EvenniaDeleteView</span></code></a></p>
|
||||
<p>This is an important view for obvious reasons!</p>
|
||||
<p>Any view you write that deals with deleting a specific object will want to
|
||||
inherit from this. It provides the mechanisms by which to make sure the user
|
||||
requesting deletion of an object is authenticated, and that they have
|
||||
permissions to delete the requested object.</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDeleteView.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDeleteView.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDeleteView.template_name">
|
||||
<code class="sig-name descname">template_name</code><em class="property"> = 'website/object_confirm_delete.html'</em><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDeleteView.template_name" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDeleteView.access_type">
|
||||
<code class="sig-name descname">access_type</code><em class="property"> = 'delete'</em><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDeleteView.access_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.objects.ObjectDeleteView.delete">
|
||||
<code class="sig-name descname">delete</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">request</span></em>, <em class="sig-param"><span class="o">*</span><span class="n">args</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/objects.html#ObjectDeleteView.delete"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.objects.ObjectDeleteView.delete" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Calls the delete() method on the fetched object and then
|
||||
redirects to the success URL.</p>
|
||||
<p>We extend this so we can capture the name for the sake of confirmation.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt id="evennia.web.website.views.objects.ObjectUpdateView">
|
||||
<em class="property">class </em><code class="sig-prename descclassname">evennia.web.website.views.objects.</code><code class="sig-name descname">ObjectUpdateView</code><span class="sig-paren">(</span><em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/objects.html#ObjectUpdateView"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.objects.ObjectUpdateView" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">django.contrib.auth.mixins.LoginRequiredMixin</span></code>, <a class="reference internal" href="#evennia.web.website.views.objects.ObjectDetailView" title="evennia.web.website.views.objects.ObjectDetailView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.objects.ObjectDetailView</span></code></a>, <a class="reference internal" href="evennia.web.website.views.mixins.html#evennia.web.website.views.mixins.EvenniaUpdateView" title="evennia.web.website.views.mixins.EvenniaUpdateView"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.web.website.views.mixins.EvenniaUpdateView</span></code></a></p>
|
||||
<p>This is an important view.</p>
|
||||
<p>Any view you write that deals with updating a specific object will want to
|
||||
inherit from this. It provides the mechanisms by which to make sure the user
|
||||
requesting editing of an object is authenticated, and that they have
|
||||
permissions to edit the requested object.</p>
|
||||
<p>This functions slightly different from default Django UpdateViews in that
|
||||
it does not update core model fields, <em>only</em> object attributes!</p>
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.objects.ObjectUpdateView.model">
|
||||
<code class="sig-name descname">model</code><a class="headerlink" href="#evennia.web.website.views.objects.ObjectUpdateView.model" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>alias of <a class="reference internal" href="evennia.objects.objects.html#evennia.objects.objects.DefaultObject" title="evennia.objects.objects.DefaultObject"><code class="xref py py-class docutils literal notranslate"><span class="pre">evennia.objects.objects.DefaultObject</span></code></a></p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt id="evennia.web.website.views.objects.ObjectUpdateView.access_type">
|
||||
<code class="sig-name descname">access_type</code><em class="property"> = 'edit'</em><a class="headerlink" href="#evennia.web.website.views.objects.ObjectUpdateView.access_type" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.objects.ObjectUpdateView.get_success_url">
|
||||
<code class="sig-name descname">get_success_url</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/objects.html#ObjectUpdateView.get_success_url"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.objects.ObjectUpdateView.get_success_url" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Django hook.</p>
|
||||
<p>Can be overridden to return any URL you want to redirect the user to
|
||||
after the object is successfully updated, but by default it goes to the
|
||||
object detail page so the user can see their changes reflected.</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.objects.ObjectUpdateView.get_initial">
|
||||
<code class="sig-name descname">get_initial</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/objects.html#ObjectUpdateView.get_initial"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.objects.ObjectUpdateView.get_initial" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Django hook, modified for Evennia.</p>
|
||||
<p>Prepopulates the update form field values based on object db attributes.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Returns</dt>
|
||||
<dd class="field-odd"><p><p><em>data (dict)</em> –</p>
|
||||
<dl class="simple">
|
||||
<dt>Dictionary of key:value pairs containing initial form</dt><dd><p>data.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt id="evennia.web.website.views.objects.ObjectUpdateView.form_valid">
|
||||
<code class="sig-name descname">form_valid</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">form</span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/evennia/web/website/views/objects.html#ObjectUpdateView.form_valid"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#evennia.web.website.views.objects.ObjectUpdateView.form_valid" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Override of Django hook.</p>
|
||||
<p>Updates object attributes based on values submitted.</p>
|
||||
<p>This is run when the form is submitted and the data on it is deemed
|
||||
valid– all values are within expected ranges, all strings contain
|
||||
valid characters and lengths, etc.</p>
|
||||
<p>This method is only called if all values for the fields submitted
|
||||
passed form validation, so at this point we can assume the data is
|
||||
validated and sanitized.</p>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
|
@ -84,7 +258,6 @@
|
|||
<li><a href="../../0.9.5/index.html">0.9.5 (v0.9.5 branch)</a></li>
|
||||
</ul>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
|
|
@ -101,6 +274,7 @@
|
|||
<li class="nav-item nav-item-0"><a href="../index.html">Evennia 1.0-dev</a> »</li>
|
||||
<li class="nav-item nav-item-this"><a href="">evennia.web.website.views.objects</a></li>
|
||||
</ul>
|
||||
<div class="develop">develop branch</div>
|
||||
</div>
|
||||
<div class="footer" role="contentinfo">
|
||||
© Copyright 2020, The Evennia developer community.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue