update docs contents

Author: Machometec

src/app/console/output/output.component.html

@@ -120,6 +120,9 @@ <h3>Console Color</h3>
                <li><code>DevNet\System\IO\Console::$ForegroundColor</code></li>
                <li><code>DevNet\System\IO\Console::$BackgroundColor</code></li>
             </ul>
+            <p>
+               To reset the colors back to default, use the static method <code>DevNet\System\IO\Console::resetColor()</code>
+            </p>
             <p>
                The following code example prints all the foreground and background colors, then reset the console colors to the defaults at the end.
             </p>

src/app/console/start/start.component.html

@@ -15,10 +15,14 @@ <h3>Create Console Project</h3>
                To create a DevNet console project, enter the command below in the Terminal, where the argument <code>project-name</code> is any name you give to your project:
             </p>
             <pre><code class="language-shell">devnet new console --output project-name</code></pre>
+            <p>
+               Or, using the composer command-line:
+            </p>
+            <pre><code class="language-shell">composer create-project devnet/console-template project-name</code></pre>
             <br>
             <h4>Project Structure</h4>
             <p>
-               DevNet CLI will create a simple console template with the following project structure:
+               The DevNet console project has the following folder structure:
             </p>
             <pre><code class="language-shell">console-project/
 ├── bin/
@@ -54,7 +58,11 @@ <h3>Run The Application</h3>
             </p>
             <pre><code class="language-shell">devnet run</code></pre>
             <p>
-               The program displays a <samp>"Hello World!"</samp> message in the console and ends.
+               Or, launch the application bin file directly:
+            </p>
+            <pre><code class="language-shell">./bin/run</code></pre>
+            <p>
+               The program will display a <samp>"Hello World!"</samp> message in the console.
             </p>
             <pre><code class="language-shell">Hello World!</code></pre>
          </article>

src/app/core/asynchronous/asynchronous.component.html

@@ -152,7 +152,7 @@ <h3>Async/Await Pattern</h3>
                   </a>
                </li>
                <li class="nav-page-item">
-                  <a class="nav-page-link" routerLink="/docs/core/delegate">
+                  <a class="nav-page-link" routerLink="/docs/core/delegates">
                      Next <i class="chevron right"></i>
                   </a>
                </li>

src/app/docs/docs.component.html

@@ -1,4 +1,4 @@
-<div class="d-flex flex-column justify-content-center text-center" style="height: 280px; background-color: rebeccapurple;">
+<div class="d-flex flex-column justify-content-center text-center p-3" style="min-height: 280px; background-color: rebeccapurple;">
    <h1 class="text-white display-4 mx-auto">DevNet Documentation</h1>
    <p class="lead text-white w-75 mx-auto">Learn how to use DevNet Framework for rapid application development on any
       platform, using PHP with a new experience to the next level.</p>

src/app/entity/migrations/migrations.component.html

@@ -71,37 +71,51 @@ <h4>Creating the database Schema</h4>
 &lcub;
    public function up(MigrationBuilder $builder): void
    &lcub;
-      $builder->createTable('User', function ($table) &lcub;;
+      $builder->createTable('User', function ($table) &lcub;
          $table->column('Id', 'integer')->identity(); // auto-increment
+         $table->column('Fullname', 'string', 45)->nullable(false);
          $table->column('Username', 'string', 45)->nullable(false);
          $table->column('Password', 'string', 60)->nullable(false);
+         $table->column('Role', 'string', 45)->default('User');
          $table->primaryKey('Id');
          $table->uniqueConstraint('Username');
       });
 
-      $builder->createTable('Role', function ($table) &lcub;;
+      $builder->createTable('Post', function ($table) &lcub;
+         $table->column('Id', 'integer')->identity();
+         $table->column('UserId', 'integer');
+         $table->column('Title', 'string', 60)->nullable(false);
+         $table->column('Content', 'text');
+         $table->column('Date', 'date');
+         $table->primaryKey('Id');
+         $table->foreignKey('UserId')->references('User', 'Id')->onDelete('cascade');
+      });
+
+      $builder->createTable('Category', function ($table) &lcub;
          $table->column('Id', 'integer')->identity();
          $table->column('Name', 'string', 45)->nullable(false);
-         $table->column('Description', 'string')->default('role description');
+         $table->column('Description', 'string', 255)->nullable();
          $table->primaryKey('Id');
+         $table->uniqueConstraint('Name');
       });
 
-      $builder->createTable('UserRole', function ($table) &lcub;;
-         $table->column('UserId', 'integer');
-         $table->column('RoleId', 'integer');
-         $table->primaryKey('UserId', 'RoleId');
-         $table->foreignKey('UserId')->references('User', 'Id')->onDelete('cascade');
-         $table->foreignKey('RoleId')->references('Role', 'Id')->onDelete('cascade');
+      $builder->createTable('PostCategory', function ($table) &lcub;
+         $table->column('PostId', 'integer');
+         $table->column('CategoryId', 'integer');
+         $table->primaryKey('PostId', 'CategoryId');
+         $table->foreignKey('PostId')->references('Post', 'Id')->onDelete('cascade');
+         $table->foreignKey('CategoryId')->references('Category', 'Id')->onDelete('cascade');
       });
    }
 
    public function down(MigrationBuilder $builder): void
    &lcub;
       // if the constraint ON DELETE is configured as "strict" and which is the default configuration,
       // the child table must be dropped before the parent table, otherwise will throw an error.
-      $builder->dropTable('UserRole');
+      $builder->dropTable('PostCategory');
+      $builder->dropTable('Category');
+      $builder->dropTable('Post');
       $builder->dropTable('User');
-      $builder->dropTable('Role');
    }
 }
 </code></pre>
@@ -122,17 +136,16 @@ <h4>Updating the database schema</h4>
    public function up(MigrationBuilder $builder): void
    &lcub;
       $builder->alterTable('User', function ($table) &lcub;
-         $table->addColumn('Fullname', 'string', 60);
          $table->addColumn('Email', 'string', 45);
          $table->addColumn('Phone', 'string', 15);
          $table->addColumn('Location', 'string', 45);
       });
 
-      $builder->alterTable('Role', function ($table) &lcub;
+      $builder->alterTable('Category', function ($table) &lcub;
          $table->renameColumn('Description', 'Definition');
       });
 
-      $builder->renameTable('UserRole', 'Assignment');
+      $builder->renameTable('PostCategory', 'Classification');
    }
 
    public function down(MigrationBuilder $builder): void
@@ -144,11 +157,11 @@ <h4>Updating the database schema</h4>
          $table->removeColumn('Location');
       });
 
-      $builder->alterTable('Role', function ($table) &lcub;
+      $builder->alterTable('Category', function ($table) &lcub;
          $table->renameColumn('Definition', 'Description');
       });
 
-      $builder->renameTable('Assignment', 'UserRole');
+      $builder->renameTable('Classification', 'PostCategory');
    }
 }
 </code></pre>
@@ -168,19 +181,19 @@ <h4>Seeding the database</h4>
 &lcub;
    public function up(MigrationBuilder $builder): void
    &lcub;
-      $roles = ['admin', 'moderator', 'editor', 'reader'];
+      $roles = ['uncategorized', 'featured', 'events', 'news'];
       foreach ($roles as $id => $name) &lcub;
-         $builder->insertData('Role', [
-            'Id'   => $id,
+         $builder->insertData('Category', [
+            'Id'   => ++$id,
             'Name' => $name
          ]);
       }
    }
 
    public function down(MigrationBuilder $builder): void
    &lcub;
-      for ($i=1; $i <= 4; $i++) &lcub;
-         $builder->deleteData('Role', ['Id' => $i]);
+      for ($i = 1; $i <= 4; $i++) &lcub;
+         $builder->deleteData('Category', ['Id' => $i]);
       }
    }
 }

src/app/entity/relationships/relationships.component.html

@@ -11,8 +11,8 @@ <h1>Relationships</h1>
                A relationship describes how entities are associated with each other, represented by a referential constraint that defines which entity is the principal or dependent role in the relationship, and there are many kinds of entity relationships, such as one-to-one, one-to-many, many-to-one, and many-to-many.
             </p>
             <ul>
-               <li class="mb-2"><b>Dependent entity:</b> sometimes called the 'child,' is the entity that contains the foreign key, which is a reference to the primary key of the principal entity.</li>
-               <li class="mb-2"><b>Principal entity:</b> sometimes called the 'parent,' is the entity that contains the primary key, which is referenced as a foreign key in the dependent entity.</li>
+               <li class="mb-2"><b>Dependent entity:</b> sometimes called the "child" is the entity that contains the foreign key, which is a reference to the primary key of the principal entity.</li>
+               <li class="mb-2"><b>Principal entity:</b> sometimes called the "parent" is the entity that contains the primary key, which is referenced as a foreign key in the dependent entity.</li>
             </ul>
             <h3>Navigation property:</h3>
             <p>
@@ -31,7 +31,7 @@ <h3>Navigation property:</h3>
 
 use DevNet\Entity\Annotations\ForeignKey;
 use DevNet\System\Collections\ICollection;
-use DevNet\System\Generic;
+use DevNet\System\Type;
 use DateTime;
 
 class Post
@@ -45,7 +45,7 @@ <h3>Navigation property:</h3>
    #[ForeignKey('UserId')]
    public User $User;
 
-   #[Generic(Classification::class)]
+   #[Type(ICollection::class, [Classification::class])]
    public ICollection $Classifications;
 }
 </code></pre>
@@ -85,7 +85,7 @@ <h3>One to Many</h3>
 
 $blog = new BlogContext();
 $user = $blog->Users->find($id);
-// iterating through the posts that are related to the selected user.
+// Iterating through the posts that are related to the selected user.
 foreach($user->Posts as $post) &lcub;
    $post->Title;
 }
@@ -187,7 +187,7 @@ <h3>Many to Many</h3>
 
 $blog = new BlogContext();
 $category = $blog->Categories->find($id);
-// Iterate the related entities through the junction entity.
+// Iterates the related entities through the junction entity.
 foreach($category->Classifications as $classification) &lcub;
    $classification->Post->Title;
 }

src/app/entity/save/save.component.html

@@ -70,22 +70,22 @@ <h3>Multiple Operations</h3>
 
 $blog = new BlogContext();
 
-// add new post
+// Adds new post
 $post = new Post();
 $post->Title = "Post Title";
 $post->Content = "Some content...";
 $post->Date = new DateTime("now");
 $blog->Post->add($post);
 
-// delete post with id = 2
+// Deletes post with id = 2
 $post = $blog->Post->find(2);
 $blog->Post->remove($post);
 
-// update post with id = 1
+// Updates post with id = 1
 $post = $blog->Post->find(1);
 $post->Content = "Updated content";
 
-// persist all the operations
+// Persists all the operations
 $blog->Post->save();
 </code></pre>
          </article>

src/app/entity/start/start.component.html

@@ -76,7 +76,7 @@ <h4>Entity Type</h4>
                </li>
             </ul>
             <p>
-               The following code example is the entity class <code>Application\Models\Post</code> used in the previous context, and it represents the <b>Post</b> table in the database where the properties represent the columns of that table.
+               The following code example is the entity class <code>Application\Models\Post</code> used in the previous context, and it represents the <b>"Post"</b> table in the database where the properties represent the columns of that table.
             </p>
             <pre><code class="language-php">&lt;?php
 
@@ -139,50 +139,50 @@ <h3>Connecting to the Database</h3>
 
 use Application\Models\BlogContext;
 use DevNet\Entity\EntityOptions;
-use DevNet\Entity\MySql\MySqlDataProvider;
+use DevNet\Entity\Sqlite\SqliteDataProvider;
 
 $options = new EntityOptions();
-$options->ProviderType = MySqlDataProvider::class;
-$options->ConnectionString = "//username:[email protected]/blog";
+$options->ProviderType = SqliteDataProvider::class;
+$options->ConnectionString = "/path/to/database.db3";
 
 $blog = new BlogContext($options);
 $posts = $blog->Posts;
 </code></pre>
             <br>
-            <h4>Data Providers</h4>
+            <h4>Database Providers</h4>
             <p>
-               The following table shows a list of database providers that Entity ORM supports with the corresponding connection string to each one.
+               The following table shows a list of database providers that are supported by Entity ORM.
             </p>
             <table class="table">
                <thead>
                   <tr>
-                     <th scope="col">Driver</th>
-                     <th scope="col">Data Provider</th>
-                     <th scope="col">Connection String</th>
+                     <th scope="col">Database Provider</th>
+                     <th scope="col">Database Engine</th>
                   </tr>
                </thead>
                <tbody>
                   <tr>
-                     <td>MySql</td>
                      <td><code>DevNet\Entity\MySql\MySqlDataProvider</code></td>
-                     <td><samp>"//username:[email protected]:3306/database"</samp></td>
+                     <td>MySql</td>
                   </tr>
                   <tr>
-                     <td>PostgreSql</td>
                      <td><code>DevNet\Entity\PgSql\PgSqlDataProvider</code></td>
-                     <td><samp>"//username:[email protected]:5432/database"</samp></td>
+                     <td>PostgreSql</td>
                   </tr>
                   <tr>
-                     <td>SQLite</td>
                      <td><code>DevNet\Entity\Sqlite\SqliteDataProvider</code></td>
-                     <td><samp>"//path/to/database"</samp></td>
+                     <td>SQLite</td>
                   </tr>
                </tbody>
             </table>
             <h4>Connection String</h4>
             <p>
-               The connection string used by the database providers follows the following url format:<br>
-               <code>"//[username]:[password]@[host]:[port]/[database]?[option=value]"</code>
+               The client-server database providers like "MySql" and "PostgreSql" use the following connection string format:<br>
+               <code>"host=hostname;port=port;database=dbname;user=username;password=password"</code>
+            </p>
+            <p>
+               The serverless database providers like "SQLite" use the following connection string format:<br>
+               <code>"/path/to/database.db3"</code> or <code>":memory:"</code>
             </p>
             <br>
             <h3>Registering the EntityContext</h3>
@@ -205,7 +205,7 @@ <h3>Registering the EntityContext</h3>
       $builder = WebHost::createDefaultBuilder($args);
       $configuration = $builder->Configuration;
       $builder->register(function ($services) use ($configuration) &lcub; //;
-         // adding EntityContext
+         // Adding EntityContext
          $services->addEntityContext(BlogContext::class,
             function ($options) &lcub;
                $options->ProviderType = $configuration->getValue('Database:ProviderType');
@@ -221,8 +221,8 @@ <h3>Registering the EntityContext</h3>
                In the <samp>"settings.json"</samp> file, you need to set the database configuration, like in the following example:
             </p>
             <pre><code class="language-json">"Database": &lcub;
-   "ProviderType": "DevNet\\Entity\\MySql\\MySqlDataProvider",
-   "ConnectionString": "//username:password@127.0.0.1/blog"
+   "ProviderType": "DevNet\\Entity\\PgSql\\PgSqlDataProvider",
+   "ConnectionString": "host=localhost;database=dbname;user=username;password=password"
 }
 </code></pre>
             <p>

src/app/security/authentication/authentication.component.html

@@ -70,7 +70,7 @@ <h3>Configuration</h3>
          // Adding the authentication middleware before the endpoint middleware.
          $app->useAuthentication();
          $app->useEndpoint(function ($routes) &lcub;
-            // routes
+            // Routes
          });
       });
    }
@@ -109,12 +109,12 @@ <h3>Cookie-based Authentication</h3>
             return $context->Response->setStatusCode(401);
          }
 
-         $user = new ClaimsIdentity(AuthenticationScheme::CookieSession);
-         $user->addClaim(new Claim('Username' , $form->getValue('username')));
-         $user->addClaim(new Claim('Role', $user->Role));
+         $identity = new ClaimsIdentity(AuthenticationScheme::CookieSession);
+         $identity->addClaim(new Claim('Username' , $form->getValue('username')));
+         $identity->addClaim(new Claim('Role', $user->Role));
 
          $authentication = $context->Services->getService(IAuthentication::class);
-         $authentication->signIn($user, $form->getValue('remember'));
+         $authentication->signIn($identity, $form->getValue('remember'));
       }
 
       return $context->Response->redirect('/account');

src/app/security/overview/overview.component.html

@@ -27,7 +27,7 @@ <h3>Requirement</h3>
          <nav class="no-print" aria-label="Page navigation">
             <ul class="nav-page">
                <li class="nav-page-item">
-                  <a class="nav-page-link" routerLink="/docs/web/exception">
+                  <a class="nav-page-link" routerLink="/docs/web/dependency">
                      <i class="chevron left"></i> Previous
                   </a>
                </li>