add and polish phpdocs

Author: johguentner

src/Builder/DatabaseBuilder.php

@@ -11,8 +11,15 @@
  */
 class DatabaseBuilder
 {
+    /**
+     * @var array
+     */
     private array $payload;
 
+    /**
+     * DatabaseBuilder constructor.
+     * @param Databases $databasesEndpoint
+     */
     public function __construct(private Databases $databasesEndpoint)
     {
         $this->payload = [
@@ -29,6 +36,12 @@ public function __construct(private Databases $databasesEndpoint)
         ];
     }
 
+    /**
+     * Creates database within given page.
+     * 
+     * @param string $pageId
+     * @return Database
+     */
     public function createInPage($pageId): Database
     {
         $this->payload['parent'] = [
@@ -43,6 +56,12 @@ public function createInPage($pageId): Database
         return $this->databasesEndpoint->create($this->payload());
     }
 
+    /**
+     * Sets the title for the database creation.
+     * 
+     * @param string $title
+     * @return DatabaseBuilder
+     */
     public function title(string $title): DatabaseBuilder
     {
         $this->payload['title'] = [
@@ -56,6 +75,12 @@ public function title(string $title): DatabaseBuilder
         return $this;
     }
 
+    /**
+     * Sets the description for the database creation.
+     * 
+     * @param string $description
+     * @return DatabaseBuilder
+     */
     public function description(string $description): DatabaseBuilder
     {
         $this->payload['description'] = [
@@ -69,13 +94,25 @@ public function description(string $description): DatabaseBuilder
         return $this;
     }
 
+    /**
+     * Sets the created database as inline (currently not supported).
+     * @todo increase Notion API Version, to make this work
+     * 
+     * @return DatabaseBuilder
+     */
     public function inline(): DatabaseBuilder
     {
         $this->payload['is_inline'] = true;
 
         return $this;
     }
 
+    /**
+     * Sets the icon for the database creation.
+     * 
+     * @param string $icon
+     * @return DatabaseBuilder
+     */
     public function iconEmoji(string $icon): DatabaseBuilder
     {
         $this->payload['icon'] = [
@@ -86,6 +123,12 @@ public function iconEmoji(string $icon): DatabaseBuilder
         return $this;
     }
 
+    /**
+     * Sets the icon for the database creation.
+     * 
+     * @param string $url
+     * @return DatabaseBuilder
+     */
     public function iconExternal(string $url): DatabaseBuilder
     {
         $this->payload['icon'] = [
@@ -98,6 +141,12 @@ public function iconExternal(string $url): DatabaseBuilder
         return $this;
     }
 
+    /**
+     * Sets the cover for the database creation.
+     * 
+     * @param string $url
+     * @return DatabaseBuilder
+     */
     public function coverExternal(string $url): DatabaseBuilder
     {
         $this->payload['cover'] = [
@@ -110,13 +159,25 @@ public function coverExternal(string $url): DatabaseBuilder
         return $this;
     }
 
+    /**
+     * Adds the property `title` database creation.
+     * 
+     * @param string $name
+     * @return DatabaseBuilder
+     */
     public function addTitle(string $name = 'Name')
     {
         $this->add(PropertyBuilder::title($name));
 
         return $this;
     }
 
+    /**
+     * Adds one or multiple properties to the database creation.
+     * 
+     * @param PropertyBuilder|Collection|DatabaseSchemeBuilder $properties
+     * @return DatabaseBuilder
+     */
     public function add(PropertyBuilder|Collection|DatabaseSchemeBuilder $properties): DatabaseBuilder
     {
         if ($properties instanceof PropertyBuilder) {
@@ -134,6 +195,12 @@ public function add(PropertyBuilder|Collection|DatabaseSchemeBuilder $properties
         return $this;
     }
 
+    /**
+     * Adds multiple properties to the database creation, similar to a Laravel migration.
+     * 
+     * @param callable $callback
+     * @return DatabaseBuilder
+     */
     public function scheme(callable $callback): DatabaseBuilder
     {
         $builder = new DatabaseSchemeBuilder();
@@ -142,6 +209,14 @@ public function scheme(callable $callback): DatabaseBuilder
         return $this->add($builder);
     }
 
+    /**
+     * Adds a raw property to the database creation.
+     * 
+     * @param string $title
+     * @param string $propertyType
+     * @param array|null $content
+     * @return DatabaseBuilder
+     */
     public function addRaw(string $title, string $propertyType, array $content = null): DatabaseBuilder
     {
         $this->payload['properties'][$title] = [];
@@ -150,6 +225,11 @@ public function addRaw(string $title, string $propertyType, array $content = nul
         return $this;
     }
 
+    /**
+     * Returns the payload for the database creation.
+     * 
+     * @return array
+     */
     public function payload(): array
     {
         return $this->payload;