EXT: Search in Tables¶

[tableName]¶

[tableName].name¶

[tableName].fields¶

[tableName].pidList¶

[tableName].recursive¶

[tableName].orderBy¶

[tableName].selectAdditionalParams¶

[tableName].listHeader¶

plugin.tx_fesearchintable_pi1.searchTables {
tt_news.listHeader = COA
      tt_news.listHeader {
        10 = TEXT
        10.value = News
        10.wrap = <h3 style="background-color:#FFCC66; color:white; padding: 4px">|</h3>
       }
}

[tableName].listItem¶

[tableName].listStdWrap¶

[tableName].singleView¶

Searching inside the News:¶

The extension includes the following example, a configuration to search in the News (tt_news) table, which is being breaked at this document to include some explanations:

plugin.tx_fesearchintable_pi1 {

...
searchTables {

      #### TT_NEWS is provided as an example###

basic setup for the table:

tt_news = 1
tt_news.name = News
tt_news.fields = title,short,bodytext,keywords,author
tt_news.pidList =
tt_news.recursive =
tt_news.orderBy =
tt_news.selectAdditionalParams = AND 1=1

listHeader setup for the table:

It is a standard cObject. You should try to use the same listHeader for each table, changing only the title to reflect the table's name, to keep an uniformed presentation.

tt_news.listHeader = COA
tt_news.listHeader {
  10 = TEXT
  10.value = News
  10.wrap = <h3 style="background-color:#FFCC66; color:white; padding: 4px">|</h3>
 }

listItem setup for the table:

It is also a standard cObject configuration. Same considerations as with listHeader should be taken to guarantee an uniformed presentation.

tt_news.listItem = COA
tt_news.listItem {
  stdWrap.wrap = <li>|</li>
  10 = TEXT
  10.field = title
  10.wrap = <strong>News: </strong><strong style='color:#006699;'>|</strong><br>
  20 = TEXT
  20.field = short//bodytext
  20.crop = 40|...&nbsp;
  30 = TEXT
  30.value = more<font size=1>></font>

Typolink:

The next lines creates a link using standard typoscript.

The way it is created assumes that you are NOT using Real URL, but the default “index.php?id=” method. If you are using Real URL, please consider modificating the next line to include a “?” at the beginning of the url variables.

     30.typolink.parameter.data = TSFE:id
  30.typolink.wrap = <strong>|</strong>
  30.typolink.ATagBeforeWrap = 1
  // we add the tx_ttnews[tt_news] var as this one is the used by the tt_news extension to recognize the uid on single view.
          30.typolink.additionalParams.dataWrap = &tx_fesearchintable_pi1[sTable]=tt_news&tx_fesearchintable_pi1[sUID]={field:uid}&tx_ttnews[tt_news]={field:uid}
}
tt_news.listStdWrap.wrap = <ol style="margin-top:-10px">|</ol>

single view setup for the table:

In our example, the .singleView property (below) takes advantage of cObject “plugin.tt_news”, so we take care to pass the tx_ttnews[tt_news] var in our link, as the tt_news plugin expects that variable to recognize the single record to show.

      tt_news.singleView < plugin.tt_news
      tt_news.singleView.code >
      tt_news.singleView.code = SINGLE
   }
...
}

We could have decided other ways of rendering the Single View of the News record, instead of configuring the “.singleVew” option:

For example, you can decide to send the user to the page which you already have configured to view the single news, like this:

plugin.tx_fesearchintable_pi1.searchTables {
        ...
        tt_news.listItem.30.typolink.parameter.data >
        tt_news.listItem.30.typolink.parameter = 135
        tt_news.listItem.30.typolink.additionalParams.dataWrap = &tx_ttnews[tt_news]={field:uid}
        ...
}

In this example, 135 is the uid of the page which I have already configured to show single news, and the additional parameter adds the needed url var for this to work.

Using the above example, you should be able to do the same with other extensions that allow single view.

Searching in many tables¶

To search in many tables you need to write the proper setup configuration. For example, to search at the News table AND the Modern FAQ table, you need to write something like this:

plugin.tx_fesearchintable_pi1 {
   searchTables {

          ### Modern FAQ ->  tx_irfaq_q###
          tx_irfaq_q = 1
          tx_irfaq_q.name = FAQ
          tx_irfaq_q.fields = q,a
          tx_irfaq_q.pidList = 182
        tx_irfaq_q.recursive = 0

the Modern FAQ has 4 tables, and the faqs are held on the “tx_irfaq_q” table.

The Modern FAQ table has many fields, and the fields where the questions and answers are kept, are named “q” and “a” respectively.

We had to put the property .pidList = 182, as there is where our FAQ are held.

We write our results listing header for the section:

  tx_irfaq_q.listHeader = COA
  tx_irfaq_q.listHeader {
        10 = TEXT
10.value = FAQ
10.wrap = <h3 style="background-color:#FFCC66; color:white; padding: 4px">|</h3>
  }

which prints like this:

and write how each search result item has to be presented:

tx_irfaq_q.listItem = COA
tx_irfaq_q.listItem {
  stdWrap.wrap = <li>|</li>
  10 = TEXT
  10.field = q
  10.wrap = <strong>FAQ: </strong><strong style='color:#006699;'>|</strong><br>
  20 = TEXT
  20.field = a
  20.crop = 40|...&nbsp;
  30 = TEXT
  30.value = more<font size=1>></font>
  30.typolink.parameter.data = TSFE:id
  30.typolink.wrap = <strong>|</strong>
  30.typolink.ATagBeforeWrap = 1
  30.typolink.additionalParams.dataWrap = &tx_fesearchintable_pi1[sTable]=tx_irfaq_q&&tx_fesearchintable_pi1[sUID]={field:uid}

}
tx_irfaq_q.listStdWrap.wrap = <ol style="margin-top:-10px">|</ol>

The final result is like this:

The “more” link is a standard TEXT cObject, and could be easily configured to accept languages using standard stdWrap functions. Look that in the FAQ example, we decided to render the single element using our own cObject:

tx_irfaq_q.singleView = COA
tx_irfaq_q.singleView {
                  10 = TEXT
                  10.field = q
                  10.wrap = <h3>|</h3><br>
                  20 = TEXT
                  20.field = a
                  20.wrap = |<br><br>
}

Finally, we put the TT_NEWS configuration, shown in the previous example, so the search can be performed on both tables.

The final search result would look like this:

Using additional parameters to build the SELECT query:¶

Suppose you need to allow your users to have other options to build their query. For our example, you whish to allow your user to have a preselected options for their search. In our example, your page has a group of news authors, and, as they can be misspelled, you whish to facilitate your users with a list of their names.

The first step would be to modify your Search Form:

[...]
   form = FORM
   form.dataArray {
                10.label.data = LLL:EXT:fesearchintable/pi1/locallang.php:label.search
                10.label.wrap = |:
                10.type = sword=input,30
                15.label = New's Author
                15.type = author=select
                15.value = Carlos Chiari=carlos, Jhonny Smith=jhonny
                20.type = submit=submit
                20.value.data = LLL:EXT:fesearchintable/pi1/locallang.php:label.search
                }
        form.type = {$plugin.tx_fesearchintable_pi1.resultsPID}
        form.locationData = 1
        form.layout = <tr><td>###LABEL###</td><td> ###FIELD###</td></tr>
        form.labelWrap.wrap = <strong>|</strong>&nbsp;&nbsp;
        form.stdWrap.wrap = <table cellspacing="2" cellpadding="4" border="0">|</table>
      form.wrapFieldName = tx_fesearchintable_pi1[|]
[...]

At form.dataArray.15, we have included a select field. The ouput would be like this:

Now our users are free to select the author without misspelling!

Another cool option would be to write a small script to generate the value of this field, and take advantage of the stdWrap properties of the “value” object to generate the values for this field from a database. Yet, this goes beyond the scope of this little example to explain!

The second step would be to build our query with the selected author, using the .selectAdditionalParams, like this:

[...]
      tt_news.selectAdditionalParams = AND tt_news.author LIKE '%{GPvar:tx_fesearchintable_pi1|author}%'
      tt_news.selectAdditionalParams.insertData = 1
[...]

The third step is to add the additional variables to the “Search for” message, at the beginning of your results list, using this in your typoscript:

[...]
    searchAdditionalPiVars {
        author = author
    }
[...]

The result: