3 namespace Shaarli\Api\Controllers
;
5 use Shaarli\Api\ApiUtils
;
6 use Shaarli\Api\Exceptions\ApiBadParametersException
;
7 use Shaarli\Api\Exceptions\ApiLinkNotFoundException
;
9 use Slim\Http\Response
;
14 * REST API Controller: all services related to links collection.
16 * @package Api\Controllers
17 * @see http://shaarli.github.io/api-documentation/#links-links-collection
19 class Links
extends ApiController
22 * @var int Number of links returned if no limit is provided.
24 public static $DEFAULT_LIMIT = 20;
27 * Retrieve a list of links, allowing different filters.
29 * @param Request $request Slim request.
30 * @param Response $response Slim response.
32 * @return Response response.
34 * @throws ApiBadParametersException Invalid parameters.
36 public function getLinks($request, $response)
38 $private = $request->getParam('visibility');
39 $links = $this->linkDb
->filterSearch(
41 'searchtags' => $request->getParam('searchtags', ''),
42 'searchterm' => $request->getParam('searchterm', ''),
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;
62 } else if (ctype_digit($limit)) {
63 $limit = intval($limit);
64 } else if ($limit === 'all') {
65 $limit = count($links);
67 throw new ApiBadParametersException('Invalid limit');
70 // 'environment' is set by Slim and encapsulate $_SERVER.
71 $index = index_url($this->ci
['environment']);
75 foreach ($links as $link) {
76 if (count($out) >= $limit) {
79 if ($cpt++
>= $offset) {
80 $out[] = ApiUtils
::formatLink($link, $index);
84 return $response->withJson($out, 200, $this->jsonStyle
);
88 * Return a single formatted link by its ID.
90 * @param Request $request Slim request.
91 * @param Response $response Slim response.
92 * @param array $args Path parameters. including the ID.
94 * @return Response containing the link array.
96 * @throws ApiLinkNotFoundException generating a 404 error.
98 public function getLink($request, $response, $args)
100 if (! isset($this->linkDb
[$args['id']])) {
101 throw new ApiLinkNotFoundException();
103 $index = index_url($this->ci
['environment']);
104 $out = ApiUtils
::formatLink($this->linkDb
[$args['id']], $index);
105 return $response->withJson($out, 200, $this->jsonStyle
);