3 namespace Shaarli\Api\Controllers
;
5 use Shaarli\Api\ApiUtils
;
6 use Shaarli\Api\Exceptions\ApiBadParametersException
;
8 use Slim\Http\Response
;
13 * REST API Controller: all services related to links collection.
15 * @package Api\Controllers
16 * @see http://shaarli.github.io/api-documentation/#links-links-collection
18 class Links
extends ApiController
21 * @var int Number of links returned if no limit is provided.
23 public static $DEFAULT_LIMIT = 20;
26 * Retrieve a list of links, allowing different filters.
28 * @param Request $request Slim request.
29 * @param Response $response Slim response.
31 * @return Response response.
33 * @throws ApiBadParametersException Invalid parameters.
35 public function getLinks($request, $response)
37 $private = $request->getParam('private');
38 $links = $this->linkDb
->filterSearch(
40 'searchtags' => $request->getParam('searchtags', ''),
41 'searchterm' => $request->getParam('searchterm', ''),
44 // to updated in another PR depending on the API doc
45 ($private === 'true' || $private === '1') ? 'private' : 'all'
48 // Return links from the {offset}th link, starting from 0.
49 $offset = $request->getParam('offset');
50 if (! empty($offset) && ! ctype_digit($offset)) {
51 throw new ApiBadParametersException('Invalid offset');
53 $offset = ! empty($offset) ? intval($offset) : 0;
54 if ($offset > count($links)) {
55 return $response->withJson([], 200, $this->jsonStyle
);
58 // limit parameter is either a number of links or 'all' for everything.
59 $limit = $request->getParam('limit');
61 $limit = self
::$DEFAULT_LIMIT;
63 else if (ctype_digit($limit)) {
64 $limit = intval($limit);
65 } else if ($limit === 'all') {
66 $limit = count($links);
68 throw new ApiBadParametersException('Invalid limit');
71 // 'environment' is set by Slim and encapsulate $_SERVER.
72 $index = index_url($this->ci
['environment']);
76 foreach ($links as $link) {
77 if (count($out) >= $limit) {
80 if ($cpt++
>= $offset) {
81 $out[] = ApiUtils
::formatLink($link, $index);
85 return $response->withJson($out, 200, $this->jsonStyle
);