Changes between Version 27 and Version 28 of S3/S3Model

Timestamp:

01/27/14 11:45:33 (12 years ago)

Author:

Dominic König

Comment:

--

S3/S3Model

@@ -1 +1 @@
 = S3Model =
 [[TOC]]
-
-See also:
-
-  - [wiki:S3/S3Model/SuperEntities Super-Entities]
 
 == Purpose ==
@@ -318 +314 @@
 === Components ===
 
-Components can be defined in S3Models using the {{{add_component}}} method:
-
-{{{
-current.s3db.add_component(<component_table_name>, <master_table_name>=<join>)
-}}}
-
-The {{{add_component()}}} method is available both in {{{S3Model}}} instances ({{{self.add_component}}}, {{{s3db.add_component}}}) as well as from the class ({{{S3Model.add_component}}}).
+Components are sub-tables of a master entity ("has"-relationship). 
+
+Components can be defined in S3Models using the {{{add_component}}} method, e.g.
+
+{{{#!python
+# Offices (org_office table) are a component of organisations (org_organisation table),
+# linked through the organisation_id field in org_office
+current.s3db.add_component("org_office", org_organisation="organisation_id")
+}}}
 
 Read more here: [wiki:S3/S3Model/ComponentResources Component Resources]
 
+==== Super-Entities ====
+
+Super-entities are key tables spanning multiple entities. This allows references to multiple entities using a single foreign key.
+
+S3Model provides a number of functions to define and manipulate super entities.
+
+Read more here: [wiki:S3/S3Model/SuperEntities Super-Entities]
+
 ----