Skip to content

Commit

Permalink
FIX Update comments on src/DataObject/DataObjectDocument.php
Browse files Browse the repository at this point in the history
Co-authored-by: Bernard Hamlin <[email protected]>
  • Loading branch information
Marco Hermo and blueo authored Apr 10, 2024
1 parent 4109616 commit 00384eb
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions src/DataObject/DataObjectDocument.php
Original file line number Diff line number Diff line change
Expand Up @@ -372,9 +372,11 @@ public function getFieldValue(Field $field): mixed
}

/**
* Collects related documents based on the underlying relationship of their DataObjects.
* These data are typically joined by $has_many or $many_many configured on searcheable classes
* defined by their fields to be indexed. Other relationships are considered a rare case.
* Collects documents that depend on the current DataObject for indexing.
* It will inspect the search index configuration for anything using this object in a field or, if the
* current object is an instance of SiteTree, it will respect `enforce_strict_hierarchy`
* and add any child objects.
* @see [the dependency tracking docs](docs/en/usage.md#dependency-tracking)
*
* @return DocumentInterface[]
*/
Expand Down

0 comments on commit 00384eb

Please sign in to comment.