Fixed #24244 -- Documented contrib.admin.models.LogEntry

This commit is contained in:
Alex Morozov 2015-11-02 12:59:22 +03:00 committed by Tim Graham
parent d49b36e485
commit 99c58c27d5
2 changed files with 60 additions and 1 deletions

View File

@ -2749,6 +2749,65 @@ The presence of the ``admin_password_reset`` named URL will cause a "forgotten
your password?" link to appear on the default admin log-in page under the your password?" link to appear on the default admin log-in page under the
password box. password box.
``LogEntry`` objects
====================
.. class:: models.LogEntry
The ``LogEntry`` class tracks additions, changes, and deletions of objects
done through the admin interface.
.. currentmodule:: django.contrib.admin.models
``LogEntry`` attributes
-----------------------
.. attribute:: LogEntry.action_time
The date and time of the action.
.. attribute:: LogEntry.user
The user (an :setting:`AUTH_USER_MODEL` instance) who performed the
action.
.. attribute:: LogEntry.content_type
The :class:`~django.contrib.contenttypes.models.ContentType` of the
modified object.
.. attribute:: LogEntry.object_id
The textual representation of the modified object's primary key.
.. attribute:: LogEntry.object_repr
The object`s ``repr()`` after the modification.
.. attribute:: LogEntry.action_flag
The type of action logged: ``ADDITION``, ``CHANGE``, ``DELETION``.
For example, to get a list of all additions done through the admin::
from django.contrib.admin.models import LogEntry, ADDITION
LogEntry.objects.filter(action_flag=ADDITION)
.. attribute:: LogEntry.change_message
The detailed description of the modification. In the case of an edit, for
example, the message contains a list of the edited fields.
``LogEntry`` methods
--------------------
.. method:: LogEntry.get_edited_object()
A shortcut that returns the referenced object.
.. currentmodule:: django.contrib.admin
.. _admin-reverse-urls: .. _admin-reverse-urls:
Reversing admin URLs Reversing admin URLs

View File

@ -379,7 +379,7 @@ Should you decide to use ``utf8_bin`` collation for some of your tables with
MySQLdb 1.2.1p2 or 1.2.2, you should still use ``utf8_general_ci`` MySQLdb 1.2.1p2 or 1.2.2, you should still use ``utf8_general_ci``
(the default) collation for the ``django.contrib.sessions.models.Session`` (the default) collation for the ``django.contrib.sessions.models.Session``
table (usually called ``django_session``) and the table (usually called ``django_session``) and the
``django.contrib.admin.models.LogEntry`` table (usually called :class:`django.contrib.admin.models.LogEntry` table (usually called
``django_admin_log``). Those are the two standard tables that use ``django_admin_log``). Those are the two standard tables that use
:class:`~django.db.models.TextField` internally. :class:`~django.db.models.TextField` internally.