Merge branch 'master' into develop
[philo.git] / docs / models / entities.rst
1 Entities and Attributes
2 =======================
3
4 .. module:: philo.models.base
5
6 One of the core concepts in Philo is the relationship between the :class:`Entity` and :class:`Attribute` classes. :class:`Attribute`\ s represent an arbitrary key/value pair by having one :class:`GenericForeignKey` to an :class:`Entity` and another to an :class:`AttributeValue`.
7
8
9 Attributes
10 ----------
11
12 .. autoclass:: Attribute
13         :members:
14
15 .. autoclass:: AttributeValue
16         :members:
17
18 .. automodule:: philo.models.base
19         :noindex:
20         :members: attribute_value_limiter
21
22 .. autoclass:: JSONValue
23         :show-inheritance:
24
25 .. autoclass:: ForeignKeyValue
26         :show-inheritance:
27
28 .. autoclass:: ManyToManyValue
29         :show-inheritance:
30
31 .. automodule:: philo.models.base
32         :noindex:
33         :members: value_content_type_limiter
34
35 .. autofunction:: register_value_model(model)
36 .. autofunction:: unregister_value_model(model)
37
38 Entities
39 --------
40
41 .. autoclass:: Entity
42         :members:
43
44 .. autoclass:: TreeEntityManager
45         :members:
46
47 .. autoclass:: TreeEntity
48         :show-inheritance:
49         :members:
50
51         .. attribute:: objects
52
53                 An instance of :class:`TreeEntityManager`.
54         
55         .. automethod:: get_path