Add docs for cakephp/cakephp#18136

cakephp · Jan 23, 2025 · 8275518 · 8275518
1 parent 25c978b
commit 8275518
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/en/appendices/5-2-migration-guide.rst b/en/appendices/5-2-migration-guide.rst
@@ -81,6 +81,10 @@ ORM
 - ``CounterCacheBehavior::updateCounterCache()`` has been addded. This method
   allows you to update the counter cache values for all records of the configured
   associations.
+- ``BelongsToMany::setJunctionProperty()`` and ``getJunctionProperty()`` were
+  added. These methods allow you to customize the ``_joinData`` property that is
+  used to hydrate junction table records.
+
 
 View
 ----

diff --git a/en/orm/saving-data.rst b/en/orm/saving-data.rst
@@ -1070,7 +1070,18 @@ from request data your POST data should look like::
     ]);
 
 See the :ref:`associated-form-inputs` documentation for how to build inputs with
-``FormHelper`` correctly.
+``FormHelper`` correctly. As of 5.2.0, the ``_joinData`` property can be renamed
+with ``setJunctionProperty()``::
+
+    // in StudentsTable::initialize()
+    $this->belongsToMany('Courses')
+        ->setJunctionProperty('course_mark');
+
+When a junction property is set, the new junction property name must be used to
+manipulate entities, marshall request data, and create form fields.
+
+.. versionadded:: 5.2.0
+    Custom junction property names were added.
 
 .. _saving-complex-types: