Changes between Version 9 and Version 10 of DolphinTutorialMyFirstModule

Timestamp:

Jan 29, 2010, 6:38:33 AM (15 years ago)

Author:

AlexT

Comment:

--

DolphinTutorialMyFirstModule

@@ -739 +739 @@
 == 4.3. View Bloggie post page. ==
 
+Add the following function to the '''MeBlggModule''' class:
+
+
+{{{
+    function actionView ($iEntryId) {
+
+        $aEntry = $this->_oDb->getEntryById ((int)$iEntryId);
+        if (!$aEntry) { // check if entry exists
+            $this->_oTemplate->displayPageNotFound ();
+            return;
+        }
+
+        $this->_oTemplate->pageStart(); // all the code below will be wrapped by the user design
+
+        $aVars = array (
+            'title' => $aEntry['title'],
+            'text' => $aEntry['text'],
+            'author' => getNickName($aEntry['author_id']),
+            'added' => defineTimeInterval($aEntry['added']),
+        );
+        echo $this->_oTemplate->parseHtmlByName('view', $aVars); // display post
+
+        $this->_oTemplate->pageCode($aEntry['title'], true); // output is completed, display all output above data wrapped by user design
+    }
+}}}
+
+This is the first time where our function accepts any parameters:
+
+    * '''$iEntryId''' function parameter will be passed when we call the following URL: '''http://www.your-site.com/your-path/m/bloggie/view/15''', in this case '''$iEntryId''' will be equal to "'''15'''".
+    * '''getNickName''' is the system function which returns the user name by user id.
+    * '''defineTimeInterval''' function generates a human readable representation of the unix timestamp date/time.
+    * '''displayPageNotFound''' displays a message like "Page Not Found" along with HTTP 404 headers.
+    * '''getEntryById''' is the database function which is created below.
+
+Add the following method to the '''MeBlggDb''' class:
+
+{{{
+    function getEntryById ($iEntryId) {
+        return $this->getRow("SELECT * FROM `" . $this->_sPrefix . "posts` WHERE `id` = '$iEntryId'");
+    }
+}}}
+
+We have already described database functions, and there is nothing to clarify. The only thing is that it is good practice to use the '''$this->_sPrefix''' variable as the database prefix for the module's tables.
+
+The last thing is the '''bloggie/templates/base/view.html''' file:
+
+{{{
+<div>
+    <h1>__title__</h1>
+    <p>__text__</p>
+    <p style="text-align:right; font-style:italic;"><bx_text:_me_blgg_posted_by /> __author__ (__added__)</p>
+</div>
+}}}
+
+This file looks extremely simple.
+
+Try to add some Bloggie post and you will be redirected to the view post page.
+
+Now the only page we are missing is the page with the posts list.
+
+
+== 4.4. Creating Bloggie homepage with a posts list. ==
+
+Change the '''actionHome''' function the following way:
+
+{{{
+    function actionHome () {
+        $this->_oTemplate->pageStart(); // all the code below will be wrapped by the user design
+
+        $aPosts = $this->_oDb->getAllPosts (getParam('me_blgg_max_posts_to_show')); // get all posts from database
+        foreach ($aPosts as $sKey => $aRow) { // add human readable values to the resulted array
+            $aPosts[$sKey]['url'] = BX_DOL_URL_ROOT . $this->_oConfig->getBaseUri() . 'view/' . $aRow['id'];
+            $aPosts[$sKey]['added'] = defineTimeInterval($aRow['added']);
+            $aPosts[$sKey]['author'] = getNickName($aRow['author_id']);
+        }        
+        $aVars = array ( // define template variables
+            'bx_repeat:posts' => $aPosts,
+        );
+        echo $this->_oTemplate->parseHtmlByName('main', $aVars); // output posts list
+
+        $this->_oTemplate->pageCode(_t('_me_blgg'), true); // output is completed, display all output above data wrapped by user design
+    }
+}}}
+
+then place the following code into the '''bloggie/templates/base/main.html''' file:
+
+{{{
+    <bx_repeat:posts>
+        <h2>
+            <a href="__url__">__title__</a>
+        </h2>
+        <p>__text__</p>
+        <p style="text-align:right; font-style:italic;"><bx_text:_me_blgg_posted_by /> __author__ (__added__)</p>
+        <hr />
+    </bx_repeat:posts>
+}}}
+
+And we have added a new database class method:
+
+{{{
+    function getAllPosts ($iLimit) {
+        return $this->getAll("SELECT *, LEFT(`text`, 256) AS `text` FROM `" . $this->_sPrefix . "posts` ORDER BY `added` DESC LIMIT $iLimit");
+    }
+}}}
+
+
+We have used the new template construction '''bx_repeat:posts''' here. This allows us to iterate through an array of similar data, Blog posts are the data to iterate through, in this case.
+Also, we used a new config class method - '''getBaseUri ''' It returns '''modules/?r=bloggie/''' or '''m/bloggie/''' depending on the permalinks settings. It is mandatory to generate all links this way, so the links will work when '''mod_rewrite''' is disabled.
+
+Almost everything is done here. The last thing we will add to Bloggie module will be edit post page.
+
+
+== 4.5. Edit the post page. ==
+
+Add the following method to the '''MeBlggModule''' class:
+
+{{{
+    function actionEdit ($iEntryId) {
+
+        $aEntry = $this->_oDb->getEntryById ((int)$iEntryId);
+        if (!$aEntry) { // check if entry exists
+            $this->_oTemplate->displayPageNotFound ();
+            return;
+        }
+
+        if ((!$GLOBALS['logged']['member'] && !$GLOBALS['logged']['admin']) || $aEntry['author_id'] != $_COOKIE['memberID']) { // check access to the page
+            $this->_oTemplate->displayAccessDenied ();
+            return;
+        }
+
+        $this->_oTemplate->pageStart(); // all the code below will be wrapped by the user design
+
+        bx_import ('BxTemplFormView'); // import forms class
+
+        $oForm = new BxTemplFormView ($this->aForm); // create forms class
+
+        $oForm->initChecker($aEntry); // init form checker
+
+        if ($oForm->isSubmittedAndValid ()) { // if form is submitted and there is no form errors were found, save form data
+
+            $iRes = $oForm->update ($iEntryId); // update data in database
+
+            if ($iRes) { // if post was successfully added
+                $sRedirectUrl = BX_DOL_URL_ROOT . $this->_oConfig->getBaseUri() . 'view/' . $iEntryId;
+                header ('Location:' . $sRedirectUrl); // redirect to updated post view page
+                exit;
+            } else {
+                MsgBox(_t('_Error Occured')); // if error occured display error message
+            }                
+
+        } else {
+
+            echo $oForm->getCode (); // display form, if the form is not submitted or data is invalid
+
+        }
+
+        $this->_oTemplate->pageCode(_t('_me_blgg_page_title_edit'), true); // output is completed, display all output above data wrapped by user design
+    }
+}}}
+
+This function is pretty similar to the actionAdd method - with the following differences:
+
+    * there is additional access checking to allow only the post owner to edit it
+    * '''initChecker''' receives '''$aEntry''' as a parameter to fill our form with values, since it is an edit form
+    * instead of '''save''' we called the '''update''' form function with the post's primary id number, to indicate the post to update
+
+The last thing to do is to update the view post page and add an edit link to it. The edit post link will be added near the post title. To achieve this, we need to modify the '''actionView''' method in the following way:
+
+{{{
+    function actionView ($iEntryId) {
+
+        $aEntry = $this->_oDb->getEntryById ((int)$iEntryId);
+
+        if (!$aEntry) { // check if entry exists
+            $this->_oTemplate->displayPageNotFound ();
+            return;
+        }
+
+        $this->_oTemplate->pageStart(); // all the code below will be wrapped by the user design
+
+        $aVars = array (
+            'title' => $aEntry['title'],
+            'text' => $aEntry['text'],
+            'author' => getNickName($aEntry['author_id']),
+            'added' => defineTimeInterval($aEntry['added']),
+            'bx_if:edit' => array(
+                'condition' => ($GLOBALS['logged']['member'] || $GLOBALS['logged']['admin']) && $aEntry['author_id'] == $_COOKIE['memberID'],
+                'content' => array(
+                    'edit_url' => BX_DOL_URL_ROOT . $this->_oConfig->getBaseUri() . 'edit/' . $aEntry['id'],
+                ),
+            ),        
+        );
+        echo $this->_oTemplate->parseHtmlByName('view', $aVars); // display post
+
+        $this->_oTemplate->pageCode($aEntry['title'], true); // output is completed, display all output above data wrapped by user design
+    }
+
+}}}
+
+and place the code below into the '''bloggie/templates/base/view.html''' file:
+
+{{{
+<div>
+    <h1>
+        __title__
+        <bx_if:edit>
+            <a href="__edit_url__"><bx_text:_me_blgg_edit /></a>
+        </bx_if:edit>
+    </h1>
+    <p>__text__</p>
+    <p style="text-align:right; font-style:italic;"><bx_text:_me_blgg_posted_by /> __author__ (__added__)</p>
+</div>
+}}}
+
+We have passed a new variable to the template with the edit post link, but is has a condition that only the owner can edit the post.
+
+Try this new functionality by editing already created posts.
+
+You can download the resulting module to compare with your own, here: (TODO:bloggie4.zip).
+
+Congratulations! The first Dolphin 7 module is now completed. I hope that you are full of ideas on how to extend this module for your own needs or create a new one from scratch.
+
+
+== 5. What to do next. ==
+ 
+There are many resources where you can get some Dolphin knowledge and share your experience:
+
+    * [http://www.boonex.com/unity/ BoonEx Unity Forums] - report bugs, ask for the help and help others if you see that you have an answer.
+    * [http://www.boonex.com/unity/blog/home BoonEx Blog] - find helpful blog posts of others and make your post if you think you have something to share about your Dolphin experience.
+    * [http://www.boonex.com/unity/extensions/home BoonEx Market] - download free and paid modules for Dolphin or post your own mods.
+    * [http://www.boonex.com/trac/dolphin/roadmap BoonEx Tickets System] - check the current Dolphin development stage or get latest source code.
+    * [http://www.boonex.com/trac/dolphin/wiki/DolphinDocs BoonEx Wiki] - Dolphin documentation.
+    * [http://www.boonex.com/agents/ BoonEx Agents] - get support from your personal BoonEx agent
+
+
+You probably have many questions or are willing to share your new module or experience with others after reading this post, so use the links above to do it in the right place.
+