Overview

Packages

  • application
    • commands
    • components
      • actions
      • filters
      • leftWidget
      • permissions
      • sortableWidget
      • util
      • webupdater
      • x2flow
        • actions
        • triggers
      • X2GridView
      • X2Settings
    • controllers
    • models
      • embedded
    • modules
      • accounts
        • controllers
        • models
      • actions
        • controllers
        • models
      • calendar
        • controllers
        • models
      • charts
        • models
      • contacts
        • controllers
        • models
      • docs
        • components
        • controllers
        • models
      • groups
        • controllers
        • models
      • marketing
        • components
        • controllers
        • models
      • media
        • controllers
        • models
      • mobile
        • components
      • opportunities
        • controllers
        • models
      • products
        • controllers
        • models
      • quotes
        • controllers
        • models
      • services
        • controllers
        • models
      • template
        • models
      • users
        • controllers
        • models
      • workflow
        • controllers
        • models
      • x2Leads
        • controllers
        • models
  • None
  • system
    • base
    • caching
    • console
    • db
      • ar
      • schema
    • validators
    • web
      • actions
      • auth
      • helpers
      • widgets
        • captcha
        • pagers
  • zii
    • widgets
      • grid

Classes

  • AccountsGridViewProfileWidget
  • ActionMenu
  • ActionsGridViewProfileWidget
  • ActionsQuickCreateRelationshipBehavior
  • ActiveDateRangeInput
  • ApplicationConfigBehavior
  • Attachments
  • ChatBox
  • CommonControllerBehavior
  • ContactMapInlineTags
  • ContactsGridViewProfileWidget
  • CronForm
  • CSaveRelationsBehavior
  • DateRangeInputsWidget
  • DocsGridViewProfileWidget
  • DocViewer
  • DocViewerProfileWidget
  • EButtonColumnWithClearFilters
  • EmailDeliveryBehavior
  • EmailProgressControl
  • EncryptedFieldsBehavior
  • EventsChartProfileWidget
  • FileUploader
  • FontPickerInput
  • Formatter
  • FormView
  • GridViewWidget
  • History
  • IframeWidget
  • ImportExportBehavior
  • InlineActionForm
  • InlineEmailAction
  • InlineEmailForm
  • InlineEmailModelBehavior
  • InlineQuotes
  • JSONEmbeddedModelFieldsBehavior
  • JSONFieldsDefaultValuesBehavior
  • LeadRoutingBehavior
  • LeftWidget
  • LoginThemeHelper
  • LoginThemeHelperBase
  • MarketingGridViewProfileWidget
  • MediaBox
  • MessageBox
  • MobileFormatter
  • MobileFormLayoutRenderer
  • MobileLayoutRenderer
  • MobileLoginThemeHelper
  • MobileViewLayoutRenderer
  • ModelFileUploader
  • NewWebLeadsGridViewProfileWidget
  • NormalizedJSONFieldsBehavior
  • NoteBox
  • OnlineUsers
  • OpportunitiesGridViewProfileWidget
  • Panel
  • ProfileDashboardManager
  • ProfileGridViewWidget
  • ProfileLayoutEditor
  • ProfilesGridViewProfileWidget
  • Publisher
  • PublisherActionTab
  • PublisherCalendarEventTab
  • PublisherCallTab
  • PublisherCommentTab
  • PublisherEventTab
  • PublisherSmallCalendarEventTab
  • PublisherTab
  • PublisherTimeTab
  • QuickContact
  • QuickCreateRelationshipBehavior
  • QuotesGridViewProfileWidget
  • RecordAliasesWidget
  • RecordViewLayoutManager
  • RecordViewWidgetManager
  • RememberPagination
  • Reminders
  • ResponseBehavior
  • ResponsiveHtml
  • SearchIndexBehavior
  • ServicesGridViewProfileWidget
  • SmallCalendar
  • SmartActiveDataProvider
  • SmartDataProviderBehavior
  • SmartSort
  • SocialForm
  • SortableWidgetManager
  • SortableWidgets
  • TagBehavior
  • TagCloud
  • TemplatesGridViewProfileWidget
  • TimeZone
  • TopContacts
  • TopSites
  • TransformedFieldStorageBehavior
  • TranslationLogger
  • TwitterFeed
  • TwoColumnSortableWidgetManager
  • UpdaterBehavior
  • UpdatesForm
  • UserIdentity
  • UsersChartProfileWidget
  • WorkflowBehavior
  • X2ActiveGridView
  • X2ActiveGridViewForSortableWidgets
  • X2AssetManager
  • X2AuthManager
  • X2ChangeLogBehavior
  • X2ClientScript
  • X2Color
  • X2DateUtil
  • X2FixtureManager
  • X2FlowFormatter
  • X2GridView
  • X2GridViewBase
  • X2GridViewForSortableWidgets
  • X2GridViewSortableWidgetsBehavior
  • X2LeadsGridViewProfileWidget
  • X2LinkableBehavior
  • X2ListView
  • X2PillBox
  • X2ProgressBar
  • X2SmartSearchModelBehavior
  • X2TimestampBehavior
  • X2TranslationBehavior
  • X2UrlRule
  • X2WebModule
  • X2Widget
  • X2WidgetList
  • Overview
  • Package
  • Class
  • Tree
  1: <?php 
  2: /*****************************************************************************************
  3:  * X2Engine Open Source Edition is a customer relationship management program developed by
  4:  * X2Engine, Inc. Copyright (C) 2011-2016 X2Engine Inc.
  5:  * 
  6:  * This program is free software; you can redistribute it and/or modify it under
  7:  * the terms of the GNU Affero General Public License version 3 as published by the
  8:  * Free Software Foundation with the addition of the following permission added
  9:  * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
 10:  * IN WHICH THE COPYRIGHT IS OWNED BY X2ENGINE, X2ENGINE DISCLAIMS THE WARRANTY
 11:  * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 12:  * 
 13:  * This program is distributed in the hope that it will be useful, but WITHOUT
 14:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 15:  * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
 16:  * details.
 17:  * 
 18:  * You should have received a copy of the GNU Affero General Public License along with
 19:  * this program; if not, see http://www.gnu.org/licenses or write to the Free
 20:  * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 21:  * 02110-1301 USA.
 22:  * 
 23:  * You can contact X2Engine, Inc. P.O. Box 66752, Scotts Valley,
 24:  * California 95067, USA. or at email address contact@x2engine.com.
 25:  * 
 26:  * The interactive user interfaces in modified source and object code versions
 27:  * of this program must display Appropriate Legal Notices, as required under
 28:  * Section 5 of the GNU Affero General Public License version 3.
 29:  * 
 30:  * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
 31:  * these Appropriate Legal Notices must retain the display of the "Powered by
 32:  * X2Engine" logo. If the display of the logo is not reasonably feasible for
 33:  * technical reasons, the Appropriate Legal Notices must display the words
 34:  * "Powered by X2Engine".
 35:  *****************************************************************************************/
 36: 
 37: /**
 38:  * Child Class for a form record view 
 39:  * 
 40:  * @see RecordView
 41:  * @package application.components
 42:  * 
 43:  * @author Alex Rowe <alex@x2engine.com>
 44:  */
 45: class FormView extends RecordView {
 46: 
 47:     public $htmlOptions = array (
 48:         'class' => ''
 49:     ); 
 50: 
 51:     /**
 52:      * CActiveForm Object optionally passed to the widget
 53:      * @var CActiveForm Object
 54:      */
 55:     public $form;
 56: 
 57:     /**
 58:      * Js Class name
 59:      * @var string
 60:      */
 61:     public $JSClass = 'FormView';
 62: 
 63:     /**
 64:      * Models names that support quick create
 65:      * @var array => string
 66:      */
 67:     public $quickCreateModels = array();
 68: 
 69:     /**
 70:      * An array of IDs of a current duplication.
 71:      * If set, the form input will become dropdowns of 
 72:      * the different possible inputs
 73:      * @var array
 74:      */
 75:     public $idArray;
 76: 
 77:     /**
 78:      * [$defaultsByRelatedModelType description]
 79:      * @var array
 80:      */
 81:     public $defaultsByRelatedModelType = array();
 82: 
 83:     /**
 84:      * If true, quick create buttons will not render
 85:      * Typicall true if this form is a quick create form
 86:      * @var boolean
 87:      */
 88:     public $suppressQuickCreate = false;
 89: 
 90:     /**
 91:      * Contains quick create button types
 92:      * @var array 
 93:      */
 94:     private $_quickCreateButtonTypes = array();
 95: 
 96:     public function init() {
 97:         parent::init();
 98: 
 99:         $this->quickCreateModels = array_flip (
100:             QuickCreateRelationshipBehavior::getModelsWhichSupportQuickCreate());
101:     }
102: 
103:     public function run () {
104: 
105:         // If form is empty, we will not add the form wrappers
106:         if (!empty($this->form)) {
107:             parent::run();
108:             return;
109:         }
110: 
111:         $this->form = $this->beginWidget('CActiveForm', array(
112:             'id' => $this->modelName . '-form',
113:             'enableAjaxValidation' => false,
114:         ));
115: 
116:         parent::run ();
117: 
118:         echo X2Html::tag('div', array(
119:             'class' => 'row buttons save-button-row'
120:         ));
121: 
122:         $text  = $this->model->isNewRecord ? Yii::t('app', 'Create') : Yii::t('app', 'Save');
123:         echo X2Html::submitButton ($text, array(
124:                 'class' => 'x2-button', 
125:                 'id' => 'save-button', 
126:                 'tabindex' => 24
127:             ));
128:         echo '</div>';
129:         $this->endWidget();
130:     }
131: 
132:     public function getJSClassParams() {
133:         return array_merge(parent::getJSClassParams(), array(
134:             'quickCreate' => array (
135:                 'urls' => QuickCreateRelationshipBehavior::getCreateUrlsForModels(
136:                     $this->_quickCreateButtonTypes),
137:                 'tooltips' => QuickCreateRelationshipBehavior::getDialogTooltipsForModels(
138:                     $this->_quickCreateButtonTypes, get_class($this->model)),
139:                 'dialogTitles' => QuickCreateRelationshipBehavior::getDialogTitlesForModels(
140:                     $this->_quickCreateButtonTypes),
141:                 'defaults' => $this->defaultsByRelatedModelType
142:             ),
143:             'translations' => array (
144:                 'title' => Yii::t('app', 'Discard unsaved changes?'),
145:                 'message' => 
146:                     Yii::t('app', 'You have unsaved changes to this record. Discard changes?'),
147:                 'cancel' => Yii::t('app', 'Cancel'),
148:                 'confirm' => Yii::t('app', 'Yes'),
149:             )
150:         ));
151:     }
152: 
153:     public function getPackages () {
154:         $packages  = array_merge(parent::getPackages(), array(
155:             'RecordEditCss' => array (
156:                 'baseUrl' => Yii::app()->theme->baseUrl,
157:                 'css' => array (
158:                     'css/recordEdit.css'
159:                 )
160:             ),
161:             'FormViewJS' => array (
162:                 'baseUrl' => Yii::app()->baseUrl,
163:                 'js' => array (
164:                     'js/recordView/FormView.js'
165:                 ),
166:                 'depends' => array ('RecordViewJS')
167:             )
168:         ));
169: 
170:         if(!$this->suppressQuickCreate) {
171:             $packages = array_merge($packages, array(
172:                 'RelationshipJS' => array (
173:                     'baseUrl' => Yii::app()->baseUrl,
174:                     'js' => array (
175:                         'js/Relationships.js'
176:                     ),
177:                     'depends' => array ('X2Widget')
178:                 )
179:             ));
180:         }
181: 
182:         return $packages;
183:     }
184: 
185:     public function getMainOptions () {
186:         return array (
187:             'class' => 'x2-layout form-view',
188:             'id' => $this->namespace . 'form-view',
189:         );
190:     }
191: 
192:     public function renderMain () {
193:         $html = X2Html::openTag('div', $this->getMainOptions());
194: 
195:         $html .= $this->form->errorSummary ($this->model);
196: 
197:         $html .= $this->renderSections ();
198: 
199:         $html .= '</div>';
200:         return $html;
201:     }
202: 
203: 
204:     public function renderAttribute ($item, Fields $field) {
205:         $fieldName = preg_replace('/^formItem_/u', '', $item['name']);
206:         
207:         $html = X2Html::openTag('div', array(
208:             'class' => "formInputBox"
209:         ));
210: 
211:         if (isset($this->idArray)) {
212:             $html .= X2Model::renderMergeInput ($this->modelName, $this->idArray, $field);
213:         } else if (isset($this->specialFields[$fieldName])) {
214:             $html .= $this->specialFields[$fieldName];
215:         } else {
216:             $html .= $this->model->renderInput($fieldName, array(
217:                 'tabindex' => $item['tabindex'],
218:                 'disabled' => $item['readOnly'],
219:                 'style' => $item['height'],
220:                 'id' => $this->namespace.X2Html::resolveId ($this->model, $fieldName),
221:             ));
222:        }
223: 
224:        $html .= '</div>';
225: 
226:        $html .= $this->renderExtra($field);
227: 
228:        return $html;
229:     }
230: 
231:     /**
232:      * Renders the quick create/ Field help icons
233:      */
234:     public function renderExtra ($field) {
235:         $html = '';
236:         if ($field->type === 'link' && !$this->suppressQuickCreate &&
237:             isset($this->quickCreateModels[$field->linkType])) {
238:             $html .= X2Html::tag ('span', array (
239:                 'class' => "quick-create-button create-$field->linkType"
240:             ), '+');
241: 
242:             $this->_quickCreateButtonTypes[] = $field->linkType;
243:         }
244:         
245:         if (!empty($field->description)) {
246:             $html .= X2Html::hint($field->description);
247:         }
248: 
249:         return $html;
250:     }
251: 
252:     public function getLayoutData() {
253:         $attributes = array(
254:             'model' => ucfirst($this->modelName),
255:             'defaultForm' => 1,
256:             'scenario' => $this->scenario
257:         );
258: 
259:         $layout = FormLayout::model()->findByAttributes($attributes);
260: 
261:         return CJSON::decode($layout->layout);
262:     }
263: 
264:     public function renderLabel ($field) {
265:         return CHtml::activeLabelEx ($this->model, $field->fieldName);
266:     }
267: }
268: 
269: ?>
270: 
X2CRM Documentation API documentation generated by ApiGen 2.8.0