Class lispa\amos\community\models\Community
Class Community This is the model class for table "community".
Public Properties
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $adminInstalled | lispa\amos\core\record\Record | ||
| $isNewsFiledName | string | lispa\amos\notificationmanager\record\NotifyRecord |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Component |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | lispa\amos\notificationmanager\record\NotifyRecord | |
| __get() | PHP getter magic method. | yii\db\BaseActiveRecord |
| __isset() | Checks if a property value is null. | yii\db\BaseActiveRecord |
| __set() | PHP setter magic method. | yii\db\BaseActiveRecord |
| __toString() | lispa\amos\core\record\Record | |
| __unset() | Sets a component property to be null. | yii\db\BaseActiveRecord |
| activeAttributes() | Returns the attribute names that are subject to validation in the current scenario. | yii\base\Model |
| addError() | Adds a new error to the specified attribute. | yii\base\Model |
| addErrors() | Adds a list of errors. | yii\base\Model |
| afterDelete() | This method is invoked after deleting a record. | yii\db\BaseActiveRecord |
| afterFind() | This method is called when the AR object is created and populated with the query result. | lispa\amos\community\models\Community |
| afterRefresh() | This method is called when the AR object is refreshed. | yii\db\BaseActiveRecord |
| afterSave() | Override Required for cache | lispa\amos\core\record\Record |
| afterValidate() | This method is invoked after validation ends. | yii\base\Model |
| applySearchFilters() | Apply search filtering conditions using above methods | lispa\amos\core\record\ContentModel |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| attributeHints() | Returns the attribute hints. | yii\base\Model |
| attributeLabels() | lispa\amos\community\models\Community | |
| attributes() | Returns the list of all attribute names of the record. | yii\db\ActiveRecordInterface |
| baseSearch() | Content base search: all content matching search parameters and not deleted. | lispa\amos\core\record\ContentModel |
| basicFind() | Base query, it INCLUDE deleted elements | lispa\amos\core\record\Record |
| beforeDelete() | Before deleting the community, deletion of related records: - subcommunities if present (and releted records) - contents published for the community only (news, documents, . | lispa\amos\community\models\base\Community |
| beforeSave() | Override for demos | lispa\amos\core\record\Record |
| beforeValidate() | This method is invoked before validation starts. | lispa\amos\core\record\Record |
| behaviors() | lispa\amos\community\models\Community | |
| buildQuery() | lispa\amos\core\record\NetworkModel | |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\db\BaseActiveRecord |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\db\BaseActiveRecord |
| canUseModuleOrder() | Check if there is an order variable for the module | lispa\amos\core\record\Record |
| className() | Returns the fully qualified name of this class. | yii\base\Object |
| clearErrors() | Removes errors for all attributes or a single attribute. | yii\base\Model |
| convertToSearchResult() | lispa\amos\core\interfaces\SearchModelInterface | |
| createOrderClause() | lispa\amos\notificationmanager\record\NotifyRecordInterface | |
| createValidators() | Creates validator objects based on the validation rules specified in rules(). | yii\base\Model |
| delete() | Deletes the record from the database. | yii\db\ActiveRecordInterface |
| deleteAll() | Deletes records using the provided conditions. | yii\db\ActiveRecordInterface |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviorByClassName() | This method detach a behavior from the model. | lispa\amos\core\record\Record |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| detachBehaviorsOnWhiteList() | lispa\amos\core\record\Record | |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| equals() | Returns a value indicating whether the given active record is the same as the current one. | yii\db\ActiveRecordInterface |
| extraFields() | Returns the list of fields that can be expanded further and returned by toArray(). | yii\base\ArrayableTrait |
| fields() | Returns the list of fields that should be returned by default by toArray() when no specific fields are specified. | yii\base\ArrayableTrait |
| filterByContext() | lispa\amos\core\record\NetworkModel | |
| filterValidated() | lispa\amos\core\record\NetworkModel | |
| find() | Creates an yii\db\ActiveQueryInterface instance for query purpose. | yii\db\ActiveRecordInterface |
| findAll() | Returns a list of active record models that match the specified primary key value(s) or a set of column values. | yii\db\ActiveRecordInterface |
| findBehaviorByClassName() | This method find a behavior from the model. | lispa\amos\core\record\Record |
| findBySql() | Creates an yii\db\ActiveQuery instance with a given SQL statement. | yii\db\ActiveRecord |
| findOne() | Returns a single active record model instance by a primary key or an array of column values. | yii\db\ActiveRecordInterface |
| formName() | Returns the form name that this model class should use. | yii\base\Model |
| generateAttributeLabel() | Generates a user friendly attribute label based on the give attribute name. | yii\base\Model |
| getActiveValidators() | Returns the validators applicable to the current $scenario. | yii\base\Model |
| getAdditionalAssociationTargetQuery() | lispa\amos\community\models\Community | |
| getAssociationTargetQuery() | lispa\amos\core\record\NetworkModel | |
| getAttachments() | Getter for $this->attachments; | lispa\amos\core\record\ContentModel |
| getAttribute() | Returns the named attribute value. | yii\db\ActiveRecordInterface |
| getAttributeHint() | Returns the text hint for the specified attribute. | yii\db\BaseActiveRecord |
| getAttributeLabel() | Returns the text label for the specified attribute. | yii\db\BaseActiveRecord |
| getAttributes() | Returns attribute values. | yii\base\Model |
| getAvatarUrl() | Url of community avatar img (logo) | lispa\amos\community\models\Community |
| getAvatarWebUrl() | Absolute Url of community avatar img (logo) | lispa\amos\community\models\Community |
| getBaseRole() | The name of the basic member role | lispa\amos\community\models\Community |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| getCategory() | lispa\amos\core\interfaces\ContentModelInterface | |
| getCommunityCoverImage() | Getter for $this->communityCoverImage; | lispa\amos\community\models\Community |
| getCommunityManagerMms() | lispa\amos\community\models\Community | |
| getCommunityManagers() | lispa\amos\community\models\Community | |
| getCommunityModel() | The community created by the context model (community related to project-management, events or a community itself) | lispa\amos\community\models\Community |
| getCommunityType() | lispa\amos\community\models\base\Community | |
| getCommunityTypeName() | lispa\amos\community\models\base\Community | |
| getCommunityUserMms() | lispa\amos\community\models\base\Community | |
| getCommunityUsers() | lispa\amos\community\models\base\Community | |
| getContextRoles() | Array containing the possible roles of a community Member | lispa\amos\community\models\Community |
| getCreatedByUser() | lispa\amos\community\models\base\Community | |
| getCreatedUserProfile() | lispa\amos\core\record\Record | |
| getCwhConfigId() | Get Id of configuration record for network model Community | lispa\amos\community\models\Community |
| getCwhValidationStatuses() | lispa\amos\core\record\ContentModel | |
| getDb() | Returns the connection used by this AR class. | yii\db\ActiveRecordInterface |
| getDeletedUserProfile() | lispa\amos\core\record\Record | |
| getDescription() | lispa\amos\community\models\Community | |
| getDirtyAttributes() | Returns the attribute values that have been modified since they are loaded or saved most recently. | yii\db\BaseActiveRecord |
| getDraftStatus() | lispa\amos\community\models\Community | |
| getErrors() | Returns the errors for all attributes or a single attribute. | yii\base\Model |
| getFirstError() | Returns the first error of the specified attribute. | yii\base\Model |
| getFirstErrors() | Returns the first error of every attribute in the model. | yii\base\Model |
| getFullViewUrl() | lispa\amos\core\interfaces\ViewModelInterface | |
| getGrammar() | lispa\amos\community\models\Community | |
| getGridViewColumns() | lispa\amos\community\models\Community | |
| getIsNewRecord() | Returns a value indicating whether the current record is new (not saved in the database). | yii\db\ActiveRecordInterface |
| getIterator() | Returns an iterator for traversing the attributes in the model. | yii\base\Model |
| getJoinWidget() | lispa\amos\core\record\NetworkModel | |
| getManagerRole() | The name of the greatest role a member can have | lispa\amos\community\models\Community |
| getMmClassName() | lispa\amos\community\models\Community | |
| getMmNetworkIdFieldName() | Get the name of field that contains user id in network-users association table | lispa\amos\community\models\Community |
| getMmTableName() | Get the name of the table storing network-users associations | lispa\amos\community\models\Community |
| getMmUserIdFieldName() | Get the name of field that contains network id in network-users association table | lispa\amos\community\models\Community |
| getModelImage() | lispa\amos\community\models\Community | |
| getModelImageUrl() | This method is the getter for the model image url and web url. | lispa\amos\core\interfaces\ModelImageInterface |
| getNetworkUserMms() | lispa\amos\core\record\NetworkModel | |
| getNetworkUsers() | lispa\amos\core\record\NetworkModel | |
| getNextRole() | Array containing the next level for a given initial role | lispa\amos\community\models\Community |
| getNotifiedUserId() | lispa\amos\notificationmanager\record\NotifyRecord | |
| getNotifier() | lispa\amos\notificationmanager\record\NotifyRecord | |
| getOldAttribute() | Returns the old value of the named attribute. | yii\db\BaseActiveRecord |
| getOldAttributes() | Returns the old attribute values. | yii\db\BaseActiveRecord |
| getOldPrimaryKey() | Returns the old primary key value(s). | yii\db\ActiveRecordInterface |
| getOrderAttributesLabels() | Array of fields => labels for the ORDER form see "_order.php" file | lispa\amos\core\record\Record |
| getPluginController() | For m2m widget actions: return the plugin controller name to construct redirect URL | lispa\amos\community\models\Community |
| getPluginModule() | For m2m widget actions: return the plugin module name to construct redirect URL | lispa\amos\community\models\Community |
| getPluginWidgetClassname() | lispa\amos\community\models\Community | |
| getPrimaryKey() | Returns the primary key value(s). | yii\db\ActiveRecordInterface |
| getPublicatedAt() | lispa\amos\core\interfaces\ContentModelInterface | |
| getPublicatedFrom() | lispa\amos\core\interfaces\ContentModelInterface | |
| getRedirectAction() | For m2m widget actions: return the controller action name to construct redirect URL | lispa\amos\community\models\Community |
| getRelatedRecords() | Returns all populated related records. | yii\db\BaseActiveRecord |
| getRelation() | Returns the relation object with the specified name. | yii\db\ActiveRecordInterface |
| getRolePermissions() | Array containing user permission for a given role | lispa\amos\community\models\Community |
| getScenario() | Returns the scenario that this model is used in. | yii\base\Model |
| getSearchQuery() | Use to add Join condition/add other filtering condition | lispa\amos\core\record\ContentModel |
| getSearchQueryCwhDisabled() | Additional filtering for serach query in case the model is not enabled in cwh or cwh in not enabled Override if necessary | lispa\amos\core\record\ContentModel |
| getShortDescription() | lispa\amos\community\models\Community | |
| getStatsToolbar() | lispa\amos\core\interfaces\StatsToolbarInterface | |
| getSubNetworkToValidateQuery() | lispa\amos\core\record\NetworkModel | |
| getSubcommunities() | lispa\amos\community\models\base\Community | |
| getTableSchema() | Returns the schema information of the DB table associated with this AR class. | yii\db\ActiveRecord |
| getTitle() | lispa\amos\community\models\Community | |
| getToValidateStatus() | lispa\amos\community\models\Community | |
| getUpdatedByUser() | lispa\amos\community\models\base\Community | |
| getUpdatedUserProfile() | lispa\amos\core\record\Record | |
| getUserId() | Get the user id used in network-users association table | lispa\amos\community\models\Community |
| getUserNetworkAssociationQuery() | lispa\amos\community\models\Community | |
| getUserNetworkQuery() | Query for communities in user network. | lispa\amos\community\models\Community |
| getUserNetworkWidget() | lispa\amos\community\models\Community | |
| getValidatedOnce() | Return true if model has been validated at least once (if workflow is active) | lispa\amos\core\record\ContentModel |
| getValidatedStatus() | lispa\amos\community\models\Community | |
| getValidatorRole() | lispa\amos\community\models\Community | |
| getValidatorUsersId() | lispa\amos\core\record\NetworkModel | |
| getValidators() | Returns all the validators declared in rules(). | yii\base\Model |
| getViewUrl() | lispa\amos\community\models\Community | |
| getVisibility() | lispa\amos\community\models\Community | |
| getVisibleNetworksQuery() | lispa\amos\core\record\NetworkModel | |
| getWorkflowStatusLabel() | This method return the correct workflow status label. It checks if the workflow behavior is present, then checks if the model has a workflow status and return the correct label. | lispa\amos\core\record\Record |
| globalSearch() | lispa\amos\core\interfaces\SearchModelInterface | |
| globalSearchTags() | This method is called by search module to fetch results matching one or more tags | lispa\amos\core\record\Record |
| hasAttribute() | Returns a value indicating whether the record has an attribute with the specified name. | yii\db\ActiveRecordInterface |
| hasErrors() | Returns a value indicating whether there is any validation error. | yii\base\Model |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMany() | Declares a has-many relation. |
yii\db\BaseActiveRecord |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
| hasOne() | Declares a has-one relation. |
yii\db\BaseActiveRecord |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| hasRole() | lispa\amos\community\models\Community | |
| hasSubNetworks() | lispa\amos\community\models\Community | |
| init() | lispa\amos\community\models\Community | |
| initOrderVars() | Init the order variables from the module config | lispa\amos\core\record\Record |
| insert() | Inserts the record into the database using the attribute values of this record. | yii\db\ActiveRecordInterface |
| instantiate() | Creates an active record instance. | yii\db\BaseActiveRecord |
| isAttributeActive() | Returns a value indicating whether the attribute is active in the current scenario. | yii\base\Model |
| isAttributeChanged() | Returns a value indicating whether the named attribute has been changed. | yii\db\BaseActiveRecord |
| isAttributeRequired() | Returns a value indicating whether the attribute is required. | yii\base\Model |
| isAttributeSafe() | Returns a value indicating whether the attribute is safe for massive assignments. | yii\base\Model |
| isCommunityManager() | lispa\amos\community\models\Community | |
| isDemo() | Check is demo environment | lispa\amos\core\record\Record |
| isEnabledCwh() | lispa\amos\core\record\Record | |
| isEnabledModule() | lispa\amos\core\record\Record | |
| isEnabledTag() | lispa\amos\core\record\Record | |
| isNetworkUser() | Return true if the user with id $userId belong to the network with id $networkId; if $userId is null the logged User id is considered | lispa\amos\community\models\Community |
| isNews() | lispa\amos\notificationmanager\record\NotifyRecordInterface | |
| isPrimaryKey() | Returns a value indicating whether the given set of attributes represents the primary key for this model | yii\db\ActiveRecordInterface |
| isRelationPopulated() | Check whether the named relation has been populated with records. | yii\db\BaseActiveRecord |
| isTransactional() | Returns a value indicating whether the specified operation is transactional in the current $scenario. | yii\db\ActiveRecord |
| isValidated() | Return true if the network is validated or no validation process is implemented for the network. | lispa\amos\community\models\Community |
| link() | Establishes the relationship between two records. | yii\db\ActiveRecordInterface |
| load() | Populates the model with input data. | yii\base\Model |
| loadDefaultValues() | Loads default values from database table schema | yii\db\ActiveRecord |
| loadMultiple() | Populates a set of models with the data from end user. | yii\base\Model |
| markAttributeDirty() | Marks an attribute dirty. | yii\db\BaseActiveRecord |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| offsetExists() | Returns whether there is an element at the specified offset. | yii\db\BaseActiveRecord |
| offsetGet() | Returns the element at the specified offset. | yii\base\Model |
| offsetSet() | Sets the element at the specified offset. | yii\base\Model |
| offsetUnset() | Sets the element value at the specified offset to null. | yii\db\BaseActiveRecord |
| on() | Attaches an event handler to an event. | yii\base\Component |
| onUnsafeAttribute() | This method is invoked when an unsafe attribute is being massively assigned. | yii\base\Model |
| optimisticLock() | Returns the name of the column that stores the lock version for implementing optimistic locking. | yii\db\BaseActiveRecord |
| populateRecord() | Populates an active record object using a row of data from the database/storage. | yii\db\ActiveRecord |
| populateRelation() | Populates the named relation with the related records. | yii\db\ActiveRecordInterface |
| primaryKey() | Returns the primary key name(s) for this AR class. | yii\db\ActiveRecordInterface |
| refresh() | Repopulates this active record with the latest data. | yii\db\BaseActiveRecord |
| renameFormNamesAndIds() | This method return an array of array. The array keys are all the model fields and the values are arrays with "name! and "id" keys modified with the string contained in the param. The return array structure is the following: $newNameAndIds = [ 'FIELD_NAME_1' => [ 'name' => 'NEW_NAME', 'id' => 'NEW_ID' ], . | lispa\amos\core\record\Record |
| representingColumn() | lispa\amos\community\models\Community | |
| rules() | lispa\amos\community\models\Community | |
| safeAttributes() | Returns the attribute names that are safe to be massively assigned in the current scenario. | yii\base\Model |
| save() | Saves the current record. | yii\db\ActiveRecordInterface |
| scenarios() | Returns a list of scenarios and the corresponding active attributes. | lispa\amos\core\record\ContentModel |
| search() | Content search method | lispa\amos\core\record\ContentModel |
| searchAll() | Search all validated content | lispa\amos\core\record\ContentModel |
| searchAllAdmin() | Search all contents (any status) for plugin administrator only | lispa\amos\core\record\ContentModel |
| searchAllQuery() | This method returns the ActiveQuery object that contains the query to retrieve logged user all contents. | lispa\amos\core\interfaces\ContentModelSearchInterface |
| searchCreatedByMeQuery() | This method returns the ActiveQuery object that contains the query to retrieve created by logged user contents. | lispa\amos\core\interfaces\ContentModelSearchInterface |
| searchDefaultOrder() | This method define the search default order. | lispa\amos\core\interfaces\ContentModelSearchInterface |
| searchFieldsGlobalSearch() | Array of fields to search with like condition in global search | lispa\amos\core\record\ContentModel |
| searchFieldsGreaterEqual() | Array of fields to search with >= condition in search method | lispa\amos\core\record\ContentModel |
| searchFieldsLessEqual() | Array of fields to search with <= condition in search method | lispa\amos\core\record\ContentModel |
| searchFieldsLike() | Array of fields to search with like condition in search method | lispa\amos\core\record\ContentModel |
| searchFieldsMatch() | Array of fields to search with equal match in search method | lispa\amos\core\record\ContentModel |
| searchOwn() | Search the Content created by the logged user | lispa\amos\core\record\ContentModel |
| searchOwnInterest() | Search method useful for retrieve all validated content (based on publication rule and visibility). | lispa\amos\core\record\ContentModel |
| searchOwnInterestsQuery() | This method returns the ActiveQuery object that contains the query to retrieve logged user own interest contents. | lispa\amos\core\interfaces\ContentModelSearchInterface |
| searchParticipants() | lispa\amos\core\record\NetworkModel | |
| searchToValidate() | Search content to validate based on cwh rules if cwh is active, all content in 'to validate status' otherwise | lispa\amos\core\record\ContentModel |
| searchToValidateQuery() | This method returns the ActiveQuery object that contains the query to retrieve logged user to validate contents. | lispa\amos\core\interfaces\ContentModelSearchInterface |
| sendNotification() | lispa\amos\community\models\Community | |
| setAttachments() | lispa\amos\core\record\ContentModel | |
| setAttribute() | Sets the named attribute value. | yii\db\ActiveRecordInterface |
| setAttributes() | Sets the attribute values in a massive way. | yii\base\Model |
| setCwhAuthAssignments() | Add CWH permissions based on the role for which a permissions array has been specified, Remove CWH permissions on community domain in case of role degradation or delete all permission in case of user-community association deletion | lispa\amos\community\models\Community |
| setIsNewRecord() | Sets the value indicating whether the record is new. | yii\db\BaseActiveRecord |
| setNotifier() | lispa\amos\notificationmanager\record\NotifyRecord | |
| setOldAttribute() | Sets the old value of the named attribute. | yii\db\BaseActiveRecord |
| setOldAttributes() | Sets the old attribute values. | yii\db\BaseActiveRecord |
| setOrderAttribute() | Set order field | lispa\amos\core\record\Record |
| setOrderAttributes() | Set the list of fields order for this module | lispa\amos\core\record\Record |
| setOrderType() | Set order type: ascending (SORT_ASC), descending (SORT_DESC) | lispa\amos\core\record\Record |
| setOrderVars() | Identifies the sort fields | lispa\amos\core\record\Record |
| setScenario() | Sets the scenario for the model. | yii\base\Model |
| tableName() | Declares the name of the database table associated with this AR class. | lispa\amos\community\models\base\Community |
| toArray() | Converts the model into an array. | yii\base\ArrayableTrait |
| toStringWithCharLimit() | lispa\amos\core\record\Record | |
| transactions() | Declares which DB operations should be performed within a transaction in different scenarios. | yii\db\ActiveRecord |
| trigger() | Triggers an event. | yii\base\Component |
| unlink() | Destroys the relationship between two records. | yii\db\ActiveRecordInterface |
| unlinkAll() | Destroys the relationship in current model. | yii\db\BaseActiveRecord |
| update() | Saves the changes to this active record into the database. | yii\db\ActiveRecordInterface |
| updateAll() | Updates records using the provided attribute values and conditions. | yii\db\ActiveRecordInterface |
| updateAllCounters() | Updates the whole table using the provided counter changes and conditions. | yii\db\ActiveRecord |
| updateAttributes() | Updates the specified attributes. | yii\db\BaseActiveRecord |
| updateCounters() | Updates one or several counter columns for the current AR object. | yii\db\BaseActiveRecord |
| validate() | Performs the data validation. | yii\base\Model |
| validateMultiple() | Validates multiple models. | yii\base\Model |
| validazioneAbilitata() | Ritorna solamente $this. | lispa\amos\core\record\ContentModel |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| __shortText() | Parse string and return limited one | lispa\amos\core\record\Record |
| createRelationQuery() | Creates a query instance for has-one or has-many relation. |
yii\db\BaseActiveRecord |
| deleteInternal() | Deletes an ActiveRecord without considering transaction. | yii\db\ActiveRecord |
| deletedCommunityParticipantsMail() | lispa\amos\community\models\base\Community | |
| findByCondition() | Finds ActiveRecord instance(s) by the given condition. | yii\db\ActiveRecord |
| insertInternal() | Inserts an ActiveRecord into DB without considering transaction. | yii\db\ActiveRecord |
| resolveFields() | Determines which fields can be returned by toArray(). | yii\base\ArrayableTrait |
| switchOffNotifications() | Switch off notifications | lispa\amos\notificationmanager\record\NotifyRecord |
| updateInternal() | yii\db\BaseActiveRecord |
Events
| Event | Type | Description | Defined By |
|---|---|---|---|
| EVENT_AFTER_DELETE | yii\base\Event | An event that is triggered after a record is deleted. | yii\db\BaseActiveRecord |
| EVENT_AFTER_FIND | yii\base\Event | An event that is triggered after the record is created and populated with query result. | yii\db\BaseActiveRecord |
| EVENT_AFTER_INSERT | yii\db\AfterSaveEvent | An event that is triggered after a record is inserted. | yii\db\BaseActiveRecord |
| EVENT_AFTER_REFRESH | yii\base\Event | An event that is triggered after a record is refreshed. (available since version 2.0.8) | yii\db\BaseActiveRecord |
| EVENT_AFTER_UPDATE | yii\db\AfterSaveEvent | An event that is triggered after a record is updated. | yii\db\BaseActiveRecord |
| EVENT_AFTER_VALIDATE | yii\base\Event | An event raised at the end of validate() | yii\base\Model |
| EVENT_BEFORE_DELETE | yii\base\ModelEvent | An event that is triggered before deleting a record. | yii\db\BaseActiveRecord |
| EVENT_BEFORE_INSERT | yii\base\ModelEvent | An event that is triggered before inserting a record. | yii\db\BaseActiveRecord |
| EVENT_BEFORE_UPDATE | yii\base\ModelEvent | An event that is triggered before updating a record. | yii\db\BaseActiveRecord |
| EVENT_BEFORE_VALIDATE | yii\base\ModelEvent | An event raised at the beginning of validate(). | yii\base\Model |
| EVENT_INIT | yii\base\Event | An event that is triggered when the record is initialized via init(). | yii\db\BaseActiveRecord |
Constants
| Constant | Value | Description | Defined By |
|---|---|---|---|
| COMMUNITY_WORKFLOW | 'CommunityWorkflow' | lispa\amos\community\models\Community | |
| COMMUNITY_WORKFLOW_STATUS_DRAFT | 'CommunityWorkflow/DRAFT' | lispa\amos\community\models\Community | |
| COMMUNITY_WORKFLOW_STATUS_NOT_VALIDATED | 'CommunityWorkflow/NOTVALIDATED' | lispa\amos\community\models\Community | |
| COMMUNITY_WORKFLOW_STATUS_TO_VALIDATE | 'CommunityWorkflow/TOVALIDATE' | lispa\amos\community\models\Community | |
| COMMUNITY_WORKFLOW_STATUS_VALIDATED | 'CommunityWorkflow/VALIDATED' | lispa\amos\community\models\Community | |
| OP_ALL | 7 | All three operations: insert, update, delete. This is a shortcut of the expression: OP_INSERT | OP_UPDATE | OP_DELETE. | yii\db\ActiveRecord |
| OP_DELETE | 4 | The delete operation. This is mainly used when overriding transactions() to specify which operations are transactional. | yii\db\ActiveRecord |
| OP_INSERT | 1 | The insert operation. This is mainly used when overriding transactions() to specify which operations are transactional. | yii\db\ActiveRecord |
| OP_UPDATE | 2 | The update operation. This is mainly used when overriding transactions() to specify which operations are transactional. | yii\db\ActiveRecord |
| ROLE_COMMUNITY_MANAGER | 'COMMUNITY_MANAGER' | lispa\amos\community\models\Community | |
| SCENARIO_DEFAULT | 'default' | The name of the default scenario. | yii\base\Model |
| SCENARIO_FAKE_REQUIRED | 'scenario_fake_required' | lispa\amos\core\record\Record |
Property Details
$url
$url
- used in Community form if true, name or description have been modified and community is in published status and community goes back to edit status
Community cover image.
The columns ti show as default in GridViewWidget
The classname of the generic dashboard widget to access the plugin
public void getUserNetworkAssociationQuery ( $userId = null, $params = [], $onlyActiveStatus = false )
public yii\db\ActiveQuery getUserNetworkQuery ( $userId = null, $params = [], $onlyActiveStatus = false )
The url to view a single model
Method Details
This method is called when the AR object is created and populated with the query result.
The default implementation will trigger an EVENT_AFTER_FIND event. When overriding this method, make sure you call the parent implementation to ensure the event is triggered.
| public void afterFind ( ) |
| public void attributeLabels ( ) |
| public void behaviors ( ) |
| public void getAdditionalAssociationTargetQuery ( $communityId ) | ||
| $communityId | ||
Url of community avatar img (logo)
| public string getAvatarUrl ( $dimension = 'small', $absolute = false, $getPublicUrl = false ) | ||
| $dimension | string | Size of the image. Default = small. |
| $absolute | boolean |
|
| $getPublicUrl | ||
| return | string | $url |
|---|---|---|
Absolute Url of community avatar img (logo)
| public string getAvatarWebUrl ( $dimension = 'small' ) | ||
| $dimension | string | Size of the image. Default = small. |
| return | string | $url |
|---|---|---|
The name of the basic member role
| public string getBaseRole ( ) |
Getter for $this->communityCoverImage;
| public yii\db\ActiveQuery getCommunityCoverImage ( ) |
| public yii\db\ActiveQuery getCommunityManagerMms ( ) |
| public yii\db\ActiveQuery getCommunityManagers ( ) |
The community created by the context model (community related to project-management, events or a community itself)
| public lispa\amos\community\models\Community getCommunityModel ( ) |
Array containing the possible roles of a community Member
| public array getContextRoles ( ) |
Get Id of configuration record for network model Community
| public static integer getCwhConfigId ( ) | ||
| return | integer | $cwhConfigId |
|---|---|---|
| public string getDescription ( $truncate ) | ||
| $truncate | ||
| public void getDraftStatus ( ) |
| public mixed getGrammar ( ) |
| public array getGridViewColumns ( ) | ||
| return | array | The columns ti show as default in GridViewWidget |
|---|---|---|
The name of the greatest role a member can have
| public string getManagerRole ( ) |
| public void getMmClassName ( ) |
Get the name of field that contains user id in network-users association table
| public string getMmNetworkIdFieldName ( ) |
Get the name of the table storing network-users associations
| public string getMmTableName ( ) |
Get the name of field that contains network id in network-users association table
| public string getMmUserIdFieldName ( ) |
| public void getModelImage ( ) |
Array containing the next level for a given initial role
| public string getNextRole ( $role ) | ||
| $role | string | |
For m2m widget actions: return the plugin controller name to construct redirect URL
| public string getPluginController ( ) |
For m2m widget actions: return the plugin module name to construct redirect URL
| public string getPluginModule ( ) |
| public string getPluginWidgetClassname ( ) | ||
| return | string | The classname of the generic dashboard widget to access the plugin |
|---|---|---|
For m2m widget actions: return the controller action name to construct redirect URL
| public string getRedirectAction ( ) |
Array containing user permission for a given role
| public array getRolePermissions ( $role ) | ||
| $role | string | |
| public void getShortDescription ( ) |
| public string getTitle ( ) |
| public void getToValidateStatus ( ) |
Get the user id used in network-users association table
| public integer getUserId ( ) |
| public void getUserNetworkAssociationQuery ( $userId = null, $params = [], $onlyActiveStatus = false ) | ||
| $userId | ||
| $params | ||
| $onlyActiveStatus | ||
Query for communities in user network.
| public yii\db\ActiveQuery getUserNetworkQuery ( $userId = null, $params = [], $onlyActiveStatus = false ) | ||
| $userId | integer|null |
|
| $params | ||
| $onlyActiveStatus | ||
| public string getUserNetworkWidget ( $userId = null, $isUpdate = false ) | ||
| $userId | null | |
| $isUpdate | boolean | |
| public void getValidatedStatus ( ) |
| public void getValidatorRole ( ) |
| public string getViewUrl ( ) | ||
| return | string | The url to view a single model |
|---|---|---|
| public static void getVisibility ( ) |
| public boolean hasRole ( $userId, $role ) | ||
| $userId | integer|null |
|
| $role | ||
| public void hasSubNetworks ( ) |
| public void init ( ) |
| public boolean isCommunityManager ( $userId = null ) | ||
| $userId | integer|null |
|
Return true if the user with id $userId belong to the network with id $networkId; if $userId is null the logged User id is considered
| public boolean isNetworkUser ( $networkId = null, $userId = null, $onlyActiveStatus = false ) | ||
| $networkId | integer | |
| $userId | integer | |
| $onlyActiveStatus | ||
Return true if the network is validated or no validation process is implemented for the network.
if $networkId is null, current network (this) is condidered
| public boolean isValidated ( $networkId = null ) | ||
| $networkId | integer | |
| public void representingColumn ( ) |
See also yii\base\Model::rules() for more info.
| public void rules ( ) |
| public boolean sendNotification ( ) |
Add CWH permissions based on the role for which a permissions array has been specified, Remove CWH permissions on community domain in case of role degradation or delete all permission in case of user-community association deletion
| public void setCwhAuthAssignments ( $communityUserMmRow, $delete = false ) | ||
| $communityUserMmRow | lispa\amos\community\models\CommunityUserMm | |
| $delete | boolean|false |
|