raspisms/models/StandardModel.php

198 lines
5.4 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 models;
/**
* Abstract class reprensenting the Standard Model
2020-01-17 18:19:25 +01:00
* This class implement/define most common methods for models.
*/
abstract class StandardModel extends \descartes\Model
{
/**
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->_select($this->get_table_name());
}
/**
2020-01-17 18:19:25 +01:00
* Return an entry by his id.
*
* @param int $id : entry id
2020-01-17 18:19:25 +01:00
*
* @return array
*/
2019-11-13 20:23:12 +01:00
public function get(int $id)
{
return $this->_select_one($this->get_table_name(), ['id' => $id]);
}
2020-01-17 18:19:25 +01:00
2019-11-13 20:23:12 +01:00
/**
2020-01-17 18:19:25 +01:00
* Return an entry by his id for a user.
*
2019-11-13 20:23:12 +01:00
* @param int $id_user : user id
2020-01-17 18:19:25 +01:00
* @param int $id : entry id
*
2019-11-13 20:23:12 +01:00
* @return array
*/
public function get_for_user(int $id_user, int $id)
{
return $this->_select_one($this->get_table_name(), ['id' => $id, 'id_user' => $id_user]);
}
2020-01-17 18:19:25 +01:00
2019-11-14 21:44:31 +01:00
/**
2020-01-17 18:19:25 +01:00
* Return all entries for a user.
*
2019-11-14 21:44:31 +01:00
* @param int $id_user : user id
2020-01-17 18:19:25 +01:00
*
2019-11-14 21:44:31 +01:00
* @return array
*/
public function gets_for_user(int $id_user)
{
return $this->_select($this->get_table_name(), ['id_user' => $id_user]);
}
/**
2020-01-17 18:19:25 +01:00
* Return a list of entries for a user.
*
* @param int $id_user : user id
* @param int $limit : Number of entry to return
* @param int $offset : Number of entry to ignore
*
* @return array
*/
2020-01-17 18:19:25 +01:00
public function list_for_user(int $id_user, $limit, $offset)
{
return $this->_select($this->get_table_name(), ['id_user' => $id_user], null, false, $limit, $offset);
}
/**
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
*/
public function gets_in_for_user(int $id_user, $ids)
{
if (!$ids)
{
return [];
}
2020-01-17 18:19:25 +01:00
$query = '
SELECT * FROM `' . $this->get_table_name() . '`
WHERE id_user = :id_user
AND id ';
$params = [];
$generated_in = $this->_generate_in_from_array($ids);
$query .= $generated_in['QUERY'];
$params = $generated_in['PARAMS'];
//On génère la clause IN et les paramètres adaptés depuis le tableau des id
$params['id_user'] = $id_user;
return $this->_run_query($query, $params);
}
/**
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
*/
2019-11-14 22:33:00 +01:00
public function delete_for_user(int $id_user, int $id)
{
return $this->_delete($this->get_table_name(), ['id_user' => $id_user, 'id' => $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
*/
public function delete(int $id)
{
return $this->_delete($this->get_table_name(), ['id' => $id]);
}
/**
2020-01-17 18:19:25 +01:00
* Insert a entry.
*
* @param array $entry : Entry to insert
2020-01-17 18:19:25 +01:00
*
* @return mixed bool|int : false on error, new entry id else
*/
public function insert($entry)
{
$result = $this->_insert($this->get_table_name(), $entry);
2020-01-17 18:19:25 +01:00
return $result ? $this->_last_id() : false;
}
/**
2020-01-17 18:19:25 +01:00
* Update a entry for a user.
*
* @param int $id_user : User id
* @param int $id : Entry id
2020-01-17 18:19:25 +01:00
* @param array $datas : datas to update
*
* @return int : number of modified rows
*/
2019-11-14 22:33:00 +01:00
public function update_for_user(int $id_user, int $id, array $entry)
{
return $this->_update($this->get_table_name(), $entry, ['id_user' => $id_user, 'id' => $id]);
}
2020-01-17 18:19:25 +01:00
/**
2020-01-17 18:19:25 +01:00
* Update a entry by his id.
*
* @param int $id : Entry id
* @param array $datas : datas to update
*
* @return int : number of modified rows
*/
public function update(int $id, array $entry)
{
return $this->_update($this->get_table_name(), $entry, ['id' => $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->_count($this->get_table_name(), ['id_user' => $id_user]);
}
2020-01-17 18:19:25 +01:00
/**
* Return table name.
*
* @return string
*/
abstract protected function get_table_name(): string;
}