Controller maker documentation

WebBamboo · Aug 13, 2019 · efe6a96 · efe6a96
1 parent 8c6b9e6
commit efe6a96
Show file tree

Hide file tree

Showing 10 changed files with 131 additions and 105 deletions.
diff --git a/_includes/footermenu.html b/_includes/footermenu.html
@@ -4,5 +4,6 @@
  <li><a href="/material-dashboard-symfony/Configuration.html">Configuration</a></li>
  <li><a href="/material-dashboard-symfony/Usage.html">Usage</a></li>
  <li><a href="/material-dashboard-symfony/Crud.html">CRUD</a></li>
+ <li><a href="/material-dashboard-symfony/Controller.html">Controller</a></li>
  <li><a href="/material-dashboard-symfony/Notifications.html">Notifications</a></li>
 </ul>
diff --git a/docs/Controller.md b/docs/Controller.md
@@ -0,0 +1,13 @@
+---
+title: Controller
+---
+
+I've created a version of the make:controller command which automatically adds the MaterialDashboard style to the controller. You can use it as follows:
+
+```
+php bin/console material-dashboard:make:controller
+```
+
+You use it the same way you'd use the regular MakerBundle make:controller command, just follow the wizard and you'll have your styled Controllers ready in no time.
+
+{% include footermenu.html %}
diff --git a/docs/_includes/footermenu.html b/docs/_includes/footermenu.html
@@ -4,5 +4,6 @@
  <li><a href="/material-dashboard-symfony/Configuration.html">Configuration</a></li>
  <li><a href="/material-dashboard-symfony/Usage.html">Usage</a></li>
  <li><a href="/material-dashboard-symfony/Crud.html">CRUD</a></li>
+ <li><a href="/material-dashboard-symfony/Controller.html">Controller</a></li>
  <li><a href="/material-dashboard-symfony/Notifications.html">Notifications</a></li>
 </ul>
diff --git a/docs/_site/Configuration.html b/docs/_site/Configuration.html
@@ -80,5 +80,6 @@ <h2 id="step-by-step-explanation">Step by step explanation</h2>
  <li><a href="/material-dashboard-symfony/Configuration.html">Configuration</a></li>
  <li><a href="/material-dashboard-symfony/Usage.html">Usage</a></li>
  <li><a href="/material-dashboard-symfony/Crud.html">CRUD</a></li>
+ <li><a href="/material-dashboard-symfony/Controller.html">Controller</a></li>
  <li><a href="/material-dashboard-symfony/Notifications.html">Notifications</a></li>
 </ul>
diff --git a/docs/_site/Controller.html b/docs/_site/Controller.html
@@ -0,0 +1,16 @@
+<p>I’ve created a version of the make:controller command which automatically adds the MaterialDashboard style to the controller. You can use it as follows:</p>
+
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>php bin/console material-dashboard:make:controller
+</code></pre></div></div>
+
+<p>You use it the same way you’d use the regular MakerBundle make:controller command, just follow the wizard and you’ll have your styled Controllers ready in no time.</p>
+
+<p><b>Table of contents: </b></p>
+<ul>
+ <li><a href="/material-dashboard-symfony/Installation.html">Installation</a></li>
+ <li><a href="/material-dashboard-symfony/Configuration.html">Configuration</a></li>
+ <li><a href="/material-dashboard-symfony/Usage.html">Usage</a></li>
+ <li><a href="/material-dashboard-symfony/Crud.html">CRUD</a></li>
+ <li><a href="/material-dashboard-symfony/Controller.html">Controller</a></li>
+ <li><a href="/material-dashboard-symfony/Notifications.html">Notifications</a></li>
+</ul>
diff --git a/docs/_site/Crud.html b/docs/_site/Crud.html
@@ -13,5 +13,6 @@
  <li><a href="/material-dashboard-symfony/Configuration.html">Configuration</a></li>
  <li><a href="/material-dashboard-symfony/Usage.html">Usage</a></li>
  <li><a href="/material-dashboard-symfony/Crud.html">CRUD</a></li>
+ <li><a href="/material-dashboard-symfony/Controller.html">Controller</a></li>
  <li><a href="/material-dashboard-symfony/Notifications.html">Notifications</a></li>
 </ul>
diff --git a/docs/_site/Installation.html b/docs/_site/Installation.html
@@ -8,5 +8,6 @@
  <li><a href="/material-dashboard-symfony/Configuration.html">Configuration</a></li>
  <li><a href="/material-dashboard-symfony/Usage.html">Usage</a></li>
  <li><a href="/material-dashboard-symfony/Crud.html">CRUD</a></li>
+ <li><a href="/material-dashboard-symfony/Controller.html">Controller</a></li>
  <li><a href="/material-dashboard-symfony/Notifications.html">Notifications</a></li>
 </ul>
diff --git a/docs/_site/Notifications.html b/docs/_site/Notifications.html
@@ -1,112 +1,101 @@
 <p>A simple notifications system is bundled with this code, you can easily modify it if needed or implement your own. In order to make use of it you have to go through a few steps:</p>
 <ol>
- <li>Create the Notification Entity. IMPORTANT Note that this system assumes your user entity is App\Entity\User adjust if needed:
-```
-&lt;?php</li>
+ <li>Create the Notification Entity. IMPORTANT Note that this system assumes your user entity is App\Entity\User adjust if needed:</li>
 </ol>
 
-<p>namespace App\Entity;</p>
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>&lt;?php
 
-<p>use Doctrine\ORM\Mapping as ORM;
-use Webbamboo\MaterialDashboard\Model\NotificationInterface;</p>
+namespace App\Entity;
 
-<p>/**</p>
-<ul>
- <li>@ORM\Entity(repositoryClass=”App\Repository\NotificationRepository”)
+use Doctrine\ORM\Mapping as ORM;
+use Webbamboo\MaterialDashboard\Model\NotificationInterface;
+
+/**
+ * @ORM\Entity(repositoryClass="App\Repository\NotificationRepository")
  */
 class Notification implements NotificationInterface
 {
- /**
- <ul>
- <li>@ORM\Id()</li>
- <li>@ORM\GeneratedValue()</li>
- <li>@ORM\Column(type=”integer”)
- */
- private $id;</li>
- </ul>
-
- <p>/**</p>
- <ul>
- <li>@ORM\ManyToOne(targetEntity=”App\Entity\User”, inversedBy=”notifications”)
- */
- private $user;</li>
- </ul>
-
- <p>/**</p>
- <ul>
- <li>@ORM\Column(type=”array”, nullable=true)
- */
- private $data = [];</li>
- </ul>
-
- <p>/**</p>
- <ul>
- <li>@ORM\Column(type=”text”)
- */
- private $description;</li>
- </ul>
-
- <p>/**</p>
- <ul>
- <li>@ORM\Column(type=”datetimetz”)
- */
- private $created;</li>
- </ul>
-
- <p>public function getId(): ?int
- {
- return $this-&gt;id;
- }</p>
-
- <p>public function getUser(): ?User
- {
- return $this-&gt;user;
- }</p>
-
- <p>public function setUser(?User $user): self
- {
- $this-&gt;user = $user;</p>
-
- <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code> return $this; }
-</code></pre></div> </div>
-
- <p>public function getData(): ?array
- {
- return $this-&gt;data;
- }</p>
-
- <p>public function setData(?array $data): self
- {
- $this-&gt;data = $data;</p>
-
- <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code> return $this; }
-</code></pre></div> </div>
-
- <p>public function getDescription(): ?string
- {
- return $this-&gt;description;
- }</p>
-
- <p>public function setDescription(string $description): self
- {
- $this-&gt;description = $description;</p>
-
- <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code> return $this; }
-</code></pre></div> </div>
-
- <p>public function getCreated(): ?\DateTimeInterface
- {
- return $this-&gt;created;
- }</p>
-
- <p>public function setCreated(\DateTimeInterface $created): self
- {
- $this-&gt;created = $created;</p>
-
- <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code> return $this; } } ```
-</code></pre></div> </div>
- </li>
-</ul>
+ /**
+ * @ORM\Id()
+ * @ORM\GeneratedValue()
+ * @ORM\Column(type="integer")
+ */
+ private $id;
+
+ /**
+ * @ORM\ManyToOne(targetEntity="App\Entity\User", inversedBy="notifications")
+ */
+ private $user;
+
+ /**
+ * @ORM\Column(type="array", nullable=true)
+ */
+ private $data = [];
+
+ /**
+ * @ORM\Column(type="text")
+ */
+ private $description;
+
+ /**
+ * @ORM\Column(type="datetimetz")
+ */
+ private $created;
+
+ public function getId(): ?int
+ {
+ return $this-&gt;id;
+ }
+
+ public function getUser(): ?User
+ {
+ return $this-&gt;user;
+ }
+
+ public function setUser(?User $user): self
+ {
+ $this-&gt;user = $user;
+
+ return $this;
+ }
+
+ public function getData(): ?array
+ {
+ return $this-&gt;data;
+ }
+
+ public function setData(?array $data): self
+ {
+ $this-&gt;data = $data;
+
+ return $this;
+ }
+
+ public function getDescription(): ?string
+ {
+ return $this-&gt;description;
+ }
+
+ public function setDescription(string $description): self
+ {
+ $this-&gt;description = $description;
+
+ return $this;
+ }
+
+ public function getCreated(): ?\DateTimeInterface
+ {
+ return $this-&gt;created;
+ }
+
+ public function setCreated(\DateTimeInterface $created): self
+ {
+ $this-&gt;created = $created;
+
+ return $this;
+ }
+}
+</code></pre></div></div>
 
 <ol>
  <li>Once that is done update your database running:
@@ -122,13 +111,13 @@
  Webbamboo\MaterialDashboard\Model\NotificationInterface: App\Entity\Notification
 </code></pre></div> </div>
  </li>
- <li>Once the configuration is done you can clear the cache and run the following command to test the notification system:
- <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>php bin/console cache:clear
-php bin/console material-dashboard:test-notification
-</code></pre></div> </div>
- </li>
+ <li>Once the configuration is done you can clear the cache and run the following command to test the notification system:</li>
 </ol>
 
+<div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>php bin/console cache:clear
+php bin/console material-dashboard:test-notification
+</code></pre></div></div>
+
 <p>Now the user you’ve chosen in the command wizard will get the notification in their dashboard. Usually the notifications appear within 15 seconds without refresh.</p>
 
 <p><b>Table of contents: </b></p>
@@ -137,5 +126,6 @@
  <li><a href="/material-dashboard-symfony/Configuration.html">Configuration</a></li>
  <li><a href="/material-dashboard-symfony/Usage.html">Usage</a></li>
  <li><a href="/material-dashboard-symfony/Crud.html">CRUD</a></li>
+ <li><a href="/material-dashboard-symfony/Controller.html">Controller</a></li>
  <li><a href="/material-dashboard-symfony/Notifications.html">Notifications</a></li>
 </ul>
diff --git a/docs/_site/Usage.html b/docs/_site/Usage.html
@@ -164,5 +164,6 @@ <h3 id="table-helper">Table Helper</h3>
  <li><a href="/material-dashboard-symfony/Configuration.html">Configuration</a></li>
  <li><a href="/material-dashboard-symfony/Usage.html">Usage</a></li>
  <li><a href="/material-dashboard-symfony/Crud.html">CRUD</a></li>
+ <li><a href="/material-dashboard-symfony/Controller.html">Controller</a></li>
  <li><a href="/material-dashboard-symfony/Notifications.html">Notifications</a></li>
 </ul>
diff --git a/docs/_site/index.html b/docs/_site/index.html
@@ -6,5 +6,6 @@
  <li><a href="/material-dashboard-symfony/Configuration.html">Configuration</a></li>
  <li><a href="/material-dashboard-symfony/Usage.html">Usage</a></li>
  <li><a href="/material-dashboard-symfony/Crud.html">CRUD</a></li>
+ <li><a href="/material-dashboard-symfony/Controller.html">Controller</a></li>
  <li><a href="/material-dashboard-symfony/Notifications.html">Notifications</a></li>
 </ul>