API Deprecate API being removed in CMS 6

silverstripe · Feb 26, 2025 · 388a29d · 388a29d
1 parent 4d950df
commit 388a29d
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 1 deletion.
diff --git a/src/Forms/GridField/GridFieldFilterHeader.php b/src/Forms/GridField/GridFieldFilterHeader.php
@@ -318,9 +318,14 @@ public function setSearchContext(SearchContext $context): static
      *
      * @param GridField $gridfield
      * @return string
+     * @deprecated 5.4.0 Will be replaced with SilverStripe\ORM\Search\SearchContextForm::getSchemaData()
      */
     public function getSearchFieldSchema(GridField $gridField)
     {
+        Deprecation::noticeWithNoReplacment(
+            '5.4.0',
+            'Will be replaced with SilverStripe\ORM\Search\SearchContextForm::getSchemaData()'
+        );
         $schemaUrl = Controller::join_links($gridField->Link(), 'schema/SearchForm');
         $inst = singleton($gridField->getModelClass());
         $context = $this->getSearchContext($gridField);
@@ -424,17 +429,22 @@ public function getSearchForm(GridField $gridField)
      *
      * @param GridField $gridfield
      * @return HTTPResponse
+     * @deprecated 5.4.0 Will be replaced with SilverStripe\Forms\FormRequestHandler::getSchema()
      */
     public function getSearchFormSchema(GridField $gridField)
     {
+        Deprecation::noticeWithNoReplacment(
+            '5.4.0',
+            'Will be replaced with SilverStripe\Forms\FormRequestHandler::getSchema()'
+        );
         $form = $this->getSearchForm($gridField);
 
         // If there are no filterable fields, return a 400 response
         if (!$form) {
             return new HTTPResponse(_t(__CLASS__ . '.SearchFormFaliure', 'No search form could be generated'), 400);
         }
 
-        $parts = $gridField->getRequest()->getHeader(LeftAndMain::SCHEMA_HEADER);
+        $parts = $gridField->getRequest()->getHeader(FormSchema::SCHEMA_HEADER);
         $schemaID = $gridField->getRequest()->getURL();
         $data = FormSchema::singleton()
             ->getMultipartSchema($parts, $schemaID, $form);

diff --git a/src/Forms/Schema/FormSchema.php b/src/Forms/Schema/FormSchema.php
@@ -40,6 +40,11 @@ class FormSchema
      */
     const PART_AUTO = 'auto';
 
+    /**
+     * Form schema header identifier
+     */
+    public const SCHEMA_HEADER = 'X-Formschema-Request';
+
     /**
      * Returns a representation of the provided {@link Form} as structured data,
      * based on the request data.