template

array-> Local

Integration of your template in the Browser plugin/flexform

Tutorial:

http://typo3.org/documentation/document-library/extension-manuals/browser_tut_templating_en/current/

Example:

plugin.tx_browser_pi1 {

  template {

    extensions {

        // BEGIN of your configuration

        // [String/Array] extension key

      org {

          // [String/Array] template name (inern)

        news {

            // [String] name for plugin/flexform

          name = Org: Nachrichten

            // [String] path to the template

          file = EXT:org/res/news/401/default.tmpl

            // [Integer/CSV] Comma seperated list of

            //   the views id, which can process

            //   the template

          csvViews  = 401

        }

      }

        // END of your configuration

    }

  }

}

localTable

-> Local

autoconfig

-> Local

format

array

Configuration for the PHP method strftime().

Example:

plugin.tx_browser_pi1 {

  format {

    strftime = %a, %d.%b.%y

    strftime {

      utf8_encode = 1

    }

  }

}

See the example

general_stdWrap

-> Local

navigation.modeSelector

array

Wrapping of the items in the tabs (mode selector) before wrapped with a link. Sometimes it is useful for the CSS.

Example:

plugin.tx_browser_pi1 {

  navigation.modeSelector.wrap = <span>|</span>

}

empty

document_stdWrap

-> Local

displaySingle

-> Local

displayList

-> Local

upload

-> Local

advanced

-> Local

views

array

See the reference table "Views" below (page 23)

andWhere

-> Local

See the property "n.andWhere" below (page 38)

marker

-> Local

_LOCAL_LANG

array

See the reference table "_LOCAL_LANG" below (page 43)

development

array

Please read the comment in the TypoScript code.

And sorry, that there isn't any other documentation.

performance

array

Please read the comment in the TypoScript code.

And sorry, that there isn't any other documentation.

recursionGuard

int

The Browser uses some methods recursive. The recursion guard prevents unlimited loops and take care about performance.

You can increase the value of the recursion guard.

Example:

plugin.tx_browser_pi1.advanced {

  recursionGuard = 10000

}

10000

localization

-> array

See the section Localization below.

realUrl

-> array

See the section realUrl in the Reference  below.

security

array

Please read the comment in the TypoScript code.

And sorry, that there isn't any other documentation.

sql

array

Please read the comment in the TypoScript code.

And sorry, that there isn't any other documentation.

tca

array

Please read the comment in the TypoScript code.

And sorry, that there isn't any other documentation.

n

array

Array with your list views.

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    ...

  }

}

n.name

string

Name of the list view. Name will be displayed in the plugin.

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    name = Organiser: Events

  }

}

n.template

array

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    template < plugin.tx_browser_pi1.template

    temlate {

      ...

    }

  }

}

See table Local

n.relations.type

array

Array with your database relations.

type is mm only until now.

Commendation:

You can build the relation for all possibilities you need and copy it to every view (like the example above).

Browser will use only the relations, it need for building the query of the view.

Tutorial:

Tutorial Database

Debugging:

See "Debugging SQL statements" on page 20.

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    relations.mm = ...

    ...

  }

  2 < .1

}

n.record

array

Array with

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    record {

      uid = tx_ships_main.uid

      pid = tx_ships_main.pid

    }

  }

}

n.select

string,stdWrap

The query with the field names, which you want display in the frontend.

You don't need the uid and the pid of the main record (see property record above).

Browser builds SQL statements according to the limit by TYPO3 - i. e. fe-user-rights, hidden records.

Tutorial:

See Tutorial Quick Start above

Tutorial Basics

Debugging:

See "Debugging SQL statements" on page 20.

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    select = tt_news.title, tt_news_cat.title

  }

}

plugin.tx_browser_pi1.views.list {

  1 {

    select = COA

    select {

      10 = TEXT

      10 {

        value = tt_news.title

        lang {

          de = tt_news.title_de

        }

        wrap = |,

      }

      20 = TEXT

      20 {

        value = tt_news_cat.title

        lang {

          de = tt_news_cat.title_de

        }

        wrap = |,

      }

    }

  }

}

n.showUid

string

You can set the name for the piVar[showUid]. It is helpfull, if you are use more than one plugin with different databases like 'tt_news' and 'fe_users' for example - and if your are using realUrl.

In the case below the record id of the first list view will get the parameter tx_browser_pi1[showUid]=X - this is the default, now alias for the showUid isn't configured.

The record id of the second list view will get the parameter tx_browser_pi1[feuserUid]=X

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    ...

  }

  2 {

    showUid = feusersUid

  }

}

n.select.deal_as_table

array

If you are using the SQL manual mode with aliases, you have to help the Browser to allocate the proper table for operations. There is the array deal_as_table for this case.

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    select  = or.uid AS `or.uid`, \              CONCAT(or.or_code, ' ', or.or_name) \              AS `or.or_name`

    select {

      deal_as_table {

        0 {

          statement = CONCAT(or.or_code, ' ', \                      or.or_name) AS `or.or_name`

          alias     = or.or_name

        }

      }

    }

  }

}

n.groupBy

string,

stdWrap

If you like to display your data grouped, please use groupBy.

The groupBy won't be a part of the SQL query but will be processed by PHP.

Example for stdWrap see n.select above

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    groupBy = tt_news_cat.title

  }

}

This property is incomplete! If you are using groupBy the A-Z-Browser and the page browser can't count the records propper.

n.groupBy.dontConsolidate

boolean

If you are group data by a field of a foreign table and you are displaying more than one field from the foreign table, it is possible, that you won't get a proper result. Try dontConsolidate in this case.

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    groupBy {

      dontConsolidate = 1

    }

  }

}

0

n.where

string,

stdWrap

DANGEROUS! You can write your own where clause.

Be aware in case of an own configuration, that you have to configure enable fields like hidden, deleted, starttime and endtime by yourself.

Filter doesn't work in case of own where clause.

Example for stdWrap see n.select above

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    where = tx_ships_special.uid = 35

  }

}

n.andWhere

string,

stdWrap

You can add any condition to the where clause.

If you need a table field in your clause, you have to allocate the table name separated by commas to the value "tables".

The allocated table names have to be a part of your defined relations.

Example for stdWrap see n.select above

Debugging:

See "Debugging SQL statements" on page 20.

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    andWhere = tx_ships_special.uid = 35

  }

}

n.orderBy

string,

stdWrap

You can sort every view in your own way, if you need it.

orderBy won't be a part of the SQL query but will be processed by PHP multisort since Browser 3.1.0

Example for stdWrap see n.select above

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    orderBy = tt_news.datetime desc, \              tt_news_cat.title

  }

}

Values from the select property

n.orderBy.foreignTable

string

You can order children records (foreign tables) by a SQL query.

The code will be send as a real SQL query in contrast to the property orderBy above!

Foreign table has to be the name of the foreign table like in the example below. It will be used for the table.field marker.

In the example below the browser will handle the result of the sql query in this way:

You will need the marker ###UID_LOCAL###. The marker will be replaced by the uid of the current local table.

Browser  Tutorial Database (en):

http://typo3.org/documentation/document-library/extension-manuals/browser_tut_search_en/current/

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    orderBy {

      tx_org_department (

SELECT tx_org_department.uid AS 'uid',

       tx_org_department.title AS 'title'

FROM   tx_org_department,

       tx_org_headquarters_mm_tx_org_department

WHERE  tx_org_headquarters_mm_tx_org_department.\       uid_local    = ###UID_LOCAL###

  AND  tx_org_headquarters_mm_tx_org_department.\       uid_foreign = tx_org_department.uid

ORDER BY       tx_org_headquarters_mm_tx_org_department.\       sorting

)

    }

  }

}

n.random

boolean

Generate records by a random order.

Be aware!

No cache

Please use the plugin "Browser (no cache)"

The whole page will not be cached!

Tutorial

Browser Tutorial Several Plugins (en)

Section: No Cache

http://typo3.org/extensions/repository/view/browser_tut_severalplugins_en/current/

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    random = 1

  }

}

n.override

array

You can override the parts select, from, where, andWhere and orderBy of any SQL query. Every part is optional.

The override option makes sense, if you aren't satisfied with the query statements processed by the browser.

Every item has the stdWrap property. Example for stdWrap see n.select above.

andWhere has only an effect, if you don't use where!

Example:

plugin.tx_browser_pi1.views.list {

  1.override {

    select   = tt_news.title AS 'tt_news.title', \               tt_news_cat.title AS \               'tt_news_cat.title'

    from     = ...

    where    = ...

    andWhere = ...

    orderBy  = ...

  }

}

n.limit

string

Limit the result

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    limit = 0,3

  }

}

n.search

string

You can search in more fields than displayed.

Tutorial

Tutorial Search

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    search = tt_news.title, tt_news.bodytext, \             tt_news.short, tt_news_cat.title

  }

}

Values from the select property

n.handleAs

array

You can handle fields in a special way.

Tutorial:

Tutorial Database

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    handleAs {

      image          = tx_ships_main.images

      imageCaption   = tx_ships_main.caption

      imageAltText   = tx_ships_main.caption

      imageTitleText = tx_ships_main.caption

      document       = tx_ships_main.documents

   }

  }

}

n.csvLinkToSingleView

string

By default every item in the list links to the single view. If you don't want that, use csvLinkToSingleView (comma separated values).

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    csvLinkToSingleView = tt_news.title

  }

}

n.document_stdWrap

array

Copy the default configuration from document_stdWrap and change it.

Wrapping of documents.

See property document_stdWrap in the table "Local" on page 24.

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    document_stdWrap < \      plugin.tx_browser_pi1.document_stdWrap

    document_stdWrap.stdWrap {

      noTrimWrap >

      wrap = <br />

    }

  }

}

See table Local

n.displayList

array

Copy the default configuration from displayList and change it.

Wrapping of images and configuration of displaying markers.

See property displayList in the table "Local" on page 27.

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    displayList < \      plugin.tx_browser_pi1.displayList    displayList {

      ...

    }

  }

}

See table Local

n.displayList.display

array

If you don't want the item, set the value to 0.

Example:

plugin.tx_browser_pi1.views.list.1.displayList {

  display {

    table {

      summary     = 1

      caption     = 1

    }

    jssAlert      = 1

  }

}

Like the example

n.table.field

stdWrap

Every table field has the stdWrap property.

Tutorial:

Tutorial Basics

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    tt_news.title {

      crop = 10 | ... | 1

    }

  }

}

n.marker

array,stdWrap

Every view has the marker property.

Tutorial:

Tutorial Basics

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    marker {

      my_marker {

        value   = My Marker

        lang.de = Mein Marker

    }

  }

}

n

array

See table views.list

n.template

array

See property template in the table "Local" on page 23.

Tutorial:

Tutorial Basics

Example:

plugin.tx_browser_pi1.views.single {

  1 {

    template < plugin.tx_browser_pi1.template

  }

}

See table Local

n.relations.type

array

See table views.list

n.record

array

See table views.list

n.select

string

See table views.list

n.andWhere

array

See table views.list

n.orderBy

string

See table views.list amongst others

orderBy is different from the SQL orderBy statement. There are several causes. On important cause is, that you can't order records from the local table (main table) and foreign tables (children tables) within one SQL query.

Since version 3.4.3 it is possible to order children records too. See the example below:

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    select  = ...

    orderBy (      tx_organiser_cal_mm_calentrance.sorting,      tx_organiser_calentrance.title    )

  }

}

Comment:

There is this relation in the example above (you can't see it):

tx_organiser_cal -> tx_organiser_cal_mm_calentrance \  -> tx_organiser_calentrance

It is like:

event -> mm table -> entrance fees

The orderBy clause from above will have the effect, that the titles of the entrance fees (values like: "students 10 EUR, adults 16 EUR, ..." will first ordered by the values of the field sorting in the mm table and second will be ordered by the title.

The browser detects a context between mm tables and foreign tables!

The orderBy clause from above will have any effect to all other children tables.

Values from the select property

n.orderBy.foreignTable

string

You can order children records (foreign tables) by a SQL query.

The code will be send as a real SQL query in contrast to the property orderBy above!

Please refere to views.list above

n.search

string

See table views.list

Values from the select property

n.handleAs

array

You can handle fields in a special way.

Tutorial:

Tutorial Basics

Tutorial Images

Example:

plugin.tx_browser_pi1.views.single {

  1 {

    handleAs {

      title          = tx_ships_main.title

      image          = tx_ships_main.images

      imageCaption   = tx_ships_main.caption

      imageAltText   = tx_ships_main.caption

      imageTitleText = tx_ships_main.caption

      text           = tx_ships_main.history

      document       = tx_ships_main.documents

   }

  }

}

n.document_stdWrap

array

See table views.list

See table Local

n.displaySingle

array

Copy the default configuration from displaySingle and change it.

Wrapping of images and configuration of displaying markers.

See property displaySingle in the table "Local" on page 25.

Example:

plugin.tx_browser_pi1.views.single {

  1 {

    displaySingle < \      plugin.tx_browser_pi1.displaySingle    displaySingle {

      ...

    }

  }

}

See table Local

n.table.field

stdWrap

See table views.list

n.marker

array,stdWrap

Every view has the marker property.

Tutorial:

See "Self-defined Markers".

Example:

plugin.tx_browser_pi1.views.list {

  1 {

    marker {

      my_marker {

        value   = My Marker

        lang.de = Mein Marker

    }

  }

}

Deprecated!

Example:

plugin.tx_browser_pi1.views.single.1 {

  ttContainer  = TT_CONTAINER

  ttContainer {

    ...

    20 = TTC_COA

    20 {

    }

  }

}

Deprecated!

Example:

plugin.tx_browser_pi1.views.single.1 {

  ttContainer  = TT_CONTAINER

  ttContainer {

    ...

    10 = TTC_STDWRAP

    10 {

      ...

    }

  }

}