oliverdavies.uk/content/node.7b10727a-2349-4337-8e3e-9ae04f0e98c2.yml

69 lines
4 KiB
YAML

uuid:
- value: 7b10727a-2349-4337-8e3e-9ae04f0e98c2
langcode:
- value: en
type:
- target_id: daily_email
target_type: node_type
target_uuid: 8bde1f2f-eef9-4f2d-ae9c-96921f8193d7
revision_timestamp:
- value: '2025-05-11T09:00:44+00:00'
revision_uid:
- target_type: user
target_uuid: b8966985-d4b2-42a7-a319-2e94ccfbb849
revision_log: { }
status:
- value: true
uid:
- target_type: user
target_uuid: b8966985-d4b2-42a7-a319-2e94ccfbb849
title:
- value: |
The single responsibility principle
created:
- value: '2023-05-09T00:00:00+00:00'
changed:
- value: '2025-05-11T09:00:44+00:00'
promote:
- value: false
sticky:
- value: false
default_langcode:
- value: true
revision_translation_affected:
- value: true
path:
- alias: /daily/2023/05/09/the-single-responsibility-principle
langcode: en
body:
- value: |
<p>Today, I added a new feature to a project that allows a member to search for a node based on either its title or a specified field on that node, select a result from an autocomplete list and then be redirected to their selected node.</p>
<p>I've already implemented this for other node types but needed to do the same for this node type.</p>
<p>There are some differences, such as the node type to query for; the additional field depends on which node type as does the text shown in the autocomplete list.</p>
<p>To do this, I needed to add a custom block and form, update the <code>AutocompleteController</code>, create a new instance of a <code>NodeQuery</code> class (a custom class within the custom module), register it as a service and update the <code>SearchQueryFactory</code> class.</p>
<p>A principle that I follow as much as possible is the single responsibility principle, or SRP (the 'S' in SOLID), where each function or class only has one responsibility - such as returning a response for the autocomplete list, determining the correct node query to use based on the search being run or building the query itself - these are separated and split into their own files.</p>
<p>Although more files and functions are created when coding in this way, though they are smaller and more straightforward to work with - which makes them easier to read, debug and maintain. It also makes code like the node query classes reusable as they aren't embedded within a larger class and are easier to test.</p>
format: full_html
processed: |
<p>Today, I added a new feature to a project that allows a member to search for a node based on either its title or a specified field on that node, select a result from an autocomplete list and then be redirected to their selected node.</p>
<p>I've already implemented this for other node types but needed to do the same for this node type.</p>
<p>There are some differences, such as the node type to query for; the additional field depends on which node type as does the text shown in the autocomplete list.</p>
<p>To do this, I needed to add a custom block and form, update the <code>AutocompleteController</code>, create a new instance of a <code>NodeQuery</code> class (a custom class within the custom module), register it as a service and update the <code>SearchQueryFactory</code> class.</p>
<p>A principle that I follow as much as possible is the single responsibility principle, or SRP (the 'S' in SOLID), where each function or class only has one responsibility - such as returning a response for the autocomplete list, determining the correct node query to use based on the search being run or building the query itself - these are separated and split into their own files.</p>
<p>Although more files and functions are created when coding in this way, though they are smaller and more straightforward to work with - which makes them easier to read, debug and maintain. It also makes code like the node query classes reusable as they aren't embedded within a larger class and are easier to test.</p>
summary: null
field_daily_email_cta: { }