Issue #66: Add template for search

[TomoTsuyuki]

Include a template area for searching.

Testing instruction

• Go to "Site administration" > "General" > "Advanced features".
• Enable Global search.
• Go to "Site administration" > "Plugins" > "Activity modules" > "CMS" > "Manage content types"
• Click "Add new content type".
• Set "Template test" in "Name", "test" in "ID Number", "Template test" in "Name" under "Activity fields", and "{{name}} Testsearchstring" in "Content" under "Activity field".
• Click "Save and display" and confirm the "Some name Testsearchstring" is in "Preview"
• Create a course.
• Turn on "Edit mode" and add "Template test" CMS activity.
• Go to "Site administration" > "Plugin" > "Search" > "Search areas".
• Click "Gradual reindex" for cms activity, and run "Global search indexing" schedule task.
• Search "Testsearchstring" in global search box.
• Confirm the "Testsearchstring" is in the result.

[TomoTsuyuki]

I updated the code to try to use a rendered template, if possible.
Some of data sources may be used with user records and the renderer may throw an exception.
Use raw template when rendered template doesn't work.
Note: User-specific data cannot be indexed.

[TomoTsuyuki]

Updated instruction with custom field:

• Go to "Site administration" > "General" > "Advanced features".
• Enable Global search.
• Go to "Site administration" > "Plugins" > "Activity modules" > "CMS" > "Manage content types"
• Click "Add new content type".
• Set "Template test" in "Name", "test" in "ID Number", tick "Custom fields" for "Datasources", "Template test" in "Name" under "Activity fields", and "{{name}} Testsearchstring {{fields.test}}" in "Content" under "Activity field".
• Click "Save and display" and confirm the "Some name Testsearchstring" is in "Preview"
• Click "Add a new category" in "Custom field settings".
• Click "Add a new custom field", and click "Short text".
• Set "Test" in "Name", "test" in "Short name", and click "Save changes".
• Create a course.
• Turn on "Edit mode" and add "Template test" CMS activity with "CustomFieldTest" in "Other fields".
• Go to "Site administration" > "Plugin" > "Search" > "Search areas".
• Click "Gradual reindex" for cms activity, and run "Global search indexing" schedule task.
• Search "Testsearchstring" in global search box.
• Confirm the "Testsearchstring" is in the result.
• Search "CustomFieldTest" in global search box.
• Confirm the "CustomFieldTest" is in the result.

[TomoTsuyuki]

I merged file search from other PR, as it's for same issue.

Testing instruction for file search:

• Install customfield_file plugin into customfield/field/file
• Go to "Site administration" > "General" > "Advanced features".
• Enable Global search.
• Go to "Site administration" > "Plugin" > "Search" > "Manage global search".
• Choose search engine which supports file search.
• Set up the search engine and turn on "File search".
• Go to "Site administration" > "Plugins" > "Activity modules" > "CMS" > "Manage content types"
• Click "Add new content type".
• Set "File test" in "Name", "filetest" in "ID Number", tick "Custom fields" for "Datasources", "File test" in "Name" under "Activity fields".
• Click "Save and display".
• Click "Add a new category" in "Custom field settings".
• Click "Add a new custom field", and click "File".
• Set "Test file" in "Name", "testfile" in "Short name", and click "Save changes".
• Create a course.
• Prepare a text file, "Filestring" in the file. (e.g. using command echo 'Filestring' > testfile)
• Turn on "Edit mode" and add "Test file" CMS activity, and upload the prepared file..
• Go to "Site administration" > "Plugin" > "Search" > "Search areas".
• Click "Gradual reindex" for cms activity, and run "Global search indexing" schedule task.
• Search "Filestring" in global search box.
• Confirm the "Filestring" is in the result.

[dmitriim]

is it correct context ID for files?

[TomoTsuyuki]

For file customfiled, it's using context which is from custom field handler context.
$context = $this->get_field()->get_handler()->get_configuration_context();
https://github.com/andrewhancox/moodle-customfield_file/blob/11a770aa46fa170d498a062a6cf3c75def145bc4/classes/data_controller.php#L76

The get_configuration_context function in mod_cms is using \context_system::instance();, so the context for the file should be correct.

moodle-mod_cms/classes/customfield/cmsfield_handler.php

Line 41 in ba37892

return \context_system::instance();

[dmitriim]

Can you please create an issue for mod_cms and cross link it to andrewhancox/moodle-customfield_file#10
So we can fix mod_cms search once related customfield_file is fixed.

[TomoTsuyuki]

I added the issue #136