User Tools

Site Tools


documentation:create_first_plugin

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
documentation:create_first_plugin [2015/06/11 10:48]
mooeditor [How to using mailsystem]
documentation:create_first_plugin [2015/09/03 00:08] (current)
Line 2: Line 2:
  
 //NOTE: We’re currently working on documenting these sections. We believe the information here is accurate, however be aware we are also still working on this chapter. Additional information will be provided as we go which should make this chapter more solid.// //NOTE: We’re currently working on documenting these sections. We believe the information here is accurate, however be aware we are also still working on this chapter. Additional information will be provided as we go which should make this chapter more solid.//
 +
 +Sample Plugin: [[https://​www.moosocial.com//​wiki/​lib/​plugins/​ckgedit/​fckeditor/​userfiles/​file/​moo-note-1.0.zip|https://​www.moosocial.com//​wiki/​lib/​plugins/​ckgedit/​fckeditor/​userfiles/​file/​moo-note-1.0.zip]]
 +
 ====== Welcome to the mooSocial guides ====== ====== Welcome to the mooSocial guides ======
  
Line 683: Line 686:
  
 Create new ctp file in **/​app/​Plugin/​Note/​View/​Elements/​myNotes.ctp** Create new ctp file in **/​app/​Plugin/​Note/​View/​Elements/​myNotes.ctp**
 +
 +> New in version 2.2.1> Your ctp file must be place at /​app/​Plugin/​{plugin_name}/​View/​Widgets/​ instead of /​app/​Plugin/​{plugin}/​View/​Elements/​
 +
  
 <file php myNotes.ctp>​ <file php myNotes.ctp>​
Line 759: Line 765:
 //]]> //]]>
 <?php $this->​Html->​scriptEnd();​ ?> <?php $this->​Html->​scriptEnd();​ ?>
 +</​file>​
 +
 +
 +> New in version 2.2.1> You don't have to use $this→requestAction() method to get the need variables anymore e.g: <font 10.0ptline-height:​ 13.0pt;/​arial;;#​000000;;#​ffffff><?​php $notes = $this→requestAction(array('​plugin'​ ⇒ '​Note',​ '​controller'​ ⇒ '​notes',​ '​action'​ ⇒ '​myNotes'​),​ array('​uri'​ ⇒ $this→here));?></​font>​. Instead, create a file in //​app/​Plugin/​{plugin_name}/​Controller/​Widgets/​{your_element_name}Widget.php//,​ for <font 10.0ptline-height:​ 13.0pt;​font-family:​ Arial , Helvetica , FreeSans , sans-serif;/​Arial , Helvetica , FreeSans , sans-serif;;#​000000;;#​ffffff>​example:</​font>​ <font 10.0ptline-height:​ 13.0pt;​font-family:​ Arial , Helvetica , FreeSans , sans-serif;/​Arial , Helvetica , FreeSans , sans-serif;;#​000000;;#​ffffff>//​app/​Plugin/​Note/​Controller/​Widgets/​myNotesWidget.php//</​font>​ with the content like the below code:
 +<file php myNotesWidget.ctp>​
 +
 +<?php
 +App::​uses('​Widget','​Controller/​Widgets'​);​
 +class MyNotesWidget extends Widget {
 +    public function beforeRender(Controller $controller) {
 +        $this->​Note = MooCore::​getInstance()->​getModel('​Note'​);​
 +        $notes = $this->​Note->​find('​all',​ array(
 +            '​conditions'​ => array('​uri'​ => $controller->​request->​here),​
 +            '​limit'​ => 1,
 +            '​order'​ => array('​Note.id'​ => '​DESC'​)
 +        ));
 +        $controller->​set('​notes',​$notes);​
 +    }
 </​file>​ </​file>​
  
Line 1031: Line 1055:
  
 <file php NoteSettingsController.php>​ <file php NoteSettingsController.php>​
- 
 <?php <?php
 class NoteSettingsController extends NoteAppController{ class NoteSettingsController extends NoteAppController{
Line 1097: Line 1120:
  
 Which case do we need? In common, almost plugin settings needn'​t a boot setting, but some still have one such as '​enabled'​ setting which makes us know whether user can access that plugin or not. Why do we need a boot setting? Because when we want to block access, we need to check enable or not in '​routes.php'​ file of plugin; And importantly,​ '​routes.php'​ file is loaded before the system loads unboot settings, so if we don't make '​enabled'​ setting by boot, we can't check it (because that setting doesn'​t exist at that time). Which case do we need? In common, almost plugin settings needn'​t a boot setting, but some still have one such as '​enabled'​ setting which makes us know whether user can access that plugin or not. Why do we need a boot setting? Because when we want to block access, we need to check enable or not in '​routes.php'​ file of plugin; And importantly,​ '​routes.php'​ file is loaded before the system loads unboot settings, so if we don't make '​enabled'​ setting by boot, we can't check it (because that setting doesn'​t exist at that time).
 +
 +> New in version 2.2** ** > In version 2.2, the "​{plugin}_enabled"​ setting have "​is_boot"​ field is '​1'​ by default when you created a new plugin
  
 ==== Create boot setting ==== ==== Create boot setting ====
Line 1259: Line 1284:
   * Update **/​app/​Plugin/​Note/​Model/​Note.php **  like this   * Update **/​app/​Plugin/​Note/​Model/​Note.php **  like this
  
-<code file Note.php>+Note.php
  
 +<code file>
 <?php <?php
 App::​uses('​NoteAppModel',​ '​Note.Model'​);​ App::​uses('​NoteAppModel',​ '​Note.Model'​);​
Line 1302: Line 1328:
  
 <file php bootstrap.php>​ <file php bootstrap.php>​
- 
 <?php <?php
 App::​uses('​NoteListener',​ '​Note.Lib'​);​ App::​uses('​NoteListener',​ '​Note.Lib'​);​
Line 1407: Line 1432:
  
 <file sql /​app/​Plugin/​Note/​Config/​install/​install.sql>​ <file sql /​app/​Plugin/​Note/​Config/​install/​install.sql>​
- 
 CREATE TABLE IF NOT EXISTS {PREFIX}notes ( CREATE TABLE IF NOT EXISTS {PREFIX}notes (
     id INT UNSIGNED AUTO_INCREMENT PRIMARY KEY,     id INT UNSIGNED AUTO_INCREMENT PRIMARY KEY,
Line 1435: Line 1459:
  
 <file sql Copy SQL to /​app/​Plugin/​Note/​Config/​install/​uninstall.sql>​ <file sql Copy SQL to /​app/​Plugin/​Note/​Config/​install/​uninstall.sql>​
- 
 DROP TABLE IF EXISTS {PREFIX}notes;​ DROP TABLE IF EXISTS {PREFIX}notes;​
 DELETE FROM {PREFIX}core_blocks WHERE path_view = '​myNotes';​ DELETE FROM {PREFIX}core_blocks WHERE path_view = '​myNotes';​
Line 1685: Line 1708:
 </​code>​ </​code>​
  
 +How to using it $mailComponent→send($mix,​$type,​$params) $mix: email or $user_id or model user, $type: type of email, $params: param for mail type.
 +
 +<code php>
 +$noteModel = MooCore::​getInstance()->​getModel('​Note_Note'​);​
 +        $notes = $noteModel->​find('​all',​array('​conditions'​=>​array(
 +            '​check_reminder'​ => false,
 +            '​reminder>'​ => 0,
 +            '​(UNIX_TIMESTAMP(NOW()) - UNIX_TIMESTAMP(Note.created)>​ Note.reminder * 3600)'
 +        )));
 +
 +        if (count($notes))
 +        {
 +            $mailComponent = MooCore::​getInstance()->​getComponent('​Mail.MooMail'​);​
 +            $ssl_mode = Configure::​read('​core.ssl_mode'​);​
 +            $http = (!empty($ssl_mode)) ? '​https'​ :  '​http';​
 +            foreach ($notes as $note)
 +            {
 +                $mailComponent->​send($note['​Note'​]['​user_id'​],'​note_reminder',​
 +                    array(
 +                        '​note_name'​ => $note['​Note'​]['​moo_title'​],​
 +                        '​note_link'​ => $http.'://'​.$_SERVER['​SERVER_NAME'​].$note['​Note'​]['​moo_href'​],​
 +                    )
 +                );
 +
 +                $noteModel->​id = $note['​Note'​]['​id'​];​
 +                $noteModel->​save(array('​check_reminder'​=>​true));​
 +            }
 +        }
 +</​code>​
 +
 +===== How to using tag system =====
 +
 +When create a note:
 +
 +<file php NotesController.php>​
 +if ($this->​Note->​save($this->​request->​data)) {
 +        //Tag system
 +    $this->​loadModel('​Tag'​);​
 +    $this->​Tag->​saveTags($this->​request->​data['​Note'​]['​tags'​],​ $this->​Note->​id,​ '​Note_Note'​);​
 +    //
 +
 +    $this->​Session->​setFlash(__d('​Note',​ 'Your note has been saved.'​));​
 +    return $this->​redirect(array('​action'​ => '​index'​));​
 +}
 +
 +</​file>​
 +
 +<file php add.ctp>
 +//Tag system
 +<div class="​col-md-2">​
 +        <​label><?​=__d('​Note',​ '​Tags'​)?></​label>​
 +    </​div>​
 +    <div class="​col-md-10">​
 +        <?php echo $this->​Form->​text('​tags'​);​ ?> <a href="​javascript:​void(0)"​ class="​tip profile-tip"​ title="<?​=__d('​Note',​ '​Separated by commas'​)?>">​(?​)</​a>​
 +    </​div>​
 +    <div class="​clear"></​div>​
 +</li>
 +//
 +
 +</​file>​
 +
 +When edit a note: NotesController.php
 +
 +<code php>
 +if ($this->​request->​is(array('​post',​ '​put'​))) {
 +    $this->​Note->​id = $id;
 +    $this->​request->​data['​Note'​]['​user_id'​] = $this->​Session->​read('​uid'​);​
 +    if ($this->​Note->​save($this->​request->​data)) {
 +                //Tag system
 +        $this->​Tag->​saveTags($this->​request->​data['​Note'​]['​tags'​],​ $id, '​Note_Note'​);​
 +        //
 +
 +        $this->​Session->​setFlash(__d('​Note',​ 'Your note has been updated.'​));​
 +        return $this->​redirect(array('​action'​ => '​index'​));​
 +    }
 +    $this->​Session->​setFlash(__d('​Note',​ '​Unable to update your note.'​));​
 +}
 +//Tag system
 +$tags = $this->​Tag->​getContentTags($id,​ '​Note_Note'​);​
 +$this->​set('​tags',​ $tags);
 +//
 +
 +</​code>​
 +
 +<file php edit.ctp>​
 +//Tag system
 +<li>
 +    <div class="​col-md-2">​
 +        <​label><?​=__d('​Blog',​ '​Tags'​)?></​label>​
 +    </​div>​
 +    <?php
 +    $tags_value = '';​
 +        if (!empty($tags)) $tags_value = implode(',​ ', $tags);
 +    ?>
 +    <div class="​col-md-10">​
 +        <?php echo $this->​Form->​text('​tags',​ array('​value'​ => $tags_value));​ ?> <a href="​javascript:​void(0)"​ class="​tip profile-tip"​ title="<?​=__d('​Blog',​ '​Separated by commas'​)?>">​(?​)</​a>​
 +    </​div>​
 +    <div class="​clear"></​div>​
 +</li>
 +//
 +
 +</​file>​
 +
 +Helper hook
 +
 +<file php NoteHelper.php>​
 +//Tag system
 +public function getTagUnionsNote($noteids)
 +{
 +    return "​SELECT i.id, i.title, i.body, i.like_count,​ i.created, '​Note_Note'​ as moo_type
 +                     FROM " . Configure::​read('​core.prefix'​) . "notes i
 +                     WHERE i.id IN (" . implode(',',​ $noteids) . ") AND i.privacy = "​.PRIVACY_EVERYONE;​
 +}
 +public function getImage($item,​$options)
 +{
 +    return $this->​assetUrl('​Note.noimage/​note.png',​$options + array('​pathPrefix'​ => Configure::​read('​App.imageBaseUrl'​)));​
 +
 +    return $url;
 +}
 +//
 +
 +</​file>​
 +
 +When view note
 +
 +<file php NotesController.php>​
 +//Tag system
 +$this->​loadModel('​Tag'​);​
 +$tags = $this->​Tag->​getContentTags($id,​ '​Note_Note'​);​
 +$this->​set('​tags',​ $tags);
 +//
 +
 +</​file>​
 +
 +<file php view.ctp>​
 +//Tag system
 +<div class="​box_content">​
 +    <?php echo $this->​element( '​blocks/​tags_item_block'​ ); ?>
 +</​div>​
 +//
 +
 +</​file>​
 +
 +===== How to using like system =====
 +
 +View note
 +
 +<file php NotesController.php>​
 +//Like system
 +MooCore::​getInstance()->​setSubject($note);​
 +//
 +
 +</​file>​
 +
 +<file php view.ctp>​
 +//Like system
 +<div class="​content_center">​
 +    <div class="​bar-content full_content p_m_10">​
 +        <div class="​content_center">​
 +            <?php echo $this->​renderLike();?>​
 +        </​div>​
 +    </​div>​
 +</​div>​
 +//
 +
 +</​file>​
 +
 +===== How to using comment system =====
 +
 +View note
 +
 +<file php notescontroller.php>​
 +//Comment system
 +MooCore::​getInstance()->​setSubject($note);​
 +//
 +
 +</​file>​
 +
 +<file php view.ctp>​
 +//Comment system
 +<div class="​content_center">​
 +    <div class="​bar-content full_content p_m_10">​
 +        <?php echo $this->​renderComment();?>​
 +    </​div>​
 +</​div>​
 +//
 +
 +</​file>​
 +
 +<file php NoteHelper.php>​
 +//Comment system
 +public function checkPostStatus($note,​$uid)
 +{
 +    if (!$uid)
 +        return false;
 +
 +    $friendModel = MooCore::​getInstance()->​getModel('​Friend'​);​
 +    if ($uid == $note['​Note'​]['​user_id'​])
 +        return true;
 +
 +    if ($note['​Note'​]['​privacy'​] == PRIVACY_EVERYONE)
 +    {
 +        return true;
 +    }
 +
 +    if ($note['​Note'​]['​privacy'​] == PRIVACY_FRIENDS)
 +    {
 +        $areFriends = $friendModel->​areFriends( $uid, $note['​Blog'​]['​user_id'​] );
 +        if ($areFriends)
 +            return true;
 +    }
 +
 +    return false;
 +}
 +public function checkSeeActivity($note,​$uid)
 +{
 +    return $this->​checkPostStatus($note,​$uid);​
 +}
 +//
 +
 +</​file>​
 +
 +===== How to using report system =====
 +
 +View note:
 +
 +<file php view.tcp>​
 +//Report system
 +<?​=$this->​Html->​link(
 +    __d('​Note',​ '​Report Note'​),​ array(
 +        '​controller'​ => '​reports',​
 +        '​action'​ => '​ajax_create',​
 +        '​plugin'​ => '',​
 +        $note['​Note'​]['​moo_type'​],​
 +        $note['​Note'​]['​id'​]
 +    ), array('​data-target'​=>'#​themeModal','​class'​=>'​button button-action topButton button-mobi-top','​data-toggle'​=>'​modal'​)
 +);
 +//
 +
 +</​file>​
 +
 +====== Plugin Development Suggestions ======
 +
 +  * Do not hardcode the mooSocial database table prefix into your Plugins .
 +  * Use the existing database tables instead of creating new custom tables if possible.
 +  * SELECT only what you need.Naming conventions are very important in CakePHP. By naming our model Post, CakePHP can automatically infer that this model will be used in the PostsController,​ and will be tied to a database table called posts.
 +
 +====== Themed Plugin ======
 +
 +path **app/​View/​Themed/​[ThemeName]/​Plugin/​[PluginName]/​**
 +
 +{{:​documentation:​23fb6cd688d81fcb558c8984a443b870.jpg}}
  
documentation/create_first_plugin.1434019690.txt.gz · Last modified: 2015/08/24 01:13 (external edit)