Merge pull request #1245 from hydephp/deprecate-canonical-url-property

emmadesilva · web-flow · commit 828e6928d815 · 2023-03-11T14:56:09.000+01:00
Deprecate HydePage canonical url property
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -16,7 +16,7 @@ This serves two purposes:
 - for changes in existing functionality.
 
 ### Deprecated
-- for soon-to-be removed features.
+- HydePage::$canonicalUrl
 
 ### Removed
 - for now removed features.
diff --git a/packages/framework/src/Markdown/Contracts/FrontMatter/PageSchema.php b/packages/framework/src/Markdown/Contracts/FrontMatter/PageSchema.php
@@ -13,7 +13,7 @@ interface PageSchema extends FrontMatterSchema
 {
     public const PAGE_SCHEMA = [
         'title'         => 'string',
-        'canonicalUrl'  => 'string',
+        'canonicalUrl'  => 'string', // DEPRECATED
         'navigation'    => NavigationSchema::NAVIGATION_SCHEMA,
     ];
 }
diff --git a/packages/framework/src/Pages/Concerns/HydePage.php b/packages/framework/src/Pages/Concerns/HydePage.php
@@ -67,6 +67,8 @@ abstract class HydePage implements PageSchema, SerializableContract
     public NavigationData $navigation;
 
     public string $title;
+
+    /** @deprecated v1.0.0-RC.3 - This property requires information that is setup-dependent, and will work better through a runtime accessor. Since it is mainly related to blog posts, it will be moved there. */
     public ?string $canonicalUrl;
 
     public static function make(string $identifier = '', FrontMatter|array $matter = []): static

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ interface PageSchema extends FrontMatterSchema`
`13`	`13`	`{`
`14`	`14`	`public const PAGE_SCHEMA = [`
`15`	`15`	`'title' => 'string',`
`16`		`- 'canonicalUrl' => 'string',`
	`16`	`+ 'canonicalUrl' => 'string', // DEPRECATED`
`17`	`17`	`'navigation' => NavigationSchema::NAVIGATION_SCHEMA,`
`18`	`18`	`];`
`19`	`19`	`}`