Changeset 2951

Timestamp:

09/27/08 17:43:42 (8 weeks ago)

Author:

mikeseth

Message:

clear up confusion with the base model

Location:

documentation/trunk

Files:

• stages/stage2/app/lib/model/BlogBaseModel.class.php (modified) (1 diff)
• stages/stage3/app/lib/model/BlogBaseModel.class.php (modified) (1 diff)
• topics/creating-models.dita (modified) (2 diffs)
• topics/examples.xml (modified) (1 diff)

documentation/trunk/stages/stage2/app/lib/model/BlogBaseModel.class.php

@@ -12 +12 @@
   protected function getPdo()
   {
+    // The connection parameters are configured in app/config/databases.xml
     return $this->context->getDatabaseManager()->getDatabase()->getConnection('blog');
   }

documentation/trunk/stages/stage3/app/lib/model/BlogBaseModel.class.php

@@ -12 +12 @@
   protected function getPdo()
   {
+    // The connection parameters are configured in app/config/databases.xml
     return $this->context->getDatabaseManager()->getDatabase()->getConnection('blog');
   }

documentation/trunk/topics/creating-models.dita

@@ -29 +29 @@
     methods: one to return the contents of the front page (a list of the most
     recent posts) and one to find a specific post given its ID. To do this,
-    you need to create a new Model! The project configuration system eases
-    your job immensely:</p><p><screen>bloggie$ <userinput>agavi project-model-create</userinput>
+    you need to create a new Model. The project configuration system eases
+    your job immensely:</p><p>
+  <screen>bloggie$ <userinput>agavi model-create</userinput>
+
+Module name: <userinput>Public</userinput>
 
 Model name: <userinput>Posts</userinput>
-     [copy] Copying 1 file to /home/nfontes/bloggie/app/models</screen>You now
-    have an empty Posts Model class ready to be populated with application
-    logic:</p>
-      <codeblock conref="examples.xml#stage2-posts-model" class="php"/>
-      <p>The Posts Model contains two very simple methods. The first
+     [copy] Copying 1 file to [...]/app/modules/Public/models</screen>
+  </p>
+      <p>You now have an empty Posts Model class ready to be populated
+    with application logic:</p>
+    <codeblock conref="examples.xml#stage2-posts-model" class="php"/>
+    <p>Note that in the base Model class for Bloggie
+    (<filepath>app/lib/models/BlogBaseModel.class.php</filepath>) we
+    have a <apiname>getPdo()</apiname> method which we presume all of our future models
+    would want to use:</p>
+    <codeblock conref="examples.xml#stage2-base-model" class="php"/>
+    <p>The Posts Model contains two very simple methods. The first
     is <apiname>findPostById</apiname>, which accepts an ID parameter
     and returns corresponding post data as a single dimensional
@@ -45 +54 @@
     posts themselves. Both methods obtain the connection from Agavi's
     database manager, perform an SQL query against it and return the
-    results.</p><p><note type="important">We will soon discover that
-    we need more than one Model to handle posts!</note></p><p>As we
-    already have some dummy data in the database, we can now proceed
-    to make working pages that utilize our new Model.</p></section>
+    results.</p>
+    <p>As we already have some dummy data in the database, we can now
+    proceed to make working pages that utilize our new
+    Model.</p></section>
   </body>
 </topic>

documentation/trunk/topics/examples.xml

@@ -41 +41 @@
  </configuration>
 </configurations>
+</codeblock>
+<codeblock id="stage2-base-model">
+  /**
+  * The base model from which all project models inherit.
+  */
+
+class BlogBaseModel extends AgaviModel
+{
+  /**
+   * Return the PDO resource needed to access the blog database
+   * @return PDO
+   */
+  protected function getPdo()
+  {
+    // The connection parameters are configured in app/config/databases.xml
+    return $this->context->getDatabaseManager()->getDatabase()->getConnection('blog');
+  }
+}
+
+?>
 </codeblock>
 <codeblock id="stage2-posts-model">