Chris@0: <?php
Chris@0: 
Chris@0: /**
Chris@0:  * @file
Chris@0:  * Install, update, and uninstall functions for the Forum module.
Chris@0:  */
Chris@0: 
Chris@0: use Drupal\field\Entity\FieldStorageConfig;
Chris@0: use Drupal\taxonomy\Entity\Term;
Chris@0: 
Chris@0: /**
Chris@0:  * Implements hook_install().
Chris@0:  */
Chris@0: function forum_install() {
Chris@0:   // Set the weight of the forum.module to 1 so it is loaded after the taxonomy.module.
Chris@0:   module_set_weight('forum', 1);
Chris@0:   // Do not allow to delete the forum's node type machine name.
Chris@0:   $locked = \Drupal::state()->get('node.type.locked');
Chris@0:   $locked['forum'] = 'forum';
Chris@0:   \Drupal::state()->set('node.type.locked', $locked);
Chris@0: 
Chris@0:   if (!\Drupal::service('config.installer')->isSyncing()) {
Chris@0:     // Create a default forum so forum posts can be created.
Chris@0:     $term = Term::create([
Chris@0:       'name' => t('General discussion'),
Chris@0:       'description' => '',
Chris@0:       'parent' => [0],
Chris@0:       'vid' => 'forums',
Chris@0:       'forum_container' => 0,
Chris@0:     ]);
Chris@0:     $term->save();
Chris@0:   }
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Implements hook_uninstall().
Chris@0:  */
Chris@0: function forum_uninstall() {
Chris@0:   if ($field_storage = FieldStorageConfig::loadByName('node', 'taxonomy_forums')) {
Chris@0:     $field_storage->delete();
Chris@0:   }
Chris@0: 
Chris@0:   if ($field_storage = FieldStorageConfig::loadByName('node', 'comment_forum')) {
Chris@0:     $field_storage->delete();
Chris@0:   }
Chris@0: 
Chris@0:   if ($field_storage = FieldStorageConfig::loadByName('taxonomy_term', 'forum_container')) {
Chris@0:     $field_storage->delete();
Chris@0:   }
Chris@0: 
Chris@0:   // Purge field data now to allow taxonomy and options module to be uninstalled
Chris@0:   // if this is the only field remaining.
Chris@0:   field_purge_batch(10);
Chris@0:   // Allow to delete a forum's node type.
Chris@0:   $locked = \Drupal::state()->get('node.type.locked');
Chris@0:   unset($locked['forum']);
Chris@0:   \Drupal::state()->set('node.type.locked', $locked);
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Implements hook_schema().
Chris@0:  */
Chris@0: function forum_schema() {
Chris@0:   $schema['forum'] = [
Chris@0:     'description' => 'Stores the relationship of nodes to forum terms.',
Chris@0:     'fields' => [
Chris@0:       'nid' => [
Chris@0:         'type' => 'int',
Chris@0:         'unsigned' => TRUE,
Chris@0:         'not null' => TRUE,
Chris@0:         'default' => 0,
Chris@0:         'description' => 'The {node}.nid of the node.',
Chris@0:       ],
Chris@0:       'vid' => [
Chris@0:         'type' => 'int',
Chris@0:         'unsigned' => TRUE,
Chris@0:         'not null' => TRUE,
Chris@0:         'default' => 0,
Chris@0:         'description' => 'Primary Key: The {node}.vid of the node.',
Chris@0:       ],
Chris@0:       'tid' => [
Chris@0:         'type' => 'int',
Chris@0:         'unsigned' => TRUE,
Chris@0:         'not null' => TRUE,
Chris@0:         'default' => 0,
Chris@0:         'description' => 'The {taxonomy_term_data}.tid of the forum term assigned to the node.',
Chris@0:       ],
Chris@0:     ],
Chris@0:     'indexes' => [
Chris@0:       'forum_topic' => ['nid', 'tid'],
Chris@0:       'tid' => ['tid'],
Chris@0:     ],
Chris@0:     'primary key' => ['vid'],
Chris@0:     'foreign keys' => [
Chris@0:       'forum_node' => [
Chris@0:         'table' => 'node',
Chris@0:         'columns' => [
Chris@0:           'nid' => 'nid',
Chris@0:           'vid' => 'vid',
Chris@0:         ],
Chris@0:       ],
Chris@0:     ],
Chris@0:   ];
Chris@0: 
Chris@0:   $schema['forum_index'] = [
Chris@0:     'description' => 'Maintains denormalized information about node/term relationships.',
Chris@0:     'fields' => [
Chris@0:       'nid' => [
Chris@0:         'description' => 'The {node}.nid this record tracks.',
Chris@0:         'type' => 'int',
Chris@0:         'unsigned' => TRUE,
Chris@0:         'not null' => TRUE,
Chris@0:         'default' => 0,
Chris@0:       ],
Chris@0:       'title' => [
Chris@0:         'description' => 'The node title.',
Chris@0:         'type' => 'varchar',
Chris@0:         'length' => 255,
Chris@0:         'not null' => TRUE,
Chris@0:         'default' => '',
Chris@0:       ],
Chris@0:       'tid' => [
Chris@0:          'description' => 'The term ID.',
Chris@0:          'type' => 'int',
Chris@0:          'unsigned' => TRUE,
Chris@0:          'not null' => TRUE,
Chris@0:          'default' => 0,
Chris@0:       ],
Chris@0:       'sticky' => [
Chris@0:         'description' => 'Boolean indicating whether the node is sticky.',
Chris@0:         'type' => 'int',
Chris@0:         'not null' => FALSE,
Chris@0:         'default' => 0,
Chris@0:         'size' => 'tiny',
Chris@0:       ],
Chris@0:       'created' => [
Chris@0:         'description' => 'The Unix timestamp when the node was created.',
Chris@0:         'type' => 'int',
Chris@0:         'unsigned' => TRUE,
Chris@0:         'not null' => TRUE,
Chris@0:         'default' => 0,
Chris@0:       ],
Chris@0:       'last_comment_timestamp' => [
Chris@0:         'type' => 'int',
Chris@0:         'not null' => TRUE,
Chris@0:         'default' => 0,
Chris@0:         'description' => 'The Unix timestamp of the last comment that was posted within this node, from {comment}.timestamp.',
Chris@0:       ],
Chris@0:       'comment_count' => [
Chris@0:         'type' => 'int',
Chris@0:         'unsigned' => TRUE,
Chris@0:         'not null' => TRUE,
Chris@0:         'default' => 0,
Chris@0:         'description' => 'The total number of comments on this node.',
Chris@0:       ],
Chris@0:     ],
Chris@0:     'indexes' => [
Chris@0:       'forum_topics' => ['nid', 'tid', 'sticky', 'last_comment_timestamp'],
Chris@0:       'created' => ['created'],
Chris@0:       'last_comment_timestamp' => ['last_comment_timestamp'],
Chris@0:     ],
Chris@0:     'foreign keys' => [
Chris@0:       'tracked_node' => [
Chris@0:         'table' => 'node',
Chris@0:         'columns' => ['nid' => 'nid'],
Chris@0:       ],
Chris@0:       'term' => [
Chris@0:         'table' => 'taxonomy_term_data',
Chris@0:         'columns' => [
Chris@0:           'tid' => 'tid',
Chris@0:         ],
Chris@0:       ],
Chris@0:     ],
Chris@0:   ];
Chris@0: 
Chris@0:   return $schema;
Chris@0: }