There are no Documents with selected topic.
' + format: limited_html + tokenize: false + sorts: + field_documentation_topics_target_id: + id: field_documentation_topics_target_id + table: site_documentation__field_documentation_topics + field: field_documentation_topics_target_id + relationship: none + group_type: group + admin_label: '' + plugin_id: standard + order: ASC + expose: + label: '' + field_identifier: '' + exposed: false + name: + id: name + table: site_documentation_field_data + field: name + relationship: none + group_type: group + admin_label: '' + entity_type: site_documentation + entity_field: name + plugin_id: standard + order: ASC + expose: + label: '' + field_identifier: name + exposed: false + arguments: { } + filters: + status: + id: status + table: site_documentation_field_data + field: status + entity_type: site_documentation + entity_field: status + plugin_id: boolean + value: '1' + group: 1 + expose: + operator: '' + operator_limit_selection: false + operator_list: { } + field_documentation_topics_target_id: + id: field_documentation_topics_target_id + table: site_documentation__field_documentation_topics + field: field_documentation_topics_target_id + relationship: none + group_type: group + admin_label: '' + plugin_id: taxonomy_index_tid + operator: or + value: { } + group: 1 + exposed: true + expose: + operator_id: field_documentation_topics_target_id_op + label: 'Filter By Topics' + description: '' + use_operator: false + operator: field_documentation_topics_target_id_op + operator_limit_selection: false + operator_list: { } + identifier: field_documentation_topics_target_id + required: false + remember: false + multiple: false + remember_roles: + authenticated: authenticated + administrator: '0' + anonymous: '0' + content_administrator: '0' + reduce: false + is_grouped: false + group_info: + label: '' + description: '' + identifier: '' + optional: true + widget: select + multiple: false + remember: false + default_group: All + default_group_multiple: { } + group_items: { } + reduce_duplicates: false + vid: documentation_topics + type: select + hierarchy: false + limit: true + error_message: true + filter_groups: + operator: AND + groups: + 1: AND + style: + type: grid + options: + grouping: + - + field: field_documentation_topics + rendered: true + rendered_strip: false + uses_fields: true + columns: 4 + automatic_width: true + alignment: horizontal + row_class_custom: '' + row_class_default: true + col_class_custom: '' + col_class_default: true + row: + type: 'entity:site_documentation' + options: + relationship: none + view_mode: teaser + defaults: + empty: false + use_ajax: false + pager: false + style: false + row: false + fields: false + sorts: false + arguments: false + filters: false + filter_groups: false + use_ajax: true + display_description: '' + display_extenders: { } + cache_metadata: + max-age: -1 + contexts: + - 'languages:language_content' + - 'languages:language_interface' + - url + - user + tags: + - 'config:field.storage.site_documentation.field_documentation_topics' diff --git a/css/site_documentation.css b/css/site_documentation.css new file mode 100644 index 0000000..d9c1486 --- /dev/null +++ b/css/site_documentation.css @@ -0,0 +1,4 @@ +.view-related-site-documents .views-row { + margin-top: 1.5rem; + margin-bottom: 1.5rem; +} diff --git a/site_documentation.install b/site_documentation.install new file mode 100644 index 0000000..110c544 --- /dev/null +++ b/site_documentation.install @@ -0,0 +1,39 @@ +getEditable($config); + if ($field_config) { + $field_config->delete(); + } + } + + // Update entity definition of site_documentation. + $sd_definition = $entity_type_manager->getDefinition('site_documentation'); + $entity_definition_update_manager->updateEntityType($sd_definition); + + // Install default configuration for module. + $config_installer->installDefaultConfig('module', 'site_documentation'); + +} diff --git a/site_documentation.libraries.yml b/site_documentation.libraries.yml new file mode 100644 index 0000000..63bcf7a --- /dev/null +++ b/site_documentation.libraries.yml @@ -0,0 +1,4 @@ +site_documentations_list: + css: + theme: + css/site_documentation.css: { } diff --git a/site_documentation.module b/site_documentation.module index 7a4e203..0806ef0 100644 --- a/site_documentation.module +++ b/site_documentation.module @@ -9,6 +9,7 @@ use Drupal\Core\Render\Element; use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Entity\Display\EntityViewDisplayInterface; use Drupal\site_documentation\Entity\SiteDocumentation; +use Drupal\views\Views; /** * Implements hook_module_implements_alter(). @@ -27,6 +28,11 @@ function site_documentation_theme($existing, $type, $theme, $path) { 'site_documentation' => [ 'render element' => 'elements', ], + 'help_section__site_documentation' => [ + 'variables' => [ + 'documents_view' => null, + ], + ], ]; } @@ -34,17 +40,27 @@ function site_documentation_theme($existing, $type, $theme, $path) { * Implements hook_entity_type_build(). */ function site_documentation_site_documentation_view(array &$build, EntityInterface $entity, EntityViewDisplayInterface $display, $view_mode) { - if ($build['#view_mode'] !== 'full') { + if ($build['#view_mode'] !== 'full' + || !$entity->hasField('field_documentation_topics') + || $entity->get('field_documentation_topics')->isEmpty() + || !Views::getView('related_site_documents') + ) { return; } - $docs = $entity->get('all_docs')->getValue(); - $ids = array_flip(array_keys($docs)); - if (isset($ids[$entity->id()])) { - unset($ids[$entity->id()]); + $topics = array_map(function ($topic) { + return $topic['target_id']; + }, $entity->get('field_documentation_topics')->getValue()); + + if (!empty($topics)) { + $build['related_docs'] = [ + '#type' => 'view', + '#name' => 'related_site_documents', + '#display_id' => 'block_1', + '#embed' => TRUE, + '#arguments' => [implode('+', $topics), $entity->id()], + ]; } - $loaded_docs = SiteDocumentation::loadMultiple(array_keys($ids)); - $build['all_docs'] = \Drupal::entityTypeManager()->getViewBuilder('site_documentation')->viewMultiple($loaded_docs, 'teaser'); } /** @@ -57,7 +73,21 @@ function site_documentation_preprocess_site_documentation(&$vars) { foreach (Element::children($vars['elements']) as $key) { $vars['content'][$key] = $vars['elements'][$key]; } +} +/** + * Implements hook_preprocess_HOOK(). + */ +function site_documentation_preprocess_help_section__site_documentation(&$vars) { + if (Views::getView('related_site_documents')) { + $vars['documents_view'] = [ + '#type' => 'view', + '#name' => 'related_site_documents', + '#display_id' => 'block_2', + '#embed' => TRUE, + '#arguments' => [], + ]; + } } /** @@ -70,3 +100,18 @@ function site_documentation_help_section_info_alter(array &$info) { } } } + +/** + * Implements hook_theme_suggestions_alter(). + */ +function site_documentation_theme_suggestions_alter(array &$suggestions, array $variables, $hook) { + if ($hook !== 'help_section') { + return; + } + + if ($variables['title']->render() === 'Site Documentation') { + // Both lines below are needed. + $suggestions[] = 'help_section__site_documentation'; + $variables['theme_hook_original'] = 'help_section__site_documentation'; + } +} diff --git a/src/Entity/SiteDocumentation.php b/src/Entity/SiteDocumentation.php index 0a8af44..ffe3786 100644 --- a/src/Entity/SiteDocumentation.php +++ b/src/Entity/SiteDocumentation.php @@ -158,7 +158,6 @@ public function save() { return parent::save(); } - /** * {@inheritdoc} */ @@ -179,6 +178,7 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) { 'label' => 'hidden', 'type' => 'author', 'weight' => 0, + 'region' => 'hidden' ]) ->setDisplayOptions('form', [ 'type' => 'entity_reference_autocomplete', @@ -190,8 +190,8 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) { 'placeholder' => '', ], ]) - ->setDisplayConfigurable('form', TRUE) - ->setDisplayConfigurable('view', TRUE); + ->setDisplayConfigurable('form', FALSE) + ->setDisplayConfigurable('view', FALSE); $fields['name'] = BaseFieldDefinition::create('string') ->setLabel(t('Name')) @@ -236,12 +236,6 @@ public static function baseFieldDefinitions(EntityTypeInterface $entity_type) { ->setRevisionable(TRUE) ->setTranslatable(TRUE); - $fields['all_docs'] = BaseFieldDefinition::create('entity_reference') - ->setLabel('Computed Reference Field Test') - ->setComputed(TRUE) - ->setSetting('target_type', 'site_documentation') - ->setClass(DocsListing::class); - return $fields; } diff --git a/src/SiteDocumentationListBuilder.php b/src/SiteDocumentationListBuilder.php index 98749e8..efa8125 100644 --- a/src/SiteDocumentationListBuilder.php +++ b/src/SiteDocumentationListBuilder.php @@ -51,4 +51,14 @@ protected function getDefaultOperations(EntityInterface $entity) { return $ops; } + /** + * {@inheritdoc} + */ + public function render() { + $build['#prefix'] = Link::createFromRoute( + $this->t('Add Site Documentation'), + 'entity.site_documentation.add_form', [], ['attributes' => ['class' => 'button button--action button--primary']])->toString(); + return $build + parent::render(); + } + } diff --git a/templates/help-section--site-documentation.html.twig b/templates/help-section--site-documentation.html.twig new file mode 100644 index 0000000..20dac95 --- /dev/null +++ b/templates/help-section--site-documentation.html.twig @@ -0,0 +1,55 @@ +{# +/** + * @file + * Theme override for a section of the help page. + * + * This implementation divides the links into 4 columns. + * + * Available variables: + * - title: The section title. + * - description: The description text for the section. + * - links: Links to display in the section. + * - empty: Text to display if there are no links. + * - documents_view: Site documentations renerdable view. + */ +#} + +{{ attach_library("site_documentation/site_documentations_list") }} + +{{ description }}
+ + {% if documents_view %} + {{ documents_view }} + {% elseif links %} + {# Calculate the column length, to divide links into 4 columns. #} + {% set size = links|length // 4 %} + {% if size * 4 < links|length %} + {% set size = size + 1 %} + {% endif %} + + {# Output the links in 4 columns. #} + {% set count = 0 %} + {% for link in links %} + {% if count == 0 %} + {# Start a new column. #} +{{ empty }}
+ {% endif %} + diff --git a/templates/site-documentation.html.twig b/templates/site-documentation.html.twig index 509ccd9..14a1401 100644 --- a/templates/site-documentation.html.twig +++ b/templates/site-documentation.html.twig @@ -15,40 +15,32 @@ * @ingroup themeable */ #} +{{ attach_library("site_documentation/site_documentations_list") }}