get($parent_id)->find() rather than $pages->find().
* @property int $template_id Limit results to pages using this template.
* @property string $labelFieldName Field to display in the results. (default=title)
* @property string $labelFieldFormat Format string to display in the results, overrides labelFieldName when used (default=blank).
* @property string $searchFields Field(s) to search for text. Separate multiple by a space. (default=title)
* @property string $operator Selector operator to use in performing the search (default: %=)
* @property string $findPagesSelector Optional selector to use for finding pages (default=blank)
* @property int $maxSelectedItems Maximum number of items that may be selected (0=unlimited, default).
* @property bool $useList Whether or not to use a separate selected list. If false specified, selected item will be populated directly to the input. (default=true)
* @property bool $allowAnyValue Allow any value to stay in the input, even if not selectable? (default=false)
* @property string $disableChars Autocomplete won't be triggered if input contains any of the characters in this string. (default=blank)
* @property bool $useAndWords When true, each word will be isolated to a separate searchFields=searchValue, which enables it to duplicate ~= operator behavior while using a %= operator (default=false).
* @property int $lang_id Force use of this language for results
*
*/
class InputfieldPageAutocomplete extends Inputfield implements InputfieldHasArrayValue {
public static function getModuleInfo() {
return array(
'title' => __('Page Auto Complete', __FILE__), // Module Title
'summary' => __('Multiple Page selection using auto completion and sorting capability. Intended for use as an input field for Page reference fields.', __FILE__), // Module Summary
'version' => 111,
);
}
/**
* Initialize variables used for the autocompletion
*
*/
public function init() {
parent::init();
// limit results to this parent, or if combined with a 'findPagesSelector',
// the search is performed as $pages->get($parent_id)->find() rather than $pages->find()
$this->set('parent_id', 0);
// limit results to pages using this template
$this->set('template_id', 0);
// field to display in the results
$this->set('labelFieldName', 'title');
// format string to display in the results (instead of labelFieldName, when used)
$this->set('labelFieldFormat', '');
// field(s) to search for text, separate multiple by a space
$this->set('searchFields', 'title');
// operator to use in performing the search
$this->set('operator', '%=');
// optional selector to use for all other properties
$this->set('findPagesSelector', '');
// maximum number of items that may be selected
$this->set('maxSelectedItems', 0);
// whether or not to use the selection list
// if not used, selected value will be populated directly to input
$this->set('useList', true);
// allow a non-selectable value to stay in the autocomplete input?
// useful for situations where autocomplete might be used for collection of other values
// like when used with ProcessPageEditLink
$this->set('allowAnyValue', false);
// autocomplete won't be triggered if input contains any characters present in this string
$this->set('disableChars', '');
// when true, each word will be isolated to a separate searchFields=searchValue, which
// enables it to duplicate ~= operator behavior while using a %= operator.
$this->set('useAndWords', false);
// Force Language when applicable
$this->set('lang_id', 0);
}
/**
* Render a selected list item
*
*/
protected function ___renderListItem($label, $value, $class = '') {
if($class) $class = " $class";
if(strpos($label, '&') !== false) $label = $this->wire('sanitizer')->unentities($label);
$label = $this->wire('sanitizer')->entities($label);
$out =
"\n
_OUT;
/*
*/
return $out;
}
/**
* Convert the CSV string provided in the $input to an array of ints needed for this fieldtype
*
*/
public function ___processInput(WireInputData $input) {
parent::___processInput($input);
$value = $this->attr('value');
if(is_array($value)) $value = reset($value);
$value = trim($value);
if(strpos($value, ",") !== false) $value = explode(",", $value);
else if($value) $value = array($value);
else $value = array();
foreach($value as $k => $v) {
$value[$k] = (int) $v;
}
$this->attr('value', $value);
return $this;
}
/**
* Get the AJAX search URL that will be queried (minus the actual term)
*
* This URL is focused on using the AJAX API from ProcessPageSearch
*
*/
protected function getAjaxUrl() {
$selector = $this->findPagesSelector;
if($this->parent_id) {
if($selector) {
// if a selector was specified, AND a parent, then we'll use the parent as a root
$selector .= ",has_parent={$this->parent_id}";
} else {
// otherwise matches must be direct children of the parent
$selector = "parent_id={$this->parent_id}";
}
}
if($this->template_id) {
$selector .= ",templates_id={$this->template_id}";
}
if($this->lang_id) {
$selector .= ",lang_id=" . (int) $this->lang_id;
}
// allow for full site matches
if(!strlen($selector)) $selector = "id>0";
// match no more than 50, unless selector specifies it's own limit
if(strpos($selector, 'limit=') === false) $selector .= ",limit=50";
// replace non-escaped commas with ampersands
$selector = preg_replace('/(?labelFieldFormat) {
$name = "autocomplete_" . $this->attr('name');
$this->wire('modules')->get('ProcessPageSearch')->setDisplayFormat($name, $this->labelFieldFormat, true);
$selector .= "&format_name=$name";
}
$selector .= "&get=" . $this->labelFieldName;
return $this->config->urls->admin . "page/search/for?" . $selector;
}
/**
* Install the autocomplete module
*
* Make sure we're in InputfieldPage's list of valid page selection widgets
*
*/
public function ___install() {
$data = $this->wire('modules')->getModuleConfigData('InputfieldPage');
$data['inputfieldClasses'][] = $this->className();
$this->wire('modules')->saveModuleConfigData('InputfieldPage', $data);
}
/**
* Uninstall the autocomplete module
*
* Remove from InputfieldPage's list of page selection widgets
*
*/
public function ___uninstall() {
$data = $this->wire('modules')->getModuleConfigData('InputfieldPage');
foreach($data['inputfieldClasses'] as $key => $value) {
if($value == $this->className()) unset($data['inputfieldClasses'][$key]);
}
$this->wire('modules')->saveModuleConfigData('InputfieldPage', $data);
}
/**
* Provide configuration options for modifying the behavior when paired with InputfieldPage
*
*/
public function ___getConfigInputfields() {
$inputfields = parent::___getConfigInputfields();
$fieldset = $this->wire('modules')->get('InputfieldFieldset');
$fieldset->label = $this->_('Autocomplete Advanced Options');
$fieldset->collapsed = Inputfield::collapsedYes;
$recommended = $this->_('Recommended');
$field = $this->modules->get('InputfieldRadios');
$field->setAttribute('name', 'operator');
$field->label = $this->_('Autocomplete search operator');
$field->description = $this->_("The search operator that is used in the API when performing autocomplete matches.");
$field->notes = $this->_("If you aren't sure what you want here, leave it set at the default: *=");
$field->required = false;
$field->addOption('*=', '*= ' . $this->_("Contains phrase or partial word (using fulltext index) - Recommended"));
$field->addOption('%=', '%= ' . $this->_("Contains phrase or partial word (using LIKE)") . " - $recommended");
$field->addOption('~=', '~= ' . $this->_("Contains all the [full] words, in any order"));
$field->addOption('^=', '^= ' . $this->_("Starts with word/phrase"));
$field->addOption('$=', '$= ' . $this->_("Ends with word/phrase"));
$field->addOption('=', '= ' . $this->_("Equals [exact]"));
$field->attr('value', $this->operator);
$field->collapsed = Inputfield::collapsedNo;
$fieldset->add($field);
$field = $this->modules->get('InputfieldText');
$field->attr('name', 'searchFields');
$field->label = $this->_('Fields to query for autocomplete');
$field->description = $this->_('Enter the names of the fields that should have their text queried for autocomplete matches. Typically this would just be the title field, but you may add others by separating each with a space. Note that this is different from the "Label Field" (above). Here you are specifying what fields will be searched, not what fields will be shown.');
$field->collapsed = Inputfield::collapsedNo;
$field->attr('value', $this->searchFields);
$notes = $this->_('Indexed text fields include:');
foreach($this->wire('fields') as $f) {
if(!$f->type instanceof FieldtypeText) continue;
$notes .= ' ' . $f->name . ',';
}
$field->notes = rtrim($notes, ',');
$fieldset->add($field);
$inputfields->add($fieldset);
return $inputfields;
}
}