UrlFriendlyListHelper

2015-11-04 -> 2021-03-25

Utility to handle pagination, sort and search in your html lists.

UrlFriendlyListHelper is part of the universe framework.

Install

Using the planet installer via light-cli

lt install Ling.UrlFriendlyListHelper

Using the uni command.

uni import Ling/UrlFriendlyListHelper

Features

handling of multiple lists on the same page
seo friendly: parameters are passed via the url
extensible: you can create your own plugins
takes in account your application's routing logic

How to use?

Simplest example possible (and also almost useless)

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8"/>
    <!--<script src="http://localcdn/ajax/libs/jquery/1.10.2/jquery.min.js"></script>-->
    <script src="http://code.jquery.com/jquery-2.1.4.min.js"></script>
    <title>Html page</title>
</head>
<body>
<?php


use Ling\UrlFriendlyListHelper\Displayer\PuppyBaseDisplayer;
use Ling\UrlFriendlyListHelper\ItemGenerator\ArrayItemGenerator;
use Ling\UrlFriendlyListHelper\ListHelper\AuthorListHelper;
use Ling\UrlFriendlyListHelper\Router\AuthorListRouter;

require_once "bigbang.php";


$rows = [
    [
        'name' => 'peter',
        'age' => '37',
        'bank_account' => '37',
    ],
    [
        'name' => 'alice',
        'age' => '32',
        'bank_account' => '3500',
    ],
    [
        'name' => 'chloe',
        'age' => '34',
        'bank_account' => '135000000',
    ],
    [
        'name' => 'nathalie',
        'age' => '47',
        'bank_account' => '5000000',
    ],
    [
        'name' => 'gilberte',
        'age' => '78',
        'bank_account' => '20000',
    ],
    [
        'name' => 'laetitia',
        'age' => '48',
        'bank_account' => '640000',
    ],
    [
        'name' => 'hanter',
        'age' => '13',
        'bank_account' => '140',
    ],
    [
        'name' => 'esmeralda',
        'age' => '26',
        'bank_account' => '1000000000000000000',
    ],
    [
        'name' => 'jasmine',
        'age' => '27',
        'bank_account' => '100000000000000000000',
    ],
    [
        'name' => 'elisabeth',
        'age' => '20',
        'bank_account' => '304520',
    ],
    [
        'name' => 'pizza',
        'age' => '50',
        'bank_account' => '75000',
    ],
    [
        'name' => 'adeline',
        'age' => '32',
        'bank_account' => '65000078',
    ],
    [
        'name' => 'aeoliryu',
        'age' => '98',
        'bank_account' => '75085052664',
    ],
    [
        'name' => 'agathe',
        'age' => '7',
        'bank_account' => '980',
    ],
];
$itemGenerator = ArrayItemGenerator::create()->setRows($rows);


// ROUTER
//------------------------------------------------------------------------------/
$router = AuthorListRouter::create()
    ->setListParametersExtractor(function () {
        $listParams = $_GET;
        return $listParams;
    })
    ->setUrlGenerator(function (array $listParams) {
        $curParams = array_replace($_GET, $listParams);
        $uri = explode('?', $_SERVER['REQUEST_URI'])[0];
        return $uri . '?' . http_build_query($curParams);
    })
    ->start();



// HELPER LIST 
//------------------------------------------------------------------------------/
$listHelper = AuthorListHelper::create()
    ->setItemGenerator($itemGenerator)
    ->setRouter($router);
    
$listHelper->start();




// ITEM GENERATION
//------------------------------------------------------------------------------/
$listRows = $itemGenerator->getItems();
echo PuppyBaseDisplayer::create()->renderHtml($listRows);


?>
</body>
</html>

Using the pagination plugin

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8"/>
    <!--<script src="http://localcdn/ajax/libs/jquery/1.10.2/jquery.min.js"></script>-->
    <script src="http://code.jquery.com/jquery-2.1.4.min.js"></script>
    <title>Html page</title>
</head>
<body>
<?php


use Ling\UrlFriendlyListHelper\Displayer\PuppyBaseDisplayer;
use Ling\UrlFriendlyListHelper\ItemGenerator\ArrayItemGenerator;
use Ling\UrlFriendlyListHelper\ItemGeneratorHelper\One\OnePaginationArrayItemGeneratorHelper;
use Ling\UrlFriendlyListHelper\ListHelper\AuthorListHelper;
use Ling\UrlFriendlyListHelper\Plugin\Pagination\MyHtmlPaginationPlugin;
use Ling\UrlFriendlyListHelper\Router\AuthorListRouter;

require_once "bigbang.php";


$rows = [
    [
        'name' => 'peter',
        'age' => '37',
        'bank_account' => '37',
    ],
    [
        'name' => 'alice',
        'age' => '32',
        'bank_account' => '3500',
    ],
    [
        'name' => 'chloe',
        'age' => '34',
        'bank_account' => '135000000',
    ],
    [
        'name' => 'nathalie',
        'age' => '47',
        'bank_account' => '5000000',
    ],
    [
        'name' => 'gilberte',
        'age' => '78',
        'bank_account' => '20000',
    ],
    [
        'name' => 'laetitia',
        'age' => '48',
        'bank_account' => '640000',
    ],
    [
        'name' => 'hanter',
        'age' => '13',
        'bank_account' => '140',
    ],
    [
        'name' => 'esmeralda',
        'age' => '26',
        'bank_account' => '1000000000000000000',
    ],
    [
        'name' => 'jasmine',
        'age' => '27',
        'bank_account' => '100000000000000000000',
    ],
    [
        'name' => 'elisabeth',
        'age' => '20',
        'bank_account' => '304520',
    ],
    [
        'name' => 'pizza',
        'age' => '50',
        'bank_account' => '75000',
    ],
    [
        'name' => 'adeline',
        'age' => '32',
        'bank_account' => '65000078',
    ],
    [
        'name' => 'aeoliryu',
        'age' => '98',
        'bank_account' => '75085052664',
    ],
    [
        'name' => 'agathe',
        'age' => '7',
        'bank_account' => '980',
    ],
];
$itemGenerator = ArrayItemGenerator::create()->setRows($rows);
?>
<style>
    .active {
        font-size: 20px;
    }
</style>
<?php


$nbItemsPerPage = 3;
$pagination = MyHtmlPaginationPlugin::create()
    ->setNbItemsPerPage($nbItemsPerPage)
    ->setGeneratorHelper(OnePaginationArrayItemGeneratorHelper::create());


// ROUTER
//------------------------------------------------------------------------------/
$router = AuthorListRouter::create()
    ->setListParametersExtractor(function () {
        $listParams = $_GET;
        return $listParams;
    })
    ->setUrlGenerator(function (array $listParams) {
        $curParams = array_replace($_GET, $listParams);
        $uri = explode('?', $_SERVER['REQUEST_URI'])[0];
        return $uri . '?' . http_build_query($curParams);
    })
    ->start();



// HELPER LIST 
//------------------------------------------------------------------------------/
$listHelper = AuthorListHelper::create()
    ->setItemGenerator($itemGenerator)
    ->setRouter($router)
    ->registerPlugin($pagination);
    
$listHelper->start();




// ITEM GENERATION
//------------------------------------------------------------------------------/
$listRows = $itemGenerator->getItems();
echo PuppyBaseDisplayer::create()->renderHtml($listRows);
echo $pagination->renderHtml();


?>
</body>
</html>

Multiple lists complete example

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8"/>
    <!--<script src="http://localcdn/ajax/libs/jquery/1.10.2/jquery.min.js"></script>-->
    <script src="http://code.jquery.com/jquery-2.1.4.min.js"></script>
    <title>Html page</title>
</head>
<body>
<?php


use Ling\UrlFriendlyListHelper\ItemGenerator\ArrayItemGenerator;
use Ling\UrlFriendlyListHelper\ItemGeneratorHelper\One\OnePaginationArrayItemGeneratorHelper;
use Ling\UrlFriendlyListHelper\ItemGeneratorHelper\One\OneSearchArrayItemGeneratorHelper;
use Ling\UrlFriendlyListHelper\ItemGeneratorHelper\One\OneSortArrayItemGeneratorHelper;
use Ling\UrlFriendlyListHelper\ListHelper\AuthorListHelper;
use Ling\UrlFriendlyListHelper\Plugin\Pagination\MyHtmlPaginationPlugin;
use Ling\UrlFriendlyListHelper\Plugin\Search\MySearchPlugin;
use Ling\UrlFriendlyListHelper\Plugin\Sort\MySortPlugin;
use Ling\UrlFriendlyListHelper\Displayer\PuppyBaseDisplayer;
use Ling\UrlFriendlyListHelper\Router\AuthorListRouter;

require_once "bigbang.php";


$rows = [
    [
        'name' => 'peter',
        'age' => '37',
        'bank_account' => '37',
    ],
    [
        'name' => 'alice',
        'age' => '32',
        'bank_account' => '3500',
    ],
    [
        'name' => 'chloe',
        'age' => '34',
        'bank_account' => '135000000',
    ],
    [
        'name' => 'nathalie',
        'age' => '47',
        'bank_account' => '5000000',
    ],
    [
        'name' => 'gilberte',
        'age' => '78',
        'bank_account' => '20000',
    ],
    [
        'name' => 'laetitia',
        'age' => '48',
        'bank_account' => '640000',
    ],
    [
        'name' => 'hanter',
        'age' => '13',
        'bank_account' => '140',
    ],
    [
        'name' => 'esmeralda',
        'age' => '26',
        'bank_account' => '1000000000000000000',
    ],
    [
        'name' => 'jasmine',
        'age' => '27',
        'bank_account' => '100000000000000000000',
    ],
    [
        'name' => 'elisabeth',
        'age' => '20',
        'bank_account' => '304520',
    ],
    [
        'name' => 'pizza',
        'age' => '50',
        'bank_account' => '75000',
    ],
    [
        'name' => 'adeline',
        'age' => '32',
        'bank_account' => '65000078',
    ],
    [
        'name' => 'aeoliryu',
        'age' => '98',
        'bank_account' => '75085052664',
    ],
    [
        'name' => 'agathe',
        'age' => '7',
        'bank_account' => '980',
    ],
];
$itemGenerator = ArrayItemGenerator::create()->setRows($rows);
$rows2 = $rows;
array_walk($rows2, function (&$v) {
    $v['name'] = strrev($v['name']);
});
$itemGenerator2 = ArrayItemGenerator::create()->setRows($rows2);

?>
<style>
    .active {
        font-size: 20px;
    }
</style>
<?php

/**
 * Application
 */
$nbItemsPerPage = 3;


// ROUTER
//------------------------------------------------------------------------------/
$router = AuthorListRouter::create()
    ->setListParametersExtractor(function () {
        $listParams = $_GET;
        return $listParams;
    })
    ->setUrlGenerator(function (array $listParams) {
        $curParams = array_replace($_GET, $listParams);
        $uri = explode('?', $_SERVER['REQUEST_URI'])[0];
        return $uri . '?' . http_build_query($curParams);
    })
    ->start();


// PLUGIN CONFIG
//------------------------------------------------------------------------------/
$pagination = MyHtmlPaginationPlugin::create()
    ->setNbItemsPerPage($nbItemsPerPage)
    ->setGeneratorHelper(OnePaginationArrayItemGeneratorHelper::create());
$sort = MySortPlugin::create()
    ->setSelectEntries([
        'name_asc' => ['name asc', 'name', 'asc'],
        'name_desc' => ['name desc', 'name', 'desc'],
        'age_asc' => ['age asc', 'age', 'asc'],
        'age_desc' => ['age desc', 'age', 'desc'],
        'bank_account_asc' => ['bank account asc', 'bank_account', 'asc'],
        'bank_account_desc' => ['bank account desc', 'bank_account', 'desc'],
    ])
    ->setGeneratorHelper(OneSortArrayItemGeneratorHelper::create())
    ->setDefaultSortId('name_asc');
$search = MySearchPlugin::create()->setGeneratorHelper(OneSearchArrayItemGeneratorHelper::create()->setSearchFields([
    'name',
]));

// HELPER LIST 
//------------------------------------------------------------------------------/
$listHelper = AuthorListHelper::create()
    ->setItemGenerator($itemGenerator)
    ->setRouter($router)
    ->registerPlugin($search)
    ->registerPlugin($sort)
    ->registerPlugin($pagination);
$listHelper->start();


// ITEM GENERATION
//------------------------------------------------------------------------------/
$listRows = $itemGenerator->getItems();


// RENDERING
//------------------------------------------------------------------------------/

/**
 * Template part, imagine that some html glues everything
 */
echo $search->renderHtml();
echo '<hr>';
echo $sort->renderHtml();
echo '<hr>';
echo PuppyBaseDisplayer::create()->renderHtml($listRows);


// use a plugin
echo $pagination->renderHtml();


?>

<hr>
<?php


//------------------------------------------------------------------------------/
// TESTING MULTIPLE LISTS ON THE SAME PAGE
//------------------------------------------------------------------------------/
$genHelper2 = OnePaginationArrayItemGeneratorHelper::create();
$pagination2 = MyHtmlPaginationPlugin::create()
    ->setNbItemsPerPage($nbItemsPerPage)
    ->setGeneratorHelper($genHelper2);
$sort2 = MySortPlugin::create()
    ->setSelectEntries([
        'name_asc' => ['name asc', 'name', 'asc'],
        'name_desc' => ['name desc', 'name', 'desc'],
        'age_asc' => ['age asc', 'age', 'asc'],
        'age_desc' => ['age desc', 'age', 'desc'],
        'bank_account_asc' => ['bank account asc', 'bank_account', 'asc'],
        'bank_account_desc' => ['bank account desc', 'bank_account', 'desc'],
    ])
    ->setGeneratorHelper(OneSortArrayItemGeneratorHelper::create())
    ->setDefaultSortId('name_asc');
$search2 = MySearchPlugin::create()->setGeneratorHelper(OneSearchArrayItemGeneratorHelper::create()->setSearchFields([
    'name',
]));

$listHelper2 = AuthorListHelper::create()
    ->setItemGenerator($itemGenerator2)
    ->setRouter($router)
    ->registerPlugin($search2)
    ->registerPlugin($sort2)
    ->registerPlugin($pagination2);
$listHelper2->start();
$listRows2 = $itemGenerator2->getItems();

echo $search2->renderHtml();
echo '<hr>';
echo $sort2->renderHtml();
echo '<hr>';
echo PuppyBaseDisplayer::create()->renderHtml($listRows2);
echo $pagination2->renderHtml();
?>

</body>
</html>

Multiple lists complete example using Mysql Pdo Items Generator

<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8"/>
    <!--<script src="http://localcdn/ajax/libs/jquery/1.10.2/jquery.min.js"></script>-->
    <script src="http://code.jquery.com/jquery-2.1.4.min.js"></script>
    <title>Html page</title>
</head>
<body>
<?php


use Ling\QuickPdo\QuickPdo;
use Ling\UrlFriendlyListHelper\Displayer\PuppyBaseDisplayer;
use Ling\UrlFriendlyListHelper\ItemGenerator\MysqlPdoItemGenerator;
use Ling\UrlFriendlyListHelper\ItemGeneratorHelper\One\OnePaginationArrayItemGeneratorHelper;
use Ling\UrlFriendlyListHelper\ItemGeneratorHelper\One\OnePaginationMysqlPdoItemGeneratorHelper;
use Ling\UrlFriendlyListHelper\ItemGeneratorHelper\One\OneSearchMysqlPdoItemGeneratorHelper;
use Ling\UrlFriendlyListHelper\ItemGeneratorHelper\One\OneSortMysqlPdoItemGeneratorHelper;
use Ling\UrlFriendlyListHelper\ListHelper\AuthorListHelper;
use Ling\UrlFriendlyListHelper\Plugin\Pagination\MyHtmlPaginationPlugin;
use Ling\UrlFriendlyListHelper\Plugin\Search\MySearchPlugin;
use Ling\UrlFriendlyListHelper\Plugin\Sort\MySortPlugin;
use Ling\UrlFriendlyListHelper\Router\AuthorListRouter;

require_once "bigbang.php";


QuickPdo::setConnection(
    'mysql:host=localhost;dbname=sketch',
    'root',
    'root',
    array(
        PDO::MYSQL_ATTR_INIT_COMMAND => "SET NAMES 'UTF8'",
        PDO::ATTR_ERRMODE => \PDO::ERRMODE_EXCEPTION,
    )
);


$itemGenerator = MysqlPdoItemGenerator::create()
    ->setCountRawQuery('select count(*) as count from sketch.ideas where active=1')
    ->setRawQuery('select * from sketch.ideas where active=1');
?>
<style>
    .active {
        font-size: 20px;
    }
</style>
<?php


$nbItemsPerPage = 3;
$pagination = MyHtmlPaginationPlugin::create()
    ->setNbItemsPerPage($nbItemsPerPage)
    ->setGeneratorHelper(OnePaginationMysqlPdoItemGeneratorHelper::create());

$sort = MySortPlugin::create()
    ->setSelectEntries([
        'name_asc' => ['name asc', 'the_name', 'asc'],
        'name_desc' => ['name desc', 'the_name', 'desc'],
        'active_asc' => ['active asc', 'active', 'asc'],
        'active_desc' => ['active desc', 'active', 'desc'],
    ])
    ->setGeneratorHelper(OneSortMysqlPdoItemGeneratorHelper::create())
    ->setDefaultSortId('name_asc');
$search = MySearchPlugin::create()->setGeneratorHelper(OneSearchMysqlPdoItemGeneratorHelper::create()->setSearchFields([
    'the_name',
    'description',
]));


// ROUTER
//------------------------------------------------------------------------------/
$router = AuthorListRouter::create()
    ->setListParametersExtractor(function () {
        $listParams = $_GET;
        return $listParams;
    })
    ->setUrlGenerator(function (array $listParams) {
        $curParams = array_replace($_GET, $listParams);
        $uri = explode('?', $_SERVER['REQUEST_URI'])[0];
        return $uri . '?' . http_build_query($curParams);
    })
    ->start();


// HELPER LIST 
//------------------------------------------------------------------------------/
$listHelper = AuthorListHelper::create()
    ->setItemGenerator($itemGenerator)
    ->setRouter($router)
    ->registerPlugin($search)
    ->registerPlugin($sort)
    ->registerPlugin($pagination)
;

$listHelper->start();


// ITEM GENERATION
//------------------------------------------------------------------------------/
$listRows = $itemGenerator->getItems();
echo $search->renderHtml();
echo '<hr>';
echo $sort->renderHtml();
echo '<hr>';
echo PuppyBaseDisplayer::create()->renderHtml($listRows);
echo $pagination->renderHtml();


//------------------------------------------------------------------------------/
// MULTIPLE LIST
//------------------------------------------------------------------------------/
$itemGenerator2 = MysqlPdoItemGenerator::create()
    ->setCountRawQuery('select count(*) as count from sketch.ideas')
    ->setRawQuery('select * from sketch.ideas');
$pagination2 = MyHtmlPaginationPlugin::create()
    ->setNbItemsPerPage($nbItemsPerPage)
    ->setGeneratorHelper(OnePaginationMysqlPdoItemGeneratorHelper::create());
$sort2 = MySortPlugin::create()
    ->setSelectEntries([
        'name_asc' => ['name asc', 'the_name', 'asc'],
        'name_desc' => ['name desc', 'the_name', 'desc'],
        'active_asc' => ['active asc', 'active', 'asc'],
        'active_desc' => ['active desc', 'active', 'desc'],
    ])
    ->setGeneratorHelper(OneSortMysqlPdoItemGeneratorHelper::create())
    ->setDefaultSortId('name_asc');
$search2 = MySearchPlugin::create()->setGeneratorHelper(OneSearchMysqlPdoItemGeneratorHelper::create()->setSearchFields([
    'the_name',
    'description',
]));
// HELPER LIST 
//------------------------------------------------------------------------------/
$listHelper2 = AuthorListHelper::create()
    ->setItemGenerator($itemGenerator2)
    ->setRouter($router)
    ->registerPlugin($search2)
    ->registerPlugin($sort2)
    ->registerPlugin($pagination2);

$listHelper2->start();


// ITEM GENERATION
//------------------------------------------------------------------------------/
$listRows = $itemGenerator2->getItems();
echo $search2->renderHtml();
echo '<hr>';
echo $sort2->renderHtml();
echo '<hr>';
echo PuppyBaseDisplayer::create()->renderHtml($listRows);
echo $pagination2->renderHtml();


?>
</body>
</html>

How does it work?

There are also my brainstorm notes that might help to understand the general guidelines.

Dependencies

lingtalfi/Bat 1.12
lingtalfi/JQuery 2.1.4
lingtalfi/QuickPdo 1.0.0: if you use MysqlPdoItemGenerator

History Log

1.1.5 -- 2021-05-31
- Removing trailing plus in lpi-deps file (to work with Light_PlanetInstaller:2.0.0 api
1.1.4 -- 2021-03-25
- fix typo in MysqlPdoItemGenerator
1.1.3 -- 2021-03-05
- update README.md, add install alternative
1.1.2 -- 2020-12-08
- Fix lpi-deps not using natsort.
1.1.1 -- 2020-12-04
- Add lpi-deps.byml file
1.1.0 -- 2015-11-05
- add Mysql Pdo Items Generator
- update MyHtmlPaginationPlugin
1.0.0 -- 2015-11-04
- initial commit

Name		Name	Last commit message	Last commit date
Latest commit History 15 Commits
Displayer		Displayer
ItemGenerator		ItemGenerator
ItemGeneratorHelper		ItemGeneratorHelper
ListHelper		ListHelper
Plugin		Plugin
Router		Router
Tool		Tool
doc		doc
.gitignore		.gitignore
README.md		README.md
dependencies.byml		dependencies.byml
lpi-deps.byml		lpi-deps.byml
meta-info.byml		meta-info.byml
robots.txt		robots.txt
sitemap.txt		sitemap.txt

lingtalfi/UrlFriendlyListHelper

Folders and files

Latest commit

History

Repository files navigation

UrlFriendlyListHelper

Install

Features

How to use?

Simplest example possible (and also almost useless)

Using the pagination plugin

Multiple lists complete example

Multiple lists complete example using Mysql Pdo Items Generator

How does it work?

Dependencies

History Log

About

Resources

Stars

Watchers

Forks

Languages