* @license Mozilla Public License v2.0 https://mozilla.org/MPL/2.0/
*/
class Config extends Base {
/**
* Config data array passed from the SearchEngine module
*
* @var array
*/
protected $data = [];
/**
* SearchEngine module Runtime options
*
* @var array
*/
protected $options = [];
/**
* Constructor method
*
* @param array $data Config data array.
*/
public function __construct(array $data) {
parent::__construct();
$this->data = $data;
$this->options = $this->getOptions();
}
/**
* Validate (and optionally create new) index field
*/
public function validateIndexField() {
$index_field_name = $this->data['index_field'] ?? $this->options['index_field'] ?? null;
if (!empty($index_field_name)) {
$index_field_name = $this->wire('sanitizer')->fieldName($index_field_name);
$create_link_base = $this->wire('config')->urls->admin . 'module/edit?name=SearchEngine&create_index_field=';
$search_engine = $this->wire('modules')->get('SearchEngine');
if ($this->wire('input')->get('create_index_field') == 1) {
$index_field = $search_engine->createIndexField($index_field_name, $create_link_base . '2');
}
$index_field = $search_engine->getIndexField($index_field_name);
if (!$index_field) {
$create_link = ' '
. $this->_('Click here to create the index field automatically.')
. '';
$this->wire->message(sprintf(
$this->_('Index field "%s" (FieldtypeTextarea or FieldtypeTextareaLanguage) doesn\'t exist.'),
$index_field_name
) . $create_link, \ProcessWire\Notice::allowMarkup);
} else if (!$index_field->_is_valid_index_field) {
$this->wire->error(sprintf(
$this->_('Index field "%s" exists but is of incompatible type (%s). Please create a new index field or convert existing field to a supported type (FieldtypeTextarea or FieldtypeTextareaLanguage).'),
$index_field_name,
$index_field->type->name
));
} else if (!$index_field->getTemplates()->count()) {
$this->wire->message(sprintf(
$this->_('Index field "%s" hasn\'t been added to any templates yet. Add to one or more templates to start indexing content.'),
$index_field_name
));
}
}
}
/**
* Get all config fields for the module
*
* @return InputfieldWrapper InputfieldWrapper with module config inputfields.
*/
public function getFields(): InputfieldWrapper {
// Debugger AJAX endpoint
(new Debugger)->initAJAXAPI();
// inject scripts
foreach (['Core', 'Config'] as $script) {
$this->wire('config')->scripts->add(
$this->wire('config')->urls->get('SearchEngine') . 'js/' . $script . '.js'
);
}
// inject styles
foreach (['config'] as $styles) {
$this->wire('config')->styles->add(
$this->wire('config')->urls->get('SearchEngine') . 'css/' . $styles . '.css'
);
}
$fields = $this->wire(new InputfieldWrapper());
$fields->add($this->getIndexingOptionsFieldset());
$fields->add($this->getFinderSettingsFieldset());
$fields->add($this->getManualIndexingFieldset());
$fields->add($this->getAdvancedSettingsFieldset());
if ($this->wire('user')->isSuperuser()) {
$fields->add($this->getDebuggerSettingsFieldset());
}
return $fields;
}
/**
* Get a fieldset containing indexing settings
*
* @return InputfieldFieldset
*/
protected function getIndexingOptionsFieldset(): InputfieldFieldset {
/** @var InputfieldFieldset Indexing options */
$indexing_options = $this->wire('modules')->get('InputfieldFieldset');
$indexing_options->label = $this->_('Indexing options');
$indexing_options->icon = 'database';
$indexing_options->columnWidth = 50;
/** @var InputfieldAsmSelect Indexed fields */
$indexed_fields = $this->wire('modules')->get('InputfieldAsmSelect');
$indexed_fields->name = 'indexed_fields';
$indexed_fields->label = $this->_('Select indexed fields');
$indexed_fields->addOptions([
'id' => 'id',
'name' => 'name',
]);
$compatible_fieldtype_options = $this->options['compatible_fieldtypes'] ?? [];
if (!empty($this->data['override_compatible_fieldtypes'])) {
$compatible_fieldtype_options = $this->data['compatible_fieldtypes'] ?? [];
}
if (!empty($compatible_fieldtype_options)) {
foreach ($this->wire('fields')->getAll() as $field) {
if (!in_array($field->type, $compatible_fieldtype_options) || $field->name === $this->options['index_field']) {
continue;
}
$indexed_fields->addOption($field->name);
}
}
if (!empty($this->wire('config')->SearchEngine[$indexed_fields->name])) {
$indexed_fields->notes = $this->_('Indexed fields are currently defined in site config. You cannot override config settings here.');
$indexed_fields->value = $this->options[$indexed_fields->name];
$indexed_fields->collapsed = Inputfield::collapsedNoLocked;
} else {
$indexed_fields->value = $this->data[$indexed_fields->name] ?? $this->options[$indexed_fields->name] ?? null;
}
$indexing_options->add($indexed_fields);
/** @var InputfieldCheckboxes Indexed templates */
$indexed_templates = $this->wire('modules')->get('InputfieldCheckboxes');
$indexed_templates->name = 'indexed_templates';
$indexed_templates->label = $this->_('Indexed templates');
$indexed_templates->description = $this->_('In order for a template to be indexed, it needs to include the index field. You can use this setting to add the index field to one or more templates, or remove it from templates it has previously been added to.');
$index_field_templates = $this->wire('fields')->get($this->options['index_field'])->getTemplates()->get('name[]');
foreach ($this->wire('templates')->getAll() as $template) {
$option_attributes = null;
if ($template->flags & \ProcessWire\Template::flagSystem) {
if (!in_array($template->name, $index_field_templates)) continue;
$option_attributes = ['disabled' => 'disabled'];
$indexed_templates->notes = $this->_('One or more system templates are indexed. In order to make system templates indexable (or non-indexable) you need to modify template settings directly.');
}
$indexed_templates->addOption($template->name, null, $option_attributes);
}
$indexed_templates->optionColumns = 1;
$indexed_templates->value = $index_field_templates;
$indexing_options->add($indexed_templates);
return $indexing_options;
}
/**
* Get a fieldset containing finder settings
*
* @return InputfieldFieldset
*/
protected function getFinderSettingsFieldset(): InputfieldFieldset {
/** @var InputfieldFieldset Finder settings */
$finder_settings = $this->wire('modules')->get('InputfieldFieldset');
$finder_settings->label = $this->_('Finder settings');
$finder_settings->icon = 'search';
$finder_settings->columnWidth = 50;
/** @var InputfieldText Sort order */
$sort = $this->wire('modules')->get('InputfieldText');
$sort->name = 'find_args__sort';
$sort->label = $this->_('Sort order');
$sort->description = $this->_('Sort order used when finding content. See [documentation for sorting results](https://processwire.com/docs/selectors/#sort) for more details.');
$sort->notes = $this->_('Note: you may use multiple sort fields by separating each field with a comma (sort,title,-date_from).');
$sort = $this->maybeUseConfig($sort);
$finder_settings->add($sort);
/** @var InputfieldSelect Operator */
$operator = $this->wire('modules')->get('InputfieldSelect');
$operator->name = 'find_args__operator';
$operator->label = $this->_('Operator');
$operator->description = $this->_('Operator used when finding content. See [documentation for operators](https://processwire.com/docs/selectors/#operators) for more details.');
$operator_options = [
'*=',
'~=',
'%=',
];
if (version_compare($this->wire('config')->version, '3.0.160') > -1) {
// new operators introduced in ProcessWire 3.0.160
$operator_options = array_merge($operator_options, [
'~*=',
'~~=',
'~%=',
'~+=',
'~|=',
'~|*=',
'~|%=',
'~|+=',
'*+=',
'**=',
'**+=',
'#=',
]);
foreach ($operator_options as $operator_option) {
$operator_option_class = \ProcessWire\Selectors::$selectorTypes[$operator_option] ?? null;
if ($operator_option_class) {
$operator_option_class = '\ProcessWire\\' . $operator_option_class;
$operator->addOption(
$operator_option,
'[' . $operator_option . '] ' . $operator_option_class::getLabel()
);
}
}
} else {
// fallback for ProcessWire < 3.0.160
$operator->addOptions([
'*=' => '[*=] ' . $this->_('Contains the exact word or phrase'),
'~=' => '[~=] ' . $this->_('Contains all the words'),
'%=' => '[%=] ' . $this->_('Contains the exact word or phrase (using slower SQL LIKE)'),
]);
}
$operator->notes .= $this->_('More information in the [documentation page for operators](https://processwire.com/docs/selectors/operators/).');
$operator = $this->maybeUseConfig($operator);
$finder_settings->add($operator);
if (version_compare($this->wire('config')->version, '3.0.160') > -1) {
/** @var InputfieldMarkup Additional information for each available operator */
$operator_details = $this->wire('modules')->get('InputfieldMarkup');
$operator_details->value = '