Zurmo: /home/apizurmo/zurmo/app/protected/modules/contacts/ContactsModule.php Source File

00001 <?php
00002     /*********************************************************************************
00003      * Zurmo is a customer relationship management program developed by
00004      * Zurmo, Inc. Copyright (C) 2017 Zurmo Inc.
00005      *
00006      * Zurmo is free software; you can redistribute it and/or modify it under
00007      * the terms of the GNU Affero General Public License version 3 as published by the
00008      * Free Software Foundation with the addition of the following permission added
00009      * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
00010      * IN WHICH THE COPYRIGHT IS OWNED BY ZURMO, ZURMO DISCLAIMS THE WARRANTY
00011      * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
00012      *
00013      * Zurmo is distributed in the hope that it will be useful, but WITHOUT
00014      * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00015      * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
00016      * details.
00017      *
00018      * You should have received a copy of the GNU Affero General Public License along with
00019      * this program; if not, see http://www.gnu.org/licenses or write to the Free
00020      * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
00021      * 02110-1301 USA.
00022      *
00023      * You can contact Zurmo, Inc. with a mailing address at 27 North Wacker Drive
00024      * Suite 370 Chicago, IL 60606. or at email address contact@zurmo.com.
00025      *
00026      * The interactive user interfaces in original and modified versions
00027      * of this program must display Appropriate Legal Notices, as required under
00028      * Section 5 of the GNU Affero General Public License version 3.
00029      *
00030      * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
00031      * these Appropriate Legal Notices must retain the display of the Zurmo
00032      * logo and Zurmo copyright notice. If the display of the logo is not reasonably
00033      * feasible for technical reasons, the Appropriate Legal Notices must display the words
00034      * "Copyright Zurmo Inc. 2017. All rights reserved".
00035      ********************************************************************************/
00036 
00037     class ContactsModule extends SecurableModule
00038     {
00039         const RIGHT_CREATE_CONTACTS = 'Create Contacts';
00040         const RIGHT_DELETE_CONTACTS = 'Delete Contacts';
00041         const RIGHT_ACCESS_CONTACTS = 'Access Contacts Tab';
00042 
00043         public function getDependencies()
00044         {
00045             return array(
00046                 'configuration',
00047                 'zurmo',
00048             );
00049         }
00050 
00051         public function getRootModelNames()
00052         {
00053             return array('Contact');
00054         }
00055 
00056         public static function getTranslatedRightsLabels()
00057         {
00058             $params                              = LabelUtil::getTranslationParamsForAllModules();
00059             $labels                              = array();
00060             $labels[self::RIGHT_CREATE_CONTACTS] = Zurmo::t('ContactsModule', 'Create ContactsModulePluralLabel',     $params);
00061             $labels[self::RIGHT_DELETE_CONTACTS] = Zurmo::t('ContactsModule', 'Delete ContactsModulePluralLabel',     $params);
00062             $labels[self::RIGHT_ACCESS_CONTACTS] = Zurmo::t('ContactsModule', 'Access ContactsModulePluralLabel Tab', $params);
00063             return $labels;
00064         }
00065 
00066         public static function getDefaultMetadata()
00067         {
00068             $metadata = array();
00069             $metadata['global'] = array(
00070                 'designerMenuItems' => array(
00071                     'showFieldsLink' => true,
00072                     'showGeneralLink' => true,
00073                     'showLayoutsLink' => true,
00074                     'showMenusLink' => true,
00075                 ),
00076                 'globalSearchAttributeNames' => array(
00077                     'fullName',
00078                     'anyEmail',
00079                     'officePhone',
00080                     'mobilePhone',
00081                 ),
00082                 'startingState' => 1,
00083                 'tabMenuItems' => array(
00084                     array(
00085                         'label' => "eval:Zurmo::t('ContactsModule', 'ContactsModulePluralLabel', \$translationParams)",
00086                         'url'   => array('/contacts/default'),
00087                         'right' => self::RIGHT_ACCESS_CONTACTS,
00088                         'mobile' => true,
00089                     ),
00090                 ),
00091                 'shortcutsCreateMenuItems' => array(
00092                     array(
00093                         'label'  => "eval:Zurmo::t('ContactsModule', 'ContactsModuleSingularLabel', \$translationParams)",
00094                         'url'    => array('/contacts/default/create'),
00095                         'right'  => self::RIGHT_CREATE_CONTACTS,
00096                         'mobile' => true,
00097                     ),
00098                 ),
00099                 'updateLatestActivityDateTimeWhenATaskIsCompleted'        => true,
00100                 'updateLatestActivityDateTimeWhenANoteIsCreated'          => true,
00101                 'updateLatestActivityDateTimeWhenAnEmailIsSentOrArchived' => true,
00102                 'updateLatestActivityDateTimeWhenAMeetingIsInThePast'     => true,
00103             );
00104             return $metadata;
00105         }
00106 
00107         public static function getPrimaryModelName()
00108         {
00109             return 'Contact';
00110         }
00111 
00117         public static function loadStartingData()
00118         {
00119             if (count(ContactState::GetAll()) != 0)
00120             {
00121                 return false;
00122             }
00123             $data = array(
00124                 Zurmo::t('Core', 'New'),
00125                 Zurmo::t('Core', 'In Progress'),
00126                 Zurmo::t('ContactsModule', 'Recycled'),
00127                 Zurmo::t('ContactsModule', 'Dead'),
00128                 Zurmo::t('ContactsModule', 'Qualified'),
00129                 Zurmo::t('ZurmoModule', 'Customer')
00130             );
00131             $order = 0;
00132             $startingStateId = null;
00133             foreach ($data as $stateName)
00134             {
00135                 $state        = new ContactState();
00136                 $state->name  = $stateName;
00137                 $state->order = $order;
00138                 $saved        = $state->save();
00139                 assert('$saved');
00140                 if ($stateName == Zurmo::t('ContactsModule', 'Qualified'))
00141                 {
00142                     $startingStateId = $state->id;
00143                 }
00144                 $order++;
00145             }
00146             if ($startingStateId == null)
00147             {
00148                 throw new NotSupportedException();
00149             }
00150             $metadata = ContactsModule::getMetadata();
00151             $metadata['global']['startingStateId'] = $startingStateId;
00152             ContactsModule::setMetadata($metadata);
00153             assert('count(ContactState::GetAll()) == 6');
00154             return true;
00155         }
00156 
00157         public static function getAccessRight()
00158         {
00159             return self::RIGHT_ACCESS_CONTACTS;
00160         }
00161 
00162         public static function getCreateRight()
00163         {
00164             return self::RIGHT_CREATE_CONTACTS;
00165         }
00166 
00167         public static function getDeleteRight()
00168         {
00169             return self::RIGHT_DELETE_CONTACTS;
00170         }
00171 
00175         public static function getSecurableModuleDisplayName()
00176         {
00177             $label = static::getModuleLabelByTypeAndLanguage('Plural') . '&#160;&#38;&#160;' .
00178                      LeadsModule::getModuleLabelByTypeAndLanguage('Plural');
00179             return $label;
00180         }
00181 
00182         public static function getDefaultDataMakerClassName()
00183         {
00184             return 'ContactsDefaultDataMaker';
00185         }
00186 
00187         public static function getDemoDataMakerClassNames()
00188         {
00189             return array('ContactsDemoDataMaker');
00190         }
00191 
00192         public static function getStateMetadataAdapterClassName()
00193         {
00194             return 'ContactsStateMetadataAdapter';
00195         }
00196 
00197         public static function getGlobalSearchFormClassName()
00198         {
00199             return 'ContactsSearchForm';
00200         }
00201 
00202         public static function hasPermissions()
00203         {
00204             return true;
00205         }
00206 
00207         public static function isReportable()
00208         {
00209             return true;
00210         }
00211 
00212         public static function canHaveWorkflow()
00213         {
00214             return true;
00215         }
00216 
00217         public static function canHaveContentTemplates()
00218         {
00219             return true;
00220         }
00221 
00222         protected static function getSingularModuleLabel($language)
00223         {
00224             return Zurmo::t('ContactsModule', 'Contact', array(), null, $language);
00225         }
00226 
00227         protected static function getPluralModuleLabel($language)
00228         {
00229             return Zurmo::t('ContactsModule', 'Contacts', array(), null, $language);
00230         }
00231 
00232         public static function shouldUpdateLatestActivityDateTimeWhenATaskIsCompleted()
00233         {
00234             $metadata = static::getMetadata();
00235             if (isset($metadata['global']['updateLatestActivityDateTimeWhenATaskIsCompleted']))
00236             {
00237                 return (bool) $metadata['global']['updateLatestActivityDateTimeWhenATaskIsCompleted'];
00238             }
00239             return false;
00240         }
00241 
00242         public static function shouldUpdateLatestActivityDateTimeWhenANoteIsCreated()
00243         {
00244             $metadata = static::getMetadata();
00245             if (isset($metadata['global']['updateLatestActivityDateTimeWhenANoteIsCreated']))
00246             {
00247                 return (bool) $metadata['global']['updateLatestActivityDateTimeWhenANoteIsCreated'];
00248             }
00249             return false;
00250         }
00251 
00252         public static function shouldUpdateLatestActivityDateTimeWhenAnEmailIsSentOrArchived()
00253         {
00254             $metadata = static::getMetadata();
00255             if (isset($metadata['global']['updateLatestActivityDateTimeWhenAnEmailIsSentOrArchived']))
00256             {
00257                 return (bool) $metadata['global']['updateLatestActivityDateTimeWhenAnEmailIsSentOrArchived'];
00258             }
00259             return false;
00260         }
00261 
00262         public static function shouldUpdateLatestActivityDateTimeWhenAMeetingIsInThePast()
00263         {
00264             $metadata = static::getMetadata();
00265             if (isset($metadata['global']['updateLatestActivityDateTimeWhenAMeetingIsInThePast']))
00266             {
00267                 return (bool) $metadata['global']['updateLatestActivityDateTimeWhenAMeetingIsInThePast'];
00268             }
00269             return false;
00270         }
00271     }
00272 ?>