raspisms/controllers/internals/StandardController.php

139 lines
3.6 KiB
PHP
Raw Normal View History

<?php
/*
* This file is part of RaspiSMS.
*
* (c) Pierre-Lin Bonnemaison <plebwebsas@gmail.com>
*
* This source file is subject to the GPL-3.0 license that is bundled
* with this source code in the file LICENSE.
*/
namespace controllers\internals;
abstract class StandardController extends \descartes\InternalController
{
public function __construct(\PDO $bdd)
{
$this->bdd = $bdd;
}
/**
2020-01-17 18:19:25 +01:00
* Return all the entries.
*
* @return array
*/
2020-01-17 18:19:25 +01:00
public function get_all()
{
return $this->get_model()->get_all();
}
/**
2020-01-17 18:19:25 +01:00
* Return a entry by his id.
*
* @param int $id : Entry id
2020-01-17 18:19:25 +01:00
*
* @return array
*/
2020-01-17 18:19:25 +01:00
public function get(int $id)
{
return $this->get_model()->get($id);
}
2020-01-17 18:19:25 +01:00
/**
2020-01-17 18:19:25 +01:00
* Return a entry by his id and a user.
*
* @param int $id_user : Entry id
2020-01-17 18:19:25 +01:00
* @param int $id : Entry id
*
* @return array
*/
2020-01-17 18:19:25 +01:00
public function get_for_user(int $id_user, int $id)
{
return $this->get_model()->get_for_user($id_user, $id);
}
2020-01-17 18:19:25 +01:00
/**
2020-01-17 18:19:25 +01:00
* Return all entries for a user.
*
* @param int $id_user : Entry id
2020-01-17 18:19:25 +01:00
*
* @return array
*/
2020-01-17 18:19:25 +01:00
public function gets_for_user(int $id_user)
{
return $this->get_model()->gets_for_user($id_user);
}
/**
2020-01-17 18:19:25 +01:00
* Return the list of entries for a user.
*
* @param int $id_user : User id
* @param ?int $nb_entry : Number of entry to return
* @param ?int $page : Pagination, used to calcul offset, $nb_entry * $page
2020-01-17 18:19:25 +01:00
*
* @return array : Entrys list
*/
2020-01-17 18:19:25 +01:00
public function list_for_user(int $id_user, ?int $nb_entry = null, ?int $page = null)
{
return $this->get_model()->list_for_user($id_user, $nb_entry, $nb_entry * $page);
}
/**
2020-01-17 18:19:25 +01:00
* Return a list of entries in a group of ids and for a user.
*
* @param int $id_user : user id
* @param array $ids : ids of entries to find
*
* @return array
*/
2020-01-17 18:19:25 +01:00
public function gets_in_for_user(int $id_user, array $ids)
{
return $this->get_model()->gets_in_for_user($id_user, $ids);
}
/**
2020-01-17 18:19:25 +01:00
* Delete a entry by his id for a user.
*
* @param int $id_user : User id
2020-01-17 18:19:25 +01:00
* @param int $id : Entry id
*
* @return int : Number of removed rows
*/
public function delete_for_user(int $id_user, int $id)
{
return $this->get_model()->delete_for_user($id_user, $id);
}
2020-01-17 18:19:25 +01:00
/**
2020-01-17 18:19:25 +01:00
* Delete a entry by his id.
*
* @param int $id : Entry id
2020-01-17 18:19:25 +01:00
*
* @return int : Number of removed rows
*/
2020-01-17 18:19:25 +01:00
public function delete(int $id)
{
return $this->get_model()->delete($id);
}
/**
2020-01-17 18:19:25 +01:00
* Count number of entry for a user.
*
* @param int $id_user : User id
2020-01-17 18:19:25 +01:00
*
* @return int : number of entries
*/
public function count_for_user(int $id_user)
{
return $this->get_model()->count_for_user($id_user);
}
2020-01-17 18:19:25 +01:00
/**
* Get the model for the Controller.
*
* @return \descartes\Model
*/
abstract protected function get_model(): \descartes\Model;
}