Changes between Version 38 and Version 39 of S3/S3Model/ComponentResources

Timestamp:

02/02/14 21:49:32 (11 years ago)

Author:

Dominic König

Comment:

--

S3/S3Model/ComponentResources

@@ -32 +32 @@
 Besides simplified construction of queries and views, it also facilitates keyless (=implicit) constraints e.g. in CRUD forms and XML imports:
 
-{{{
+{{{#!xml
 <s3xml>
     <!-- an organisation record -->
@@ -56 +56 @@
 == Component Definition ==
 
-Components are defined using the {{{s3db.add_component}}} method.
+Components are defined using the {{{s3db.add_components}}} method.
 
-{{{
-s3db.add_component(<component_name>, <master_name>=<join>, <master_name>=<join>, ...)
+{{{#!python
+s3db.add_components(<master_name>, <component_name>=<join>, <component_name>=<join>, ...)
 }}}
 
@@ -66 +66 @@
 For simple components, it is sufficient to specify the foreign key as join:
 
-{{{
-s3db.add_component("org_office", org_organisation="organisation_id")
+{{{#!python
+s3db.add_components("org_organisation", org_office="organisation_id")
 }}}
 
 This assumes that the component alias is the same as the name of the component table without prefix, e.g. {{{tablename = "org_office" => component alias = "office"}}}. If you want set the alias explicitly, you can instead describe the join in a dict:
 
-{{{
-s3db.add_component("org_office", org_organisation={
-                                        "name": "headquarter",          # the component alias
-                                        "joinby": "organisation_id"     # the foreign key
-                                 })
+{{{#!python
+s3db.add_components("org_organisation", 
+                    org_office={"name": "headquarter",       # the component alias
+                                "joinby": "organisation_id", # the foreign key
+                               })
 }}}
 
 Component joins can be filtered, so that only a subset of the records in the component table forms the actual component:
 
-{{{
-s3db.add_component("org_office", org_organisation={
-                                        "name": "headquarter",          # the component alias
-                                        "joinby": "organisation_id"     # the foreign key
-                                        "filterby": "office_type_id",   # the name of the field in the component table to filter by
-                                        "filterfor": 4,                 # the value(s) to filter for
-                                 })
+{{{#!python
+s3db.add_components("org_organisation", 
+                    org_office={"name": "headquarter",        # the component alias
+                                "joinby": "organisation_id"   # the foreign key
+                                "filterby": "office_type_id", # the name of the field in the component table to filter by
+                                "filterfor": 4,               # the value(s) to filter for
+                               })
 }}}
 
@@ -98 +98 @@
 This requirement is often called "singe-record component" or "subtable", and can be defined in the join dict:
 
-{{{
-s3db.add_component("org_office", org_organisation={
-                                        "name": "headquarter",          # the component alias
-                                        "joinby": "organisation_id"     # the foreign key
-                                        "filterby": "office_type_id",   # the name of the field in the component table to filter by
-                                        "filterfor": 4,                 # the value(s) to filter for
-                                        "multiple": False               # there can be only one component record per master record
-                                 })
+{{{#!python
+s3db.add_components("org_organisation", 
+                    org_office={"name": "headquarter",        # the component alias
+                                "joinby": "organisation_id"   # the foreign key
+                                "filterby": "office_type_id", # the name of the field in the component table to filter by
+                                "filterfor": 4,               # the value(s) to filter for
+                                "multiple": False             # there can be only one component record per master record
+                               })
 }}}
 
@@ -158 +158 @@
 The basic syntax of a link-table component link declaration is:
 
-{{{
-s3db.add_component("my_component",               # Tablename of the component
-                   my_master=dict(               # Tablename of the master table
-                       name="alias",             # Use this 'alias' as the component name
-                       link="my_linktable",      # Tablename of the link table
-                       joinby="fieldname",       # FK of the master table (=left key constraint)
-                       key="fieldname",          # FK of the component table (=right key constraint)
-                       actuate="replace",        # Actuation option (see above, optional, defaults to "link")
-                       autodelete=False          # Delete the component record together with the last link (optional, default is False)
-                       widget=Widget,            # Widget to use for embedding (optional, defaults to S3EmbedComponentWidget)
-                       autocomplete="fieldname", # Field in the component to use for autocomplete when embedding the component
-                   ))
-                              
+{{{#!python
+s3db.add_components("my_master",                  # Tablename of the master table
+                    my_component={                # Tablename of the component
+                        name="alias",             # Use this 'alias' as the component name
+                        link="my_linktable",      # Tablename of the link table
+                        joinby="fieldname",       # FK of the master table (=left key constraint)
+                        key="fieldname",          # FK of the component table (=right key constraint)
+                        actuate="replace",        # Actuation option (see above, optional, defaults to "link")
+                        autodelete=False          # Delete the component record together with the last link (optional, default is False)
+                        widget=Widget,            # Widget to use for embedding (optional, defaults to S3EmbedComponentWidget)
+                        autocomplete="fieldname", # Field in the component to use for autocomplete when embedding the component
+                    })                          
 }}}