examples

Author: Peter Kubov

docs/cores.rst

@@ -222,6 +222,20 @@ Method ``per_save_model`` is called before saving object to database. Body is em
 
 Method ``post_save_model`` is called after saving object to database. Body is empty by default.
 
+**Example: Additional Processing After Save**
+
+Use ``post_save_model`` to perform additional processing after an object is successfully saved::
+
+    class CustomerCore(DjangoUiRestCore):
+        model = Customer
+
+        def post_save_model(self, request, obj, form, change):
+            super().post_save_model(request, obj, form, change)
+
+            # Trigger communication for newly registered customers
+            if not change:  # Only for new customers
+                trigger_customer_registered_communication(obj)
+
 .. method:: DjangoCore.save_model(request, obj, form, change)
 
 You can rewrite this method if you want to change way how is object saved to database. Default body is::
@@ -297,6 +311,21 @@ Every UI core has one place inside menu that addresses one of UI views of a core
 Option `show_in_menu` is set to ``True`` by default. If you want to remove core view from menu set this option to
 ``False``.
 
+**Example**
+
+In production, you often have utility cores that shouldn't appear in navigation::
+
+    class CustomerImportCore(DjangoUiRestCore):
+        """Internal core for CSV import - not shown in menu"""
+        model = Customer
+        show_in_menu = False  # Hidden from navigation
+        menu_url_name = None  # No menu link
+
+    class CustomerAuditLogCore(DjangoRestCore):
+        """API-only core for audit logs"""
+        model = CustomerAuditLog
+        show_in_menu = False  # REST-only, no UI
+
 .. attribute:: UiCore.view_classes
 
 Option contains view classes that are automatically added to Django urls. Use this option to add new views. Example
@@ -317,6 +346,37 @@ you can see in section generic views (this is a declarative way if you want to r
             ('reports', r'^/reports/$', MonthReportView),
         )
 
+**Example**
+
+In real-world applications, you often need to register many custom views with specific permissions::
+
+    class CustomerCore(DjangoUiRestCore):
+        model = Customer
+
+        view_classes = (
+            # Custom detail view with tabs
+            ('change', r'^/(?P<pk>[^/]+)/$', CustomerDetailView, False, False),
+
+            # Related object management
+            ('add-address', r'^/(?P<customer_pk>[^/]+)/address/add/$', AddressAddView, False, True),
+            ('edit-address', r'^/(?P<customer_pk>[^/]+)/address/(?P<pk>[^/]+)/$', AddressDetailView, False, False),
+
+            # Custom actions with parent scoping
+            ('activate', r'^/(?P<pk>[^/]+)/activate/$', CustomerActivateView, False, False),
+            ('deactivate', r'^/(?P<pk>[^/]+)/deactivate/$', CustomerDeactivateView, False, False),
+
+            # Bulk operations
+            ('bulk-export', r'^/bulk-export/$', CustomerBulkExportView, False, False),
+        )
+
+The tuple format is: ``(url_name_suffix, url_pattern, view_class, can_create, can_delete)``
+
+- ``url_name_suffix``: Suffix added to core's base URL name
+- ``url_pattern``: Regular expression for URL matching
+- ``view_class``: The view class to use
+- ``can_create``: Boolean indicating if this view can create objects (default: False)
+- ``can_delete``: Boolean indicating if this view can delete objects (default: False)
+
 .. attribute:: UiCore.default_ui_pattern_class
 
 Every view must have assigned is-core pattern class. This pattern is not the same patter that is used with **django**