class ActivityType in CRM Core 8.3
Same name and namespace in other branches
- 8 modules/crm_core_activity/src/Entity/ActivityType.php \Drupal\crm_core_activity\Entity\ActivityType
- 8.2 modules/crm_core_activity/src/Entity/ActivityType.php \Drupal\crm_core_activity\Entity\ActivityType
CRM Activity Type Entity Class.
Plugin annotation
@ConfigEntityType(
id = "crm_core_activity_type",
label = @Translation("Activity type"),
bundle_of = "crm_core_activity",
config_prefix = "type",
handlers = {
"access" = "Drupal\crm_core_activity\ActivityTypeAccessControlHandler",
"form" = {
"default" = "Drupal\crm_core_activity\Form\ActivityTypeForm",
"delete" = "Drupal\Core\Entity\EntityDeleteForm",
"toggle" = "Drupal\crm_core_activity\Form\ActivityTypeToggleForm",
},
"list_builder" = "Drupal\crm_core_activity\ActivityTypeListBuilder",
"route_provider" = {
"html" = "Drupal\Core\Entity\Routing\DefaultHtmlRouteProvider",
},
},
admin_permission = "administer activity types",
entity_keys = {
"id" = "type",
"label" = "name",
},
config_export = {
"name",
"type",
"description",
"activity_string",
"plugin_id",
"plugin_configuration",
},
links = {
"add-form" = "/admin/structure/crm-core/activity-types/add",
"edit-form" = "/admin/structure/crm-core/activity-types/{crm_core_activity_type}",
"delete-form" = "/admin/structure/crm-core/activity-types/{crm_core_activity_type}/delete",
"enable" = "/crm_core_activity.type_enable",
"disable" = "/crm_core_activity.type_disable",
}
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBundleBase
- class \Drupal\crm_core_activity\Entity\ActivityType implements ActivityTypeInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBundleBase
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
Expanded class hierarchy of ActivityType
6 files declare their use of ActivityType
- ActivityAccessControlHandler.php in modules/
crm_core_activity/ src/ ActivityAccessControlHandler.php - ActivityUiTest.php in modules/
crm_core_activity/ tests/ src/ Functional/ ActivityUiTest.php - CrmCoreDemoTest.php in modules/
crm_core_demo/ tests/ src/ Functional/ CrmCoreDemoTest.php - CRMFeedsActivityProcessor.inc in modules/
crm_core_activity/ legacy/ CRMFeedsActivityProcessor.inc - Class definition of CRMFeedsActivityProcessor. @TODO: Remove Feeds integration
- IndividualCRUDTest.php in modules/
crm_core_contact/ tests/ src/ Kernel/ IndividualCRUDTest.php
File
- modules/
crm_core_activity/ src/ Entity/ ActivityType.php, line 53
Namespace
Drupal\crm_core_activity\EntityView source
class ActivityType extends ConfigEntityBundleBase implements ActivityTypeInterface {
/**
* The machine-readable name of this type.
*
* @var string
*/
public $type = '';
/**
* The human-readable name of this type.
*
* @var string
*/
public $name = '';
/**
* A brief description of this type.
*
* @var string
*/
public $description = '';
/**
* Text describing the relationship between the contact and this activity.
*
* @var string
*/
public $activity_string;
/**
* The plugin ID.
*
* @var string
*/
public $plugin_id = 'generic';
/**
* The plugin configuration.
*
* @var array
*/
public $plugin_configuration = [];
/**
* Type lazy plugin collection.
*
* @var \Drupal\Core\Plugin\DefaultSingleLazyPluginCollection
*/
protected $pluginCollection;
/**
* {@inheritdoc}
*/
public function id() {
return $this->type;
}
/**
* {@inheritdoc}
*
* @todo This does not scale.
*
* Deleting a activity type with thousands of activities records associated
* will run into execution timeout.
*/
public static function preDelete(EntityStorageInterface $storage, array $entities) {
parent::preDelete($storage, $entities);
$ids = array_map(function (EntityInterface $entity) {
return $entity
->id();
}, $entities);
// Delete all instances of the given type.
$results = \Drupal::entityQuery('crm_core_activity')
->condition('type', $ids, 'IN')
->execute();
if (!empty($results)) {
$activities = Activity::loadMultiple($results);
\Drupal::entityTypeManager()
->getStorage('crm_core_activity')
->delete($activities);
// @todo Handle singular and plural.
\Drupal::logger('crm_core_activity')
->info('Deleted !count activities due to deletion of activity type.', [
'!count' => count($results),
]);
}
}
/**
* {@inheritdoc}
*/
public function getPlugin() {
return $this
->getPluginCollection()
->get($this->plugin_id);
}
/**
* {@inheritdoc}
*/
public function setPluginId($plugin_id) {
$this->plugin_id = $plugin_id;
$this->pluginCollection = NULL;
return $this;
}
/**
* {@inheritdoc}
*/
public function setPluginConfiguration(array $plugin_configuration) {
$this->plugin_configuration = $plugin_configuration;
$this->pluginCollection = NULL;
return $this;
}
/**
* {@inheritdoc}
*/
public function getPluginCollections() {
return [
'plugin_configuration' => $this
->getPluginCollection(),
];
}
/**
* {@inheritdoc}
*/
public function getPluginCollection() {
if (!$this->pluginCollection) {
$this->pluginCollection = new DefaultSingleLazyPluginCollection(\Drupal::service('plugin.manager.crm_core_activity.activity_type'), $this->plugin_id, $this->plugin_configuration);
}
return $this->pluginCollection;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ActivityType:: |
public | property | Text describing the relationship between the contact and this activity. | |
ActivityType:: |
public | property | A brief description of this type. | |
ActivityType:: |
public | property | The human-readable name of this type. | |
ActivityType:: |
protected | property | Type lazy plugin collection. | |
ActivityType:: |
public | property | The plugin configuration. | |
ActivityType:: |
public | property | The plugin ID. | |
ActivityType:: |
public | property | The machine-readable name of this type. | |
ActivityType:: |
public | function |
Returns the plugin instance. Overrides ActivityTypeInterface:: |
|
ActivityType:: |
public | function |
Returns lazy plugin collection. Overrides ActivityTypeInterface:: |
|
ActivityType:: |
public | function |
Gets the plugin collections used by this object. Overrides ObjectWithPluginCollectionInterface:: |
|
ActivityType:: |
public | function |
Gets the identifier. Overrides EntityBase:: |
|
ActivityType:: |
public static | function |
@todo This does not scale. Overrides ConfigEntityBase:: |
|
ActivityType:: |
public | function |
Sets the plugin configuration. Overrides ActivityTypeInterface:: |
|
ActivityType:: |
public | function |
Sets the plugin id. Overrides ActivityTypeInterface:: |
|
CacheableDependencyTrait:: |
protected | property | Cache contexts. | |
CacheableDependencyTrait:: |
protected | property | Cache max-age. | |
CacheableDependencyTrait:: |
protected | property | Cache tags. | |
CacheableDependencyTrait:: |
protected | function | Sets cacheability; useful for value object constructors. | |
ConfigEntityBase:: |
private | property | Whether the config is being deleted by the uninstall process. | |
ConfigEntityBase:: |
protected | property | The language code of the entity's default language. | |
ConfigEntityBase:: |
protected | property | The original ID of the configuration entity. | |
ConfigEntityBase:: |
protected | property | The enabled/disabled status of the configuration entity. | 4 |
ConfigEntityBase:: |
protected | property | Third party entity settings. | |
ConfigEntityBase:: |
protected | property | Trust supplied data and not use configuration schema on save. | |
ConfigEntityBase:: |
protected | property | The UUID for this entity. | |
ConfigEntityBase:: |
protected | property | Information maintained by Drupal core about configuration. | |
ConfigEntityBase:: |
protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |
ConfigEntityBase:: |
public | function |
Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface:: |
13 |
ConfigEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Disables the configuration entity. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Enables the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Gets the configuration dependency name. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected static | function | Gets the configuration manager. | |
ConfigEntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the configuration dependencies. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
protected | function | Gets the typed config manager. | |
ConfigEntityBase:: |
public | function |
Gets whether on not the data is trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
protected static | function |
Override to never invalidate the individual entities' cache tags; the
config system already invalidates them. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected | function |
Override to never invalidate the entity's cache tag; the config system
already invalidates it. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Checks whether this entity is installable. Overrides ConfigEntityInterface:: |
2 |
ConfigEntityBase:: |
public | function |
Overrides Entity::isNew(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface:: |
7 |
ConfigEntityBase:: |
public | function |
Saves an entity permanently. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Sets the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets the status of the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function | ||
ConfigEntityBase:: |
public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | 6 |
ConfigEntityBase:: |
public | function |
Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface:: |
4 |
ConfigEntityBase:: |
public | function |
Gets an array of all property values. Overrides EntityBase:: |
2 |
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets that the data should be trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the public URL for this entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Constructs an Entity object. Overrides EntityBase:: |
10 |
ConfigEntityBase:: |
public | function |
Overrides EntityBase:: |
4 |
ConfigEntityBundleBase:: |
protected | function | Deletes display if a bundle is deleted. | |
ConfigEntityBundleBase:: |
protected | function | Returns view or form displays for this bundle. | |
ConfigEntityBundleBase:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides EntityBase:: |
2 |
ConfigEntityBundleBase:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase:: |
2 |
ConfigEntityBundleBase:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase:: |
|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | Aliased as: traitSleep | 1 |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. Aliased as: addDependencyTrait | |
EntityBase:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
EntityBase:: |
protected | property | The entity type. | |
EntityBase:: |
protected | property | A typed data object wrapping this entity. | |
EntityBase:: |
public | function |
Checks data value access. Overrides AccessibleInterface:: |
1 |
EntityBase:: |
public | function |
Gets the bundle of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public static | function |
Constructs a new entity object, without permanently saving it. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Deletes an entity permanently. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets the entity manager. | |
EntityBase:: |
protected | function | Gets the entity type bundle info service. | |
EntityBase:: |
protected | function | Gets the entity type manager. | |
EntityBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | The list cache tags to invalidate for this entity. | |
EntityBase:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the label of the entity. Overrides EntityInterface:: |
6 |
EntityBase:: |
public | function |
Gets the language of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the language manager. | |
EntityBase:: |
protected | function | Gets an array link templates. | 1 |
EntityBase:: |
public static | function |
Loads an entity. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Loads one or more entities. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Acts on a created entity before hooks are invoked. Overrides EntityInterface:: |
4 |
EntityBase:: |
public static | function |
Acts on loaded entities. Overrides EntityInterface:: |
2 |
EntityBase:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityInterface:: |
5 |
EntityBase:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets an array of placeholders for this entity. | 2 |
EntityBase:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the UUID generator. | |
PluginDependencyTrait:: |
protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 |
PluginDependencyTrait:: |
protected | function | Calculates and returns dependencies of a specific plugin instance. | |
PluginDependencyTrait:: |
protected | function | Wraps the module handler. | 1 |
PluginDependencyTrait:: |
protected | function | Wraps the theme handler. | 1 |
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
protected | property | Whether this entity is being created, updated or deleted through a synchronization process. | |
SynchronizableEntityTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
public | function |