BEdita API doc | 4-cactus
  • Class
  • Tree
  • Deprecated
  • Download

Classes

  • Addon
  • AddressbookController
  • AddressbookShell
  • AdminController
  • Alias
  • Annotation
  • ApiAuthComponent
  • ApiBaseController
  • ApiFormatterComponent
  • ApiUploadComponent
  • ApiValidatorComponent
  • AppController
  • AppError
  • AppHelper
  • Application
  • AppModel
  • Area
  • AreasController
  • Audio
  • AuthenticationsController
  • BannedIp
  • BEAppModel
  • BEAppObjectModel
  • BeAuthComponent
  • BeAuthFacebookComponent
  • BeAuthGoogleComponent
  • BeAuthTwitterComponent
  • BeCallbackManager
  • BeConfigure
  • BeCustomPropertyComponent
  • BeditaAnnotationModel
  • BeditaBaseShell
  • BeditaCollectionModel
  • BeditaContentModel
  • BeditaExportFilter
  • BeditaImportFilter
  • BeditaObjectModel
  • BeditaProductModel
  • BeditaShell
  • BeditaSimpleObjectModel
  • BeditaSimpleStreamModel
  • BeditaStreamModel
  • BeEmbedFlashHelper
  • BeEmbedHtml5Helper
  • BeEmbedMediaHelper
  • BeErrorCode
  • BeExceptionHandler
  • BEFile
  • BeFileHandlerComponent
  • BeFormHelper
  • BeFrontHelper
  • BeHashComponent
  • BeHtmlHelper
  • BeLangTextComponent
  • BeLib
  • BeMailComponent
  • BEObject
  • BeObjectCache
  • BePaginatorToolbarHelper
  • BeSchema
  • BeSecurityComponent
  • BeSystem
  • BeSystemComponent
  • BeThumb
  • BeTimeHelper
  • BeToolbarHelper
  • BeTreeComponent
  • BeTreeHelper
  • BeUploadToObjComponent
  • BeurlHelper
  • BeVimeoComponent
  • BeYoutubeComponent
  • BuildFilterBehavior
  • CacheableBehavior
  • CacheShell
  • CallbackBehavior
  • CaptchaComponent
  • Caption
  • CaptionsBehavior
  • Card
  • CardsImportFilter
  • Category
  • CleanupDataTask
  • CleanupTask
  • Comment
  • CommentsController
  • CompactResultBehavior
  • Content
  • CreateIndexFieldsBehavior
  • DataShell
  • DataTransfer
  • DateItem
  • DbadminShell
  • DeleteDependentObjectBehavior
  • DeleteObjectBehavior
  • DeployShell
  • Document
  • DocumentsController
  • DumpModel
  • EditorialContentsShell
  • EditorNote
  • Event
  • EventLog
  • EventsController
  • FilesController
  • ForeignDependenceSaveBehavior
  • FrontendController
  • FrontendShell
  • GalleriesController
  • Gallery
  • GeoTag
  • GettextShell
  • Git
  • GravatarHelper
  • Group
  • HashJob
  • History
  • HomeController
  • Image
  • ImageInfoHelper
  • JsonExportFilter
  • JsonImportFilter
  • JsonView
  • LangText
  • Link
  • MailGroup
  • MailGroupCard
  • MailJob
  • MailLog
  • MailMessage
  • MailShell
  • MailTemplate
  • Mask
  • MediaShell
  • MigrateDumpModel
  • MigrateShell
  • Migration
  • MigrationBase
  • MigrationDateItemsShell
  • Module
  • ModulesController
  • ModuleShell
  • MultimediaController
  • NewsController
  • NewsletterController
  • NewsletterShell
  • NotifyBehavior
  • ObjectEditor
  • ObjectProperty
  • ObjectRelation
  • ObjectType
  • ObjectUser
  • PagesController
  • Permission
  • PermissionModule
  • PermsHelper
  • Product
  • Property
  • PropertyOption
  • PublicationShell
  • RedisShell
  • RelationCheck
  • RelationRepair
  • RelationShell
  • RelationStats
  • RemoveDummyNameBehavior
  • ResponseHandlerComponent
  • RestClientModel
  • Revision
  • RevisionObjectBehavior
  • SearchText
  • SearchTextSaveBehavior
  • Section
  • SectionDummy
  • SessionFilterComponent
  • SessionFilterHelper
  • ShortNews
  • SmartyView
  • SoapClientModel
  • SplitterSql
  • StatisticsController
  • Stream
  • StreamLog
  • StreamsController
  • Svn
  • TagsController
  • ThemeSmartyView
  • ThumbnailHelper
  • ThumbShell
  • TransactionComponent
  • TransactionFS
  • TranslationsController
  • Tree
  • TrHelper
  • User
  • UserProperty
  • UsersController
  • Utility
  • Version
  • Video
  • VimeoHelper
  • WebmarksController
  • XmlExportFilter
  • XmlImportFilter
  • XmlJsonConverter
  • XmlView
  • YoutubeHelper

Interfaces

  • ApiAuthInterface
  • MediaProviderInterface
  • UploadableInterface

Exceptions

  • BeditaAjaxException
  • BEditaAllowURLException
  • BeditaBadRequestException
  • BeditaConflictException
  • BEditaDeleteStreamObjException
  • BeditaException
  • BEditaFileExistException
  • BeditaForbiddenException
  • BeditaFrontAccessException
  • BeditaHashException
  • BEditaInfoException
  • BeditaInternalErrorException
  • BEditaIOException
  • BeditaLengthRequiredException
  • BeditaMailException
  • BEditaMediaProviderException
  • BeditaMethodNotAllowedException
  • BEditaMIMEException
  • BeditaNotFoundException
  • BeditaNotImplementedException
  • BeditaPublicationException
  • BeditaRuntimeException
  • BEditaSaveStreamObjException
  • BeditaServiceUnavailableException
  • BeditaUnauthorizedException
  • BEditaUploadPHPException
  • BEditaURLException
  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 
<?php
/*-----8<--------------------------------------------------------------------
 * 
 * BEdita - a semantic content management framework
 * 
 * Copyright 2008-2015 ChannelWeb Srl, Chialab Srl
 * 
 * This file is part of BEdita: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published 
 * by the Free Software Foundation, either version 3 of the License, or 
 * (at your option) any later version.
 * BEdita is distributed WITHOUT ANY WARRANTY; without even the implied 
 * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 * You should have received a copy of the GNU Lesser General Public License 
 * version 3 along with BEdita (see LICENSE.LGPL).
 * If not, see <http://gnu.org/licenses/lgpl-3.0.html>.
 * 
 *------------------------------------------------------------------->8-----
 */

/**
 * AddressBook Module Controller
 */
class AddressbookController extends ModulesController {
    
    var $name = 'Addressbook';
    var $helpers    = array('BeTree', 'BeToolbar');
    var $components = array('BeTree', 'BeCustomProperty', 'BeLangText', 'BeFileHandler', 'BeSecurity');

    var $uses = array('BEObject','Tree', 'Category', 'Card', 'MailGroup') ;
    protected $moduleName = 'addressbook';
    protected $categorizableModels = array('Card');
    
    public function index($id = null, $order = "", $dir = true, $page = 1, $dim = 20) {
        $conf  = Configure::getInstance() ;
        $filter["object_type_id"] = $conf->objectTypes['card']["id"];
        $filter["Card.country"] = "";
        $filter["Card.email"] = "";
        $filter["Card.company_name"] = "";
        $filter["object_user"] = "card";
        $filter["count_annotation"] = "EditorNote";
        $this->paginatedList($id, $filter, $order, $dir, $page, $dim); 
        $this->loadCategories($filter["object_type_id"]);
        $this->loadMailgroups();
     }

    function view($id = null) {
        if($id == null) {
            Configure::write("defaultStatus", "on"); // set default ON for new objects
        }
        $this->viewObject($this->Card, $id);
        $this->set("groupsByArea", $this->MailGroup->getGroupsByArea(null, $id));

        include CONFIGS . 'countries.iso.php';
        $this->set('country_list_iso', $config['countryList']);
    }

    function save() {
        $this->checkWriteModulePermission();
        $this->Transaction->begin();
        $conf  = Configure::getInstance() ;

        $kind = ($this->data['company']==0) ? 'person' : 'cmp';
        if($kind == 'person') {
            if(!empty($this->data['name']) || !empty($this->data['surname'])) {
                $this->data['title'] = $this->data['name']." ".$this->data['surname'];
            }
        } else {
            if(!empty($this->data['company_name'])) {
                $this->data['title'] = $this->data['company_name'];
            }
        }

        if(empty($this->data['User'][0])) {
            $this->data['User'] = array();
        }


        $this->saveObject($this->Card);
        $this->Transaction->commit();
        if(empty($this->data["title"])) {
            $this->data["title"] = "";
        }
        $this->userInfoMessage(__("Card saved", true)." - ".$this->data["title"]);
        $this->eventInfo("card [". $this->data["title"]."] saved");
    }

    function delete() {
        $this->checkWriteModulePermission();
        $objectsListDeleted = $this->deleteObjects("Card");
        $this->userInfoMessage(__("Card deleted", true) . " -  " . $objectsListDeleted);
        $this->eventInfo("card $objectsListDeleted deleted");
    }

    function deleteSelected() {
        $this->checkWriteModulePermission();
        $objectsListDeleted = $this->deleteObjects("Card");
        $this->userInfoMessage(__("Cards deleted", true) . " -  " . $objectsListDeleted);
        $this->eventInfo("cards $objectsListDeleted deleted");
    }
    
    public function categories() {
        $this->showCategories($this->Card);
    }

    public function cloneObject() {
        unset($this->data['ObjectUser']);
        parent::cloneObject();
    }

    private function loadMailgroups() {
        $result = ClassRegistry::init("MailGroup")->find("all",
            array(
                "fields" => array("id","group_name"),
                "contain" => array()
            )
        );
        $mailgroups = array();
        foreach($result as $k => $v) {
            $mailgroups[$k] = $v['MailGroup'];
        }
        $this->set("mailgroups",$mailgroups);
    }

    public function addToMailgroup() {
        $this->checkWriteModulePermission();
        $counter = 0;
        $missingEmail = 0;
        if(!empty($this->params['form']['objects_selected'])) {
            $objects_to_assoc = $this->params['form']['objects_selected'];
            $mailgroup = $this->data['mailgroup'];
            $MailGroupObj = ClassRegistry::init("MailGroupCard");
            $this->Transaction->begin() ;
            for($i = 0; $i < count($objects_to_assoc); $i++) {
                // get email from  card
                $email = $this->Card->field("newsletter_email", array("id" => $objects_to_assoc[$i]));
                if(!empty($email)) { // if 'newsletter_email' skip saving
                    $data = array(
                        "card_id"=>$objects_to_assoc[$i],
                        "mail_group_id" => $mailgroup
                    );
                    $mg = $MailGroupObj->find("first",array('conditions' => $data));
                    if(empty($mg)) { // if relation already exists, skip saving
                        $data["status"] = "confirmed";
                        $MailGroupObj->create();
                        $MailGroupObj->save($data);
                        $counter++;
                    }
                } else {
                    $missingEmail++;
                }
            }
            $this->Transaction->commit() ;

            $userMsg = '';
            if ($missingEmail > 0) {
                $userMsg = $missingEmail . ' ' . __('cards without email not added to mailgroup', true) . ', ';
            }
            $userMsg .= $counter . ' ' . __("card(s) associated to mailgroup", true);
            $this->userInfoMessage($userMsg);
            $this->eventInfo("$counter card(s) associated to mailgroup id: " . $mailgroup);
        }
    }

    
    /**
     * Export cards to CSV/vCard, using current filter
     * 
     * @param string, type of export 'csv' or 'vcard'
     */
    public function exportToFile($type = 'csv') {
        $this->autoRender = false;
        $data = $this->loadDataFromSessionFilter();
        $result = array();
        $type = strtolower($type);
        if ($type == 'csv') {
            $result['contentType'] = 'text/csv';
            $result['filename'] = $this->name . '_n-' . count($data) . '_' . date('Y.m.d') . '.csv';
            $options = array();
            if (Configure::read('csvFields.card')) {
                $options['delimiter'] = ';';
                $options['custom'] = true;
            }
            $result['content'] = $this->Card->createCsvAsString($data, $options);
            $result['size'] = strlen($result['content']);
        } else if ($type = 'vcard') {
            $result['contentType'] = 'text/vcard';
            $result['filename'] = $this->name . '_n-' . count($data) . '_' . date('Y.m.d') . '.vcf';
            $content = '';
            foreach ($data as $d) {
                $content .= $this->Card->exportVCard($d) . "\n";
            }
            $result['content'] = $content;
            $result['size'] = strlen($content);
        } else {
            throw new BeditaBadRequestException(_('Unsupported file type') . ' - ' . $type);
        }

        Configure::write('debug', 0);
        header('Content-Description: File Transfer');
        header('Content-type: ' . $result['contentType']);
        header('Content-Disposition: attachment; filename='. $result['filename']);
        header('Content-Transfer-Encoding: binary');
        header('Expires: 0');
        header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
        header('Pragma: public');
        header('Content-Length: ' . $result['size']);
        ob_clean();
        flush();
        echo $result['content'];
        exit();
    }

    private function loadDataFromSessionFilter() {
        $filter = array();
        $filter['object_type_id'] = Configure::read('objectTypes.card.id');
        $filter['Card.*'] = '';
        $filterKey = $this->name . '.index';
        $this->SessionFilter->setup($filterKey);
        $sessionFilter = $this->SessionFilter->setFromUrl();
        $filter = array_merge($filter, $sessionFilter);
        $objects = $this->BeTree->getChildren(null, null, $filter);
        return $objects['items'];
    }

    protected function forward($action, $result) {
        $moduleRedirect = array(
            'addToMailgroup'    =>  array(
                'OK'    => $this->referer(),
                'ERROR' => $this->referer()
            )
        );
        return $this->moduleForward($action, $result, $moduleRedirect);
    }

}
BEdita API doc | 4-cactus API documentation generated by ApiGen