Do you need a page browser for your TYPO3 extension?: Dmitry Dulepov

Do you need a page browser for your TYPO3 extension?

Posted on 19.09.08 17:32

I have one for you! Yesterday I uploaded the first version of the "Universal page browser" extension into TER. This extension provides page browsing services to other extensions.

Currently extensions either use their own home made page browser or use default from tslib_pibase. Neither of these solutions is good. Home made page browsers requires time to create and also to maintain. It takes space in the code. The default one is hard to configure, it is not flexible for any modern application. In addition it is table–based, which is not how HTML code should be made these days.

Recently I had to write my own page browser three times in three different extensions and twice used the default one. All these times it was loss of time. If I had a "normal" page browser, I could save on development and debugging.

Armed with this idea I decided to make a page browser that I could use in any other project. I started developing it and then there came one of Netcreators projects, where I could finish this development.

As a result I made a new extension that any other extension case use to integrate a modern highly customizable CSS-based page browser. It is very easy to use. Here is the code:

protected function getListGetPageBrowser($numberOfPages) {
    // Get default configuration
    $conf = $GLOBALS['TSFE']->tmpl->setup['plugin.']['tx_pagebrowse_pi1.'];
    // Modify this configuration
    $conf += array(
        'pageParameterName' => $this->prefixId . '|page',
        'numberOfPages' => intval($numberOfPages/$this->conf['pageSize']) +
            (($numberOfPages % $this->conf['pageSize']) == 0 ? 0 : 1),
    );
    // Get page browser
    $cObj = t3lib_div::makeInstance('tslib_cObj');
    /* @var $cObj tslib_cObj */
    $cObj->start(array(), '');
    return $cObj->cObjGetSingle('USER', $conf);
}

It is 7 lines (without comments) to get a fully functional page browser for your extension. It provides a tx_yourextkey_pi1[whatevervar] to your extension, takes care about caches, etc. Here is a feature list:

Custom templates are possible
Default CSS–based template available
Customizable number of pages before current and after
The following links can be generated (or switched off):
- First page
- Previous page
- Next page
- Last page
There can be indicators that there are more or less pages available that numeric links show (can be switched off)
Extensions can add extra query parameters to the generated page link. These parameters can be generated automatically from TS template using stdWrap
Current query string is automatically appended to the page link
cHash is properly generated
First page does not have a page parameter, which prevents double content issue (SEO–related)
Full detailed manual with all options explained

I am already using this extension privately and I plan to migrate comments extension to use this page browser. So if you need a page browser in your extension, give pagebrowse a try. I am sure you will like it.

Comments

Stefan, 22-09-08 09:43:

Great!

I will definitly test it soon!

Thanks in advance,

Stefan.

Georg, 22-09-08 11:22:

Hi!

Thanks for this ext! I will give it a try with my new extensions like chgallery

Andreas Wagner, 09-10-08 01:26:

Thanks for this great extension! I really hope this will be integrated in the core somehow for 4.3.

One question: is there a way to get rid of the cHash parameter when you call the extension as USER_INT?

(By the way, you have some unfilled markers below the archive list to the right: \"###ARCHIVE_EMPTY_MSG### | ###COUNT###\"

alex, 17-10-08 17:00:

hi, sorry, cause i\'m not so good in Typo3 but i try to write my first extension..! - I don\'t know, where can i use this extension in my extension. Can i do write this code in my class.tx_mykey_pi1.php or where?

I can\'t find some spezial help for my problem.. - Sorry that i ask here.

best regards and thx for the book (i\'m waiting for the german version)

alex

Dmitry Dulepov, 21-10-08 06:51:

alex, read the manual. It is all described there.

Fedir, 22-10-08 22:57:

If there are any example on the Web ?

Jan Matthiesen, 05-12-08 12:28:

Hi Dmitry,

I\'m using your great pagebrowse extension and found a little bug in the postInit hook. You check the postInit hook is an array in line: 116 but iterate through the preInit hook in the next line.

Best regards
Jan Matthiesen

CT, 26-02-09 03:58:

Dmitry Dulepov: Hardest working man in TYPO3

romac, 30-06-09 14:45:

Thanks for this great extension!

I just found a typo in the documentation:
http://typo3.org/documentation/document-library/extension-manuals/pagebrowse/1.0.1/view/1/5/

"pageParamName" should be "pageParameterName" as seen above.

Thanks again for your hard work to improve TYPO3!

Ries, 14-07-09 05:24:

Dmitry, you create two hooks, preInit and postInit. However these variables:

protected $numberOfPages;
protected $pageParameterName;
protected $currentPage;
protected $pagesBefore = 3;
protected $pagesAfter = 3;

are all protected, so the hooks postInit and preInit are pretty much useless now.

is there an API planned for the variables??

In my case I need to 'inject' the page number to a different page then pagebrowse things is correct.

Ries

Steffen Müller, 13-10-09 00:37:

How to use the pagebrowser in your extension:

function main(...) {

// Number of list items per page

$itemsPerPage = 16

// example array of list items

$items = array('all', 'my', '1001', '...', 'items');

// split array into chunks

$items = array_chunk($items, $itemsPerPage);

// How much pages do we need

$numberOfPages = count($data);

// render the specific part of the list

$content = t3lib_div::view_array($items[intval($this->piVars['page'])]);

// Add page browser

$content .= $this->getListGetPageBrowser($numberOfPages);

return $content;

}

chris, 11-11-09 16:25:

hi and thx for your work on typo3 Dmitry ...

i have followed the instructions in the manual and have set up everything as described/needed (i'm using templavoila) but when i try to "Either set a page to the doktype “Pagebrowser” or set the field “Contains plugin” in the page properties to “Pagebrowser”." i have no Pagebrowser options in these two popups.

using t3 4.2.9

Hans, 10-01-10 13:01:

I have installed Version 1.0.1 and am running TYPO3 4.3.0. I get no output for the pagebrowser when calling getListGetPageBrowser() ... only


<div class="tx-pagebrowse-pi1">

</div>



what am i doing wrong?

Pascal, 04-02-10 20:49:

Thanks Dmitry, works like a charm when included in my extension.
Submitted a report in forge for an error in the plugin.

simon, 09-03-10 15:52:

hi dmitry,

i have installed t3blog 0.8.1. and pagebrowse 1.1.0
How can I changed the language into german? Following code in the setup does´nt work:

plugin.tx_t3blog_pi1._LOCAL_LANG.de.{
pi_list_browseresults_prev = <Zurück
pi_list_browseresults_page = Seite
pi_list_browseresults_next = Nächste >
pi_list_browseresults_first = << Erste
pi_list_browseresults_last = Letzte >>
}

thank you for help
simon

Alexander, 15-04-10 18:44:

Hi Simon,

goto Extension Manager -> Translation handling. Select "German" and press "Update from Repository".

Now the language files will be updated and your pagebrowser should be in German.

I've just done it right now.

Alexander

TheCount, 02-05-10 20:08:

Hi Alex,

thx a lot. That was what I was looking for too.

Stas Kobzar, 15-05-10 00:27:

Hi Dmitry,

Very useful plugin and works perfect for me. I used it in my extension, and it is amazing that it take now couple lines for ready to use page browser.

Thank you,
Stas

Daniel, 26-07-10 18:37:

@Hans - don't forget to include the extensions TypoScript in your root template (section „Include basis template“).

ToDo-List:

1. Include »pagebrowse« basis TypoScript in your root-template
2. Add a marker ###PAGEBROWSER### to your own extension template file (HTML template)
3. Add the example method provided by
Do this, then include the example method provided by Dmitry (i changed some lines, since i got an error -> displayErrors in your TYPO3 Installation)
4. Call the method and fill a marker with the returned value (see example in comment made by Steffen Müller)

Jens, 28-07-10 15:54:

Hi,
i followed the instructions from Daniel

the method said in Point 3 is this right?

protected function getListGetPageBrowser($numberOfPages) {
// Get default configuration
$conf = $GLOBALS['TSFE']->tmpl->setup['plugin.']['tx_pagebrowse_pi1.'];
// Modify this configuration
$conf += array(
'pageParameterName' => $this->prefixId . '|page',
'numberOfPages' => intval($numberOfPages/$this->conf['pageSize']) +
(($numberOfPages % $this->conf['pageSize']) == 0 ? 0 : 1),
);
// Get page browser
$cObj = t3lib_div::makeInstance('tslib_cObj');
/* @var $cObj tslib_cObj */
$cObj->start(array(), '');
return $cObj->cObjGetSingle('USER', $conf);
}

What does he mean after that with the sample method by Dmitry?

In the Example made by Steffen, i don't understand what he mean by:

$numberOfPages = count($data); --> What is $data?

Steffen uses this as items:
$items = array('all', 'my', '1001', '...', 'items');

i have already a multidimensional array of items. How can i take them as items?

Thx.

Jens, 30-07-10 14:31:

Okay i solved this problem by myself.
Thx anyway.

kobjan, 01-09-10 11:25:

really nice page browser. i never liked the default one, shipped with typo3. but there is a version conflict in 4.4.2 since your extension is only available up to 4.3.99. a little update would be nice

Add a comment

All fields in this form are required!

Do you need a page browser for your TYPO3 extension?

Related articles:

Comments

Add a comment

Categories

Pages

Top posts