Mascali/raspisms
1
0
Fork 0
mirror of https://github.com/RaspbianFrance/raspisms.git synced 2025-06-06 14:46:27 +02:00
Code Issues Projects Releases Wiki Activity

Fix php style

Browse source
This commit is contained in:
osaajani 2020-01-17 18:19:25 +01:00
parent 461bd9c98d
commit b8bd067dc7
59 changed files with 2307 additions and 1868 deletions
Download patch file Download diff file Expand all files Collapse all files

10
models/Command.php
View file

@ -14,8 +14,12 @@ namespace models;
class Command extends StandardModel
{
/**
* Return table name
* @return string
* Return table name.
*
* @return string
*/
protected function get_table_name() : string { return 'command'; }
protected function get_table_name(): string
{
return 'command';
}
}

27
models/ConditionalGroup.php
View file

@ -14,20 +14,25 @@ namespace models;
class ConditionalGroup extends StandardModel
{
/**
* Return table name
* @return string
*/
protected function get_table_name() : string { return 'conditional_group'; }
/**
* Return a conditional group by his name for a user
* @param int $id_user : User id
* @param string $name : Group name
* Return a conditional group by his name for a user.
*
* @param int $id_user : User id
* @param string $name : Group name
*
* @return array
*/
public function get_by_name_for_user (int $id_user, string $name)
public function get_by_name_for_user(int $id_user, string $name)
{
return $this->_select_one($this->get_table_name(), ['id_user' => $id_user, 'name' => $name]);
}
/**
* Return table name.
*
* @return string
*/
protected function get_table_name(): string
{
return 'conditional_group';
}
}

38
models/Contact.php
View file

@ -14,32 +14,38 @@ namespace models;
class Contact extends StandardModel
{
/**
* Return table name
* @return string
*/
protected function get_table_name() : string { return 'contact'; }
/**
* Return a contact by his number for a user
* @param int $id_user : User id
* @param string $number : Contact number
* Return a contact by his number for a user.
*
* @param int $id_user : User id
* @param string $number : Contact number
*
* @return array
*/
public function get_by_number_and_user (int $id_user, string $number)
public function get_by_number_and_user(int $id_user, string $number)
{
return $this->_select_one($this->get_table_name(), ['id_user' => $id_user, 'number' => $number]);
}
/**
* Return a contact by his name for a user
* @param int $id_user : User id
* @param string $name : Contact name
* Return a contact by his name for a user.
*
* @param int $id_user : User id
* @param string $name : Contact name
*
* @return array
*/
public function get_by_name_and_user (int $id_user, string $name)
public function get_by_name_and_user(int $id_user, string $name)
{
return $this->_select($this->get_table_name(), ['id_user' => $id_user, 'name' => $name]);
}
/**
* Return table name.
*
* @return string
*/
protected function get_table_name(): string
{
return 'contact';
}
}

25
models/Event.php
View file

@ -14,20 +14,25 @@ namespace models;
class Event extends StandardModel
{
/**
* Return table name
* @return string
*/
protected function get_table_name() : string { return 'event'; }
/**
* Gets lasts x events for a user order by date
* @param int $id_user : User id
* Gets lasts x events for a user order by date.
*
* @param int $id_user : User id
* @param int $nb_entry : Number of events to return
*
* @return array
*/
public function get_lasts_by_date_for_user (int $id_user, int $nb_entry)
public function get_lasts_by_date_for_user(int $id_user, int $nb_entry)
{
return $this->_select('event', ['id_user' => $id_user], 'at', true, $nb_entry);
}
/**
* Return table name.
*
* @return string
*/
protected function get_table_name(): string
{
return 'event';
}
}

53
models/Group.php
View file

@ -14,54 +14,53 @@ namespace models;
class Group extends StandardModel
{
/**
* Return table name
* @return string
*/
protected function get_table_name() : string { return 'group'; }
/**
* Return a group by his name for a user
* @param int $id_user : User id
* @param string $name : Group name
* Return a group by his name for a user.
*
* @param int $id_user : User id
* @param string $name : Group name
*
* @return array
*/
public function get_by_name_for_user (int $id_user, string $name)
public function get_by_name_for_user(int $id_user, string $name)
{
return $this->_select_one($this->get_table_name(), ['id_user' => $id_user, 'name' => $name]);
}
/**
* Delete relations between group and contacts for a group
* Delete relations between group and contacts for a group.
*
* @param int $id_group : Group id
*
* @return int : Number of deleted rows
*/
public function delete_group_contact_relations (int $id_group)
public function delete_group_contact_relations(int $id_group)
{
return $this->_delete('group_contact', ['id_group' => $id_group]);
}
/**
* Insert a relation between a group and a contact
* @param int $id_group : Group id
* Insert a relation between a group and a contact.
*
* @param int $id_group : Group id
* @param int $id_contact : Contact id
*
* @return mixed (bool|int) : False on error, new row id else
*/
public function insert_group_contact_relation (int $id_group, int $id_contact)
public function insert_group_contact_relation(int $id_group, int $id_contact)
{
$success = (bool) $this->_insert('group_contact', ['id_group' => $id_group, 'id_contact' => $id_contact]);
return ($success ? $this->_last_id() : false);
return $success ? $this->_last_id() : false;
}
/**
* Get groups contacts
* Get groups contacts.
*
* @param int $id_group : Group id
*
* @return array : Contacts of the group
*/
public function get_contacts (int $id_group)
public function get_contacts(int $id_group)
{
$query = '
SELECT *
@ -73,4 +72,14 @@ namespace models;
return $this->_run_query($query, $params);
}
/**
* Return table name.
*
* @return string
*/
protected function get_table_name(): string
{
return 'group';
}
}

115
models/Media.php
View file

@ -17,22 +17,17 @@ namespace models;
class Media extends StandardModel
{
/**
* Return table name
* @return string
*/
protected function get_table_name() : string { return 'media'; }
/**
* Return an entry by his id for a user
* Return an entry by his id for a user.
*
* @param int $id_user : user id
* @param int $id : entry id
* @param int $id : entry id
*
* @return array
*/
public function get_for_user(int $id_user, int $id)
{
$query = '
SELECT * FROM `' . $this->get_table_name() . '`
SELECT * FROM `'.$this->get_table_name().'`
WHERE id_scheduled IN (SELECT id FROM scheduled WHERE id_user = :id_user)
AND id = :id
';
@ -43,19 +38,21 @@ namespace models;
];
$receiveds = $this->_run_query($query, $params);
return $receiveds[0] ?? [];
}
/**
* Return all entries for a user
* Return all entries for a user.
*
* @param int $id_user : user id
*
* @return array
*/
public function gets_for_user(int $id_user)
{
$query = '
SELECT * FROM `' . $this->get_table_name() . '`
SELECT * FROM `'.$this->get_table_name().'`
WHERE id_scheduled IN (SELECT id FROM scheduled WHERE id_user = :id_user)
';
@ -65,25 +62,26 @@ namespace models;
$receiveds = $this->_run_query($query, $params);
}
/**
* Return a media for a user and a scheduled
* @param int $id_user : user id
* Return a media for a user and a scheduled.
*
* @param int $id_user : user id
* @param int $id_scheduled : scheduled id
*
* @return array
*/
public function get_for_scheduled_and_user(int $id_user, int $id_scheduled)
{
$query = '
SELECT * FROM `' . $this->get_table_name() . '`
SELECT * FROM `'.$this->get_table_name().'`
WHERE id_scheduled IN (SELECT id FROM scheduled WHERE id_user = :id_user)
AND id_scheduled = :id_scheduled
';
$params = [
'id_user' => $id_user,
'id_scheduled' => $id_scheduled
'id_scheduled' => $id_scheduled,
];
$receiveds = $this->_run_query($query, $params);
@ -94,13 +92,13 @@ namespace models;
return $receiveds[0];
}
/**
* Return a list of media for a user
* Return a list of media for a user.
*
* @param int $id_user : User id
* @param int $limit : Max results to return
* @param int $offset : Number of results to ignore
* @param int $limit : Max results to return
* @param int $offset : Number of results to ignore
*/
public function list_for_user($id_user, $limit, $offset)
{
@ -110,7 +108,7 @@ namespace models;
$query = '
SELECT * FROM media
WHERE id_scheduled IN (SELECT id FROM scheduled WHERE id_user = :id_user)
LIMIT ' . $limit . ' OFFSET ' . $offset;
LIMIT '.$limit.' OFFSET '.$offset;
$params = [
'id_user' => $id_user,
@ -119,12 +117,13 @@ namespace models;
return $this->_run_query($query, $params);
}
/**
* Return a list of medias in a group of ids and for a user
* @param int $id_user : user id
* @param array $ids : ids of medias to find
* @return array
* Return a list of medias in a group of ids and for a user.
*
* @param int $id_user : user id
* @param array $ids : ids of medias to find
*
* @return array
*/
public function gets_in_for_user(int $id_user, $ids)
{
@ -137,15 +136,17 @@ namespace models;
$generated_in = $this->_generate_in_from_array($ids);
$query .= $generated_in['QUERY'];
$params = $generated_in['PARAMS'];
$params['id_user'] = $id_user;
$params['id_user'] = $id_user;
return $this->_run_query($query, $params);
}
/**
* Delete a entry by his id for a user
* Delete a entry by his id for a user.
*
* @param int $id_user : User id
* @param int $id : Entry id
* @param int $id : Entry id
*
* @return int : Number of removed rows
*/
public function delete_for_user(int $id_user, int $id)
@ -157,15 +158,16 @@ namespace models;
';
$params = ['id_user' => $id_user, 'id' => $id];
return $this->_run_query($query, $params, self::ROWCOUNT);
}
/**
* Delete a entry by his id for a user
* @param int $id_user : User id
* Delete a entry by his id for a user.
*
* @param int $id_user : User id
* @param int $id_scheduled : Scheduled id
*
* @return int : Number of removed rows
*/
public function delete_for_scheduled_and_user(int $id_user, int $id_scheduled)
@ -177,20 +179,20 @@ namespace models;
';
$params = ['id_user' => $id_user, 'id_scheduled' => $id_scheduled];
return $this->_run_query($query, $params, self::ROWCOUNT);
}
/**
* Update a media sms for a user
* @param int $id_user : User id
* Update a media sms for a user.
*
* @param int $id_user : User id
* @param int $id : Entry id
* @param array $datas : datas to update
* @param array $datas : datas to update
*
* @return int : number of modified rows
*/
public function update_for_user (int $id_user, int $id, array $datas)
public function update_for_user(int $id_user, int $id, array $datas)
{
$params = [];
$sets = [];
@ -198,13 +200,13 @@ namespace models;
foreach ($datas as $label => $value)
{
$label = preg_replace('#[^a-zA-Z0-9_]#', '', $label);
$params['set_' . $label] = $value;
$sets[] = '`' . $label . '` = :set_' . $label . ' ';
$params['set_'.$label] = $value;
$sets[] = '`'.$label.'` = :set_'.$label.' ';
}
$query = '
UPDATE `media`
SET ' . implode(', ', $sets) . '
SET '.implode(', ', $sets).'
WHERE id = :id
AND id_scheduled IN (SELECT id FROM scheduled WHERE id_user = :id_user)
';
@ -214,11 +216,12 @@ namespace models;
return $this->_run_query($query, $params, self::ROWCOUNT);
}
/**
* Count number of media sms for user
* Count number of media sms for user.
*
* @param int $id_user : user id
*
* @return int : Number of media SMS for user
*/
public function count_for_user($id_user)
@ -235,4 +238,14 @@ namespace models;
return $this->_run_query($query, $params)[0]['nb'] ?? 0;
}
/**
* Return table name.
*
* @return string
*/
protected function get_table_name(): string
{
return 'media';
}
}

36
models/Phone.php
View file

@ -14,31 +14,37 @@ namespace models;
class Phone extends StandardModel
{
/**
* Return table name
* @return string
*/
protected function get_table_name() : string { return 'phone'; }
/**
* Return a phone by his number and user
* @param int $id_user : user id
* @param string $number : phone number
* Return a phone by his number and user.
*
* @param int $id_user : user id
* @param string $number : phone number
*
* @return array
*/
public function get_by_number_and_user (int $id_user, string $number)
public function get_by_number_and_user(int $id_user, string $number)
{
return $this->_select_one('phone', ['number' => $number, 'id_user' => $id_user]);
}
/**
* Return a phone by his number
* Return a phone by his number.
*
* @param string $number : phone number
*
* @return array
*/
public function get_by_number (string $number)
public function get_by_number(string $number)
{
return $this->_select_one('phone', ['number' => $number]);
}
/**
* Return table name.
*
* @return string
*/
protected function get_table_name(): string
{
return 'phone';
}
}

170
models/Received.php
View file

@ -17,22 +17,17 @@ namespace models;
class Received extends StandardModel
{
/**
* Return table name
* @return string
*/
protected function get_table_name() : string { return 'received'; }
/**
* Return an entry by his id for a user
* Return an entry by his id for a user.
*
* @param int $id_user : user id
* @param int $id : entry id
* @param int $id : entry id
*
* @return array
*/
public function get_for_user(int $id_user, int $id)
{
$query = '
SELECT * FROM `' . $this->get_table_name() . '`
SELECT * FROM `'.$this->get_table_name().'`
WHERE destination IN (SELECT number FROM phone WHERE id_user = :id_user)
AND id = :id
';
@ -43,19 +38,21 @@ namespace models;
];
$receiveds = $this->_run_query($query, $params);
return $receiveds[0] ?? [];
}
/**
* Return all entries for a user
* Return all entries for a user.
*
* @param int $id_user : user id
*
* @return array
*/
public function gets_for_user(int $id_user)
{
$query = '
SELECT * FROM `' . $this->get_table_name() . '`
SELECT * FROM `'.$this->get_table_name().'`
WHERE destination IN (SELECT number FROM phone WHERE id_user = :id_user)
';
@ -66,12 +63,12 @@ namespace models;
$receiveds = $this->_run_query($query, $params);
}
/**
* Return a list of received for a user
* Return a list of received for a user.
*
* @param int $id_user : User id
* @param int $limit : Max results to return
* @param int $offset : Number of results to ignore
* @param int $limit : Max results to return
* @param int $offset : Number of results to ignore
*/
public function list_for_user($id_user, $limit, $offset)
{
@ -81,7 +78,7 @@ namespace models;
$query = '
SELECT * FROM received
WHERE destination IN (SELECT number FROM phone WHERE id_user = :id_user)
LIMIT ' . $limit . ' OFFSET ' . $offset;
LIMIT '.$limit.' OFFSET '.$offset;
$params = [
'id_user' => $id_user,
@ -89,13 +86,13 @@ namespace models;
return $this->_run_query($query, $params);
}
/**
* Return a list of unread received for a user
* Return a list of unread received for a user.
*
* @param int $id_user : User id
* @param int $limit : Max results to return
* @param int $offset : Number of results to ignore
* @param int $limit : Max results to return
* @param int $offset : Number of results to ignore
*/
public function list_unread_for_user($id_user, $limit, $offset)
{
@ -106,7 +103,7 @@ namespace models;
SELECT * FROM received
WHERE destination IN (SELECT number FROM phone WHERE id_user = :id_user)
AND status = \'unread\'
LIMIT ' . $limit . ' OFFSET ' . $offset;
LIMIT '.$limit.' OFFSET '.$offset;
$params = [
'id_user' => $id_user,
@ -115,12 +112,13 @@ namespace models;
return $this->_run_query($query, $params);
}
/**
* Return a list of receiveds in a group of ids and for a user
* @param int $id_user : user id
* @param array $ids : ids of receiveds to find
* @return array
* Return a list of receiveds in a group of ids and for a user.
*
* @param int $id_user : user id
* @param array $ids : ids of receiveds to find
*
* @return array
*/
public function gets_in_for_user(int $id_user, $ids)
{
@ -133,15 +131,17 @@ namespace models;
$generated_in = $this->_generate_in_from_array($ids);
$query .= $generated_in['QUERY'];
$params = $generated_in['PARAMS'];
$params['id_user'] = $id_user;
$params['id_user'] = $id_user;
return $this->_run_query($query, $params);
}
/**
* Delete a entry by his id for a user
* Delete a entry by his id for a user.
*
* @param int $id_user : User id
* @param int $id : Entry id
* @param int $id : Entry id
*
* @return int : Number of removed rows
*/
public function delete_for_user(int $id_user, int $id)
@ -153,20 +153,20 @@ namespace models;
';
$params = ['id_user' => $id_user, 'id' => $id];
return $this->_run_query($query, $params, self::ROWCOUNT);
}
/**
* Update a received sms for a user
* @param int $id_user : User id
* Update a received sms for a user.
*
* @param int $id_user : User id
* @param int $id : Entry id
* @param array $datas : datas to update
* @param array $datas : datas to update
*
* @return int : number of modified rows
*/
public function update_for_user (int $id_user, int $id, array $datas)
public function update_for_user(int $id_user, int $id, array $datas)
{
$params = [];
$sets = [];
@ -174,13 +174,13 @@ namespace models;
foreach ($datas as $label => $value)
{
$label = preg_replace('#[^a-zA-Z0-9_]#', '', $label);
$params['set_' . $label] = $value;
$sets[] = '`' . $label . '` = :set_' . $label . ' ';
$params['set_'.$label] = $value;
$sets[] = '`'.$label.'` = :set_'.$label.' ';
}
$query = '
UPDATE `received`
SET ' . implode(', ', $sets) . '
SET '.implode(', ', $sets).'
WHERE id = :id
AND destination IN (SELECT number FROM phone WHERE id_user = :id_user)
';
@ -196,11 +196,12 @@ namespace models;
return $this->_run_query($query, $params, self::ROWCOUNT);
}
/**
* Count number of received sms for user
* Count number of received sms for user.
*
* @param int $id_user : user id
*
* @return int : Number of received SMS for user
*/
public function count_for_user(int $id_user)
@ -217,11 +218,12 @@ namespace models;
return $this->_run_query($query, $params)[0]['nb'] ?? 0;
}
/**
* Count number of unread received sms for user
* Count number of unread received sms for user.
*
* @param int $id_user : user id
*
* @return int : Number of received SMS for user
*/
public function count_unread_for_user(int $id_user)
@ -240,12 +242,13 @@ namespace models;
return $this->_run_query($query, $params)[0]['nb'] ?? 0;
}
/**
* Return x last receiveds message for a user, order by date
* @param int $id_user : User id
* Return x last receiveds message for a user, order by date.
*
* @param int $id_user : User id
* @param int $nb_entry : Number of receiveds messages to return
* @return array
*
* @return array
*/
public function get_lasts_by_date_for_user(int $id_user, int $nb_entry)
{
@ -256,7 +259,7 @@ namespace models;
FROM received
WHERE destination IN (SELECT number FROM phone WHERE id_user = :id_user)
ORDER BY at ASC
LIMIT ' . $nb_entry;
LIMIT '.$nb_entry;
$params = [
'id_user' => $id_user,
@ -265,11 +268,12 @@ namespace models;
return $this->_run_query($query, $params);
}
/**
* Return receiveds for an origin and a user
* @param int $id_user : User id
* @param string $origin : Number who sent the message
* Return receiveds for an origin and a user.
*
* @param int $id_user : User id
* @param string $origin : Number who sent the message
*
* @return array
*/
public function gets_by_origin_and_user(int $id_user, string $origin)
@ -289,11 +293,12 @@ namespace models;
return $this->_run_query($query, $params);
}
/**
* Get number of sended SMS for every date since a date for a specific user
* @param int $id_user : user id
* @param \DateTime $date : Date since which we want the messages
* Get number of sended SMS for every date since a date for a specific user.
*
* @param int $id_user : user id
* @param \DateTime $date : Date since which we want the messages
*
* @return array
*/
public function count_by_day_since_for_user(int $id_user, $date)
@ -315,8 +320,10 @@ namespace models;
}
/**
* Return all discussions (ie : numbers we have a message received from or sended to) for a user
* Return all discussions (ie : numbers we have a message received from or sended to) for a user.
*
* @param int $id_user : User id
*
* @return array
*/
public function get_discussions_for_user(int $id_user)
@ -336,13 +343,16 @@ namespace models;
';
$params = ['id_user' => $id_user];
return $this->_run_query($query, $params);
}
/**
* Get SMS received since a date for a user
* Get SMS received since a date for a user.
*
* @param int $id_user : User id
* @param $date : La date depuis laquelle on veux les SMS (au format 2014-10-25 20:10:05)
*
* @return array : Tableau avec tous les SMS depuis la date
*/
public function get_since_by_date_for_user(int $id_user, $date)
@ -353,7 +363,7 @@ namespace models;
WHERE at > STR_TO_DATE(:date, '%Y-%m-%d %h:%i:%s')
AND destination IN (SELECT number FROM phone WHERE id_user = :id_user)
ORDER BY at ASC";
$params = [
'date' => $date,
'id_user' => $id_user,
@ -363,10 +373,12 @@ namespace models;
}
/**
* Find messages received since a date for a certain origin and user
* Find messages received since a date for a certain origin and user.
*
* @param int $id_user : User id
* @param $date : Date we want messages sinces
* @param string $origin : Origin number
*
* @return array
*/
public function get_since_by_date_for_origin_and_user(int $id_user, $date, string $origin)
@ -390,21 +402,23 @@ namespace models;
}
/**
* Find destination of last received message for an origin and user
* @param int $id_user : User id
* @param string $origin : Origin number
* Find destination of last received message for an origin and user.
*
* @param int $id_user : User id
* @param string $origin : Origin number
*
* @return array
*/
public function get_last_for_origin_and_user (int $id_user, string $origin)
public function get_last_for_origin_and_user(int $id_user, string $origin)
{
$query = "
$query = '
SELECT *
FROM received
WHERE origin = :origin
AND destination IN (SELECT number FROM phone WHERE id_user = :id_user)
ORDER BY at DESC
LIMIT 0,1
";
';
$params = [
'origin' => $origin,
@ -413,6 +427,16 @@ namespace models;
$result = $this->_run_query($query, $params);
return ($result[0] ?? []);
return $result[0] ?? [];
}
/**
* Return table name.
*
* @return string
*/
protected function get_table_name(): string
{
return 'received';
}
}

129
models/Scheduled.php
View file

@ -14,15 +14,10 @@ namespace models;
class Scheduled extends StandardModel
{
/**
* Return table name
* @return string
*/
protected function get_table_name() : string { return 'scheduled'; }
/**
* Return numbers for a scheduled message
* Return numbers for a scheduled message.
*
* @param int $id_scheduled : Scheduled id
*
* @return array
*/
public function get_numbers(int $id_scheduled)
@ -30,134 +25,152 @@ namespace models;
return $this->_select('scheduled_number', ['id_scheduled' => $id_scheduled]);
}
/**
* Return contacts for a scheduled message
* Return contacts for a scheduled message.
*
* @param int $id_scheduled : Scheduled id
*
* @return array
*/
public function get_contacts(int $id_scheduled)
{
$query = 'SELECT * FROM contact WHERE id IN (SELECT id_contact FROM scheduled_contact WHERE id_scheduled = :id_scheduled)';
$params = ['id_scheduled' => $id_scheduled];
return $this->_run_query($query, $params);
}
/**
* Return groups for a scheduled message
* Return groups for a scheduled message.
*
* @param int $id_scheduled : Scheduled id
*
* @return array
*/
public function get_groups(int $id_scheduled)
{
$query = 'SELECT * FROM `group` WHERE id IN (SELECT id_group FROM scheduled_group WHERE id_scheduled = :id_scheduled)';
$params = ['id_scheduled' => $id_scheduled];
return $this->_run_query($query, $params);
}
/**
* Return conitional groups for a scheduled message
* Return conitional groups for a scheduled message.
*
* @param int $id_scheduled : Scheduled id
*
* @return array
*/
public function get_conditional_groups(int $id_scheduled)
{
$query = 'SELECT * FROM `conditional_group` WHERE id IN (SELECT id_conditional_group FROM scheduled_conditional_group WHERE id_scheduled = :id_scheduled)';
$params = ['id_scheduled' => $id_scheduled];
return $this->_run_query($query, $params);
}
/**
* Insert a number for a scheduled
* @param int $id_scheduled : Scheduled id
* @param string $number : Number
* Insert a number for a scheduled.
*
* @param int $id_scheduled : Scheduled id
* @param string $number : Number
*
* @return mixed (bool|int) : False on error, new row id else
*/
public function insert_scheduled_number(int $id_scheduled, string $number)
{
$success = $this->_insert('scheduled_number', ['id_scheduled' => $id_scheduled, 'number' => $number]);
return ($success ? $this->_last_id() : false);
return $success ? $this->_last_id() : false;
}
/**
* Insert a relation between a scheduled and a contact
* Insert a relation between a scheduled and a contact.
*
* @param int $id_scheduled : Scheduled id
* @param int $id_contact : Group id
* @param int $id_contact : Group id
*
* @return mixed (bool|int) : False on error, new row id else
*/
public function insert_scheduled_contact_relation(int $id_scheduled, int $id_contact)
{
$success = $this->_insert('scheduled_contact', ['id_scheduled' => $id_scheduled, 'id_contact' => $id_contact]);
return ($success ? $this->_last_id() : false);
return $success ? $this->_last_id() : false;
}
/**
* Insert a relation between a scheduled and a group
* Insert a relation between a scheduled and a group.
*
* @param int $id_scheduled : Scheduled id
* @param int $id_group : Group id
* @param int $id_group : Group id
*
* @return mixed (bool|int) : False on error, new row id else
*/
public function insert_scheduled_group_relation(int $id_scheduled, int $id_group)
{
$success = $this->_insert('scheduled_group', ['id_scheduled' => $id_scheduled, 'id_group' => $id_group]);
return ($success ? $this->_last_id() : false);
return $success ? $this->_last_id() : false;
}
/**
* Insert a relation between a scheduled and a conditional group
* @param int $id_scheduled : Scheduled id
* Insert a relation between a scheduled and a conditional group.
*
* @param int $id_scheduled : Scheduled id
* @param int $id_conditional_group : Group id
*
* @return mixed (bool|int) : False on error, new row id else
*/
public function insert_scheduled_conditional_group_relation(int $id_scheduled, int $id_conditional_group)
{
$success = $this->_insert('scheduled_conditional_group', ['id_scheduled' => $id_scheduled, 'id_conditional_group' => $id_conditional_group]);
return ($success ? $this->_last_id() : false);
return $success ? $this->_last_id() : false;
}
/**
* Delete numbers for a scheduled
* Delete numbers for a scheduled.
*
* @param int $id_scheduled : Scheduled id
*
* @return mixed int : Number of deleted rows
*/
public function delete_scheduled_numbers(int $id_scheduled)
{
return $this->_delete('scheduled_number', ['id_scheduled' => $id_scheduled]);
}
/**
* Delete contact scheduled relations for a scheduled
* Delete contact scheduled relations for a scheduled.
*
* @param int $id_scheduled : Scheduled id
*
* @return mixed int : Number of deleted rows
*/
public function delete_scheduled_contact_relations(int $id_scheduled)
{
return $this->_delete('scheduled_contact', ['id_scheduled' => $id_scheduled]);
}
/**
* Delete group scheduled relations for a scheduled
* Delete group scheduled relations for a scheduled.
*
* @param int $id_scheduled : Scheduled id
*
* @return mixed int : Number of deleted rows
*/
public function delete_scheduled_group_relations(int $id_scheduled)
{
return $this->_delete('scheduled_group', ['id_scheduled' => $id_scheduled]);
}
/**
* Delete conditional group scheduled relations for a scheduled
* Delete conditional group scheduled relations for a scheduled.
*
* @param int $id_scheduled : Scheduled id
*
* @return mixed int : Number of deleted rows
*/
public function delete_scheduled_conditional_group_relations(int $id_scheduled)
@ -165,15 +178,16 @@ namespace models;
return $this->_delete('scheduled_conditional_group', ['id_scheduled' => $id_scheduled]);
}
/**
* Get messages scheduled before a date for a number and a user
* Get messages scheduled before a date for a number and a user.
*
* @param int $id_user : User id
* @param $date : Date before which we want messages
* @param string $number : Number for which we want messages
*
* @return array
*/
public function gets_before_date_for_number_and_user (int $id_user, $date, string $number)
public function gets_before_date_for_number_and_user(int $id_user, $date, string $number)
{
$query = '
SELECT *
@ -220,14 +234,25 @@ namespace models;
return $this->_run_query($query, $params);
}
/**
* Get scheduleds before a date
* Get scheduleds before a date.
*
* @param string $date : Date to get scheduleds before
*
* @return array
*/
public function gets_before_date (string $date)
public function gets_before_date(string $date)
{
return $this->_select($this->get_table_name(), ['<=at' => $date]);
}
/**
* Return table name.
*
* @return string
*/
protected function get_table_name(): string
{
return 'scheduled';
}
}

148
models/Sended.php
View file

@ -17,22 +17,17 @@ namespace models;
class Sended extends StandardModel
{
/**
* Return table name
* @return string
*/
protected function get_table_name() : string { return 'sended'; }
/**
* Return an entry by his id for a user
* Return an entry by his id for a user.
*
* @param int $id_user : user id
* @param int $id : entry id
* @param int $id : entry id
*
* @return array
*/
public function get_for_user(int $id_user, int $id)
{
$query = '
SELECT * FROM `' . $this->get_table_name() . '`
SELECT * FROM `'.$this->get_table_name().'`
WHERE origin IN (SELECT number FROM phone WHERE id_user = :id_user)
AND id = :id
';
@ -43,19 +38,21 @@ namespace models;
];
$receiveds = $this->_run_query($query, $params);
return $receiveds[0] ?? [];
}
/**
* Return all entries for a user
* Return all entries for a user.
*
* @param int $id_user : user id
*
* @return array
*/
public function gets_for_user(int $id_user)
{
$query = '
SELECT * FROM `' . $this->get_table_name() . '`
SELECT * FROM `'.$this->get_table_name().'`
WHERE origin IN (SELECT number FROM phone WHERE id_user = :id_user)
';
@ -65,13 +62,13 @@ namespace models;
$receiveds = $this->_run_query($query, $params);
}
/**
* Return a list of sended for a user
* Return a list of sended for a user.
*
* @param int $id_user : User id
* @param int $limit : Max results to return
* @param int $offset : Number of results to ignore
* @param int $limit : Max results to return
* @param int $offset : Number of results to ignore
*/
public function list_for_user($id_user, $limit, $offset)
{
@ -81,7 +78,7 @@ namespace models;
$query = '
SELECT * FROM sended
WHERE origin IN (SELECT number FROM phone WHERE id_user = :id_user)
LIMIT ' . $limit . ' OFFSET ' . $offset;
LIMIT '.$limit.' OFFSET '.$offset;
$params = [
'id_user' => $id_user,
@ -90,12 +87,13 @@ namespace models;
return $this->_run_query($query, $params);
}
/**
* Return a list of sendeds in a group of ids and for a user
* @param int $id_user : user id
* @param array $ids : ids of sendeds to find
* @return array
* Return a list of sendeds in a group of ids and for a user.
*
* @param int $id_user : user id
* @param array $ids : ids of sendeds to find
*
* @return array
*/
public function gets_in_for_user(int $id_user, $ids)
{
@ -108,15 +106,17 @@ namespace models;
$generated_in = $this->_generate_in_from_array($ids);
$query .= $generated_in['QUERY'];
$params = $generated_in['PARAMS'];
$params['id_user'] = $id_user;
$params['id_user'] = $id_user;
return $this->_run_query($query, $params);
}
/**
* Delete a entry by his id for a user
* Delete a entry by his id for a user.
*
* @param int $id_user : User id
* @param int $id : Entry id
* @param int $id : Entry id
*
* @return int : Number of removed rows
*/
public function delete_for_user(int $id_user, int $id)
@ -128,20 +128,20 @@ namespace models;
';
$params = ['id_user' => $id_user, 'id' => $id];
return $this->_run_query($query, $params, self::ROWCOUNT);
}
/**
* Update a sended sms for a user
* @param int $id_user : User id
* Update a sended sms for a user.
*
* @param int $id_user : User id
* @param int $id : Entry id
* @param array $datas : datas to update
* @param array $datas : datas to update
*
* @return int : number of modified rows
*/
public function update_for_user (int $id_user, int $id, array $datas)
public function update_for_user(int $id_user, int $id, array $datas)
{
$params = [];
$sets = [];
@ -149,13 +149,13 @@ namespace models;
foreach ($datas as $label => $value)
{
$label = preg_replace('#[^a-zA-Z0-9_]#', '', $label);
$params['set_' . $label] = $value;
$sets[] = '`' . $label . '` = :set_' . $label . ' ';
$params['set_'.$label] = $value;
$sets[] = '`'.$label.'` = :set_'.$label.' ';
}
$query = '
UPDATE `sended`
SET ' . implode(', ', $sets) . '
SET '.implode(', ', $sets).'
WHERE id = :id
AND origin IN (SELECT number FROM phone WHERE id_user = :id_user)
';
@ -171,11 +171,12 @@ namespace models;
return $this->_run_query($query, $params, self::ROWCOUNT);
}
/**
* Count number of sended sms for user
* Count number of sended sms for user.
*
* @param int $id_user : user id
*
* @return int : Number of sended SMS for user
*/
public function count_for_user($id_user)
@ -193,12 +194,13 @@ namespace models;
return $this->_run_query($query, $params)[0]['nb'] ?? 0;
}
/**
* Return x last sendeds message for a user, order by date
* @param int $id_user : User id
* Return x last sendeds message for a user, order by date.
*
* @param int $id_user : User id
* @param int $nb_entry : Number of sendeds messages to return
* @return array
*
* @return array
*/
public function get_lasts_by_date_for_user($id_user, $nb_entry)
{
@ -209,7 +211,7 @@ namespace models;
FROM sended
WHERE origin IN (SELECT number FROM phone WHERE id_user = :id_user)
ORDER BY at ASC
LIMIT ' . $nb_entry;
LIMIT '.$nb_entry;
$params = [
'id_user' => $id_user,
@ -218,11 +220,12 @@ namespace models;
return $this->_run_query($query, $params);
}
/**
* Return sendeds for an destination and a user
* @param int $id_user : User id
* Return sendeds for an destination and a user.
*
* @param int $id_user : User id
* @param string $destination : Number who sent the message
*
* @return array
*/
public function gets_by_destination_and_user(int $id_user, string $destination)
@ -241,12 +244,13 @@ namespace models;
return $this->_run_query($query, $params);
}
/**
* Return sended for an uid and an adapter
* @param string $uid : Uid of the sended
* Return sended for an uid and an adapter.
*
* @param string $uid : Uid of the sended
* @param string $adapter : Adapter used to send the message
*
* @return array
*/
public function get_by_uid_and_adapter(string $uid, string $adapter)
@ -255,9 +259,11 @@ namespace models;
}
/**
* Get number of sended SMS for every date since a date for a specific user
* @param int $id_user : user id
* @param \DateTime $date : Date since which we want the messages
* Get number of sended SMS for every date since a date for a specific user.
*
* @param int $id_user : user id
* @param \DateTime $date : Date since which we want the messages
*
* @return array
*/
public function count_by_day_since_for_user($id_user, $date)
@ -279,9 +285,11 @@ namespace models;
}
/**
* Get SMS sended since a date for a user
* Get SMS sended since a date for a user.
*
* @param $date : La date depuis laquelle on veux les SMS (au format 2014-10-25 20:10:05)
* @param int $id_user : User id
*
* @return array : Tableau avec tous les SMS depuis la date
*/
public function get_since_by_date_for_user($date, $id_user)
@ -292,7 +300,7 @@ namespace models;
WHERE at > STR_TO_DATE(:date, '%Y-%m-%d %h:%i:%s')
AND origin IN (SELECT number FROM phone WHERE id_user = :id_user)
ORDER BY at ASC";
$params = [
'date' => $date,
'id_user' => $id_user,
@ -300,24 +308,25 @@ namespace models;
return $this->_run_query($query, $params);
}
/**
* Find last sended message for a destination and user
* @param int $id_user : User id
* Find last sended message for a destination and user.
*
* @param int $id_user : User id
* @param string $destination : Destination number
*
* @return array
*/
public function get_last_for_destination_and_user (int $id_user, string $destination)
public function get_last_for_destination_and_user(int $id_user, string $destination)
{
$query = "
$query = '
SELECT *
FROM sended
WHERE destination = :destination
AND origin IN (SELECT number FROM phone WHERE id_user = :id_user)
ORDER BY at DESC
LIMIT 0,1
";
';
$params = [
'destination' => $destination,
@ -326,7 +335,16 @@ namespace models;
$result = $this->_run_query($query, $params);
return ($result[0] ?? []);
return $result[0] ?? [];
}
/**
* Return table name.
*
* @return string
*/
protected function get_table_name(): string
{
return 'sended';
}
}

27
models/Setting.php
View file

@ -14,21 +14,26 @@ namespace models;
class Setting extends StandardModel
{
/**
* Return table name
* @return string
*/
protected function get_table_name() : string { return 'setting'; }
/**
* Update a setting for a user by his name
* @param int $id_user : user id
* @param string $name : setting name
* @param mixed $value : new value of the setting
* Update a setting for a user by his name.
*
* @param int $id_user : user id
* @param string $name : setting name
* @param mixed $value : new value of the setting
*
* @return int : number of modified settings
*/
public function update_by_name_for_user(int $id_user, string $name, $value)
{
return $this->_update($this->get_table_name(), ['value' => $value], ['id_user' => $id_user, 'name' => $name]);
}
/**
* Return table name.
*
* @return string
*/
protected function get_table_name(): string
{
return 'setting';
}
}

27
models/SmsStop.php
View file

@ -14,20 +14,25 @@ namespace models;
class SmsStop extends StandardModel
{
/**
* Return table name
* @return string
*/
protected function get_table_name() : string { return 'smsstop'; }
/**
* Return a smsstop by his number and user
* @param int $id_user : user id
* @param string $number : phone number
* Return a smsstop by his number and user.
*
* @param int $id_user : user id
* @param string $number : phone number
*
* @return array
*/
public function get_by_number_for_user (int $id_user, string $number)
public function get_by_number_for_user(int $id_user, string $number)
{
return $this->_select_one($this->get_table_name(), ['number' => $number, 'id_user' => $id_user]);
}
/**
* Return table name.
*
* @return string
*/
protected function get_table_name(): string
{
return 'smsstop';
}
}

112
models/StandardModel.php
View file

@ -13,52 +13,50 @@ namespace models;
/**
* Abstract class reprensenting the Standard Model
* This class implement/define most common methods for models
* This class implement/define most common methods for models.
*/
abstract class StandardModel extends \descartes\Model
{
/**
* Return table name
* @return string
*/
abstract protected function get_table_name() : string;
/**
* Return all the entries
* Return all the entries.
*
* @return array
*/
public function get_all ()
public function get_all()
{
return $this->_select($this->get_table_name());
}
/**
* Return an entry by his id
* Return an entry by his id.
*
* @param int $id : entry id
*
* @return array
*/
public function get(int $id)
{
return $this->_select_one($this->get_table_name(), ['id' => $id]);
}
/**
* Return an entry by his id for a user
* Return an entry by his id for a user.
*
* @param int $id_user : user id
* @param int $id : entry id
* @param int $id : entry id
*
* @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]);
}
/**
* Return all entries for a user
* Return all entries for a user.
*
* @param int $id_user : user id
*
* @return array
*/
public function gets_for_user(int $id_user)
@ -66,25 +64,27 @@ namespace models;
return $this->_select($this->get_table_name(), ['id_user' => $id_user]);
}
/**
* 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 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
*/
public function list_for_user (int $id_user, $limit, $offset)
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);
}
/**
* 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
* 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)
{
@ -92,9 +92,9 @@ namespace models;
{
return [];
}
$query = '
SELECT * FROM `' . $this->get_table_name() . '`
SELECT * FROM `'.$this->get_table_name().'`
WHERE id_user = :id_user
AND id ';
@ -110,22 +110,24 @@ namespace models;
return $this->_run_query($query, $params);
}
/**
* Delete a entry by his id for a user
* Delete a entry by his id for a user.
*
* @param int $id_user : User id
* @param int $id : Entry id
* @param int $id : Entry id
*
* @return int : Number of removed rows
*/
public function delete_for_user(int $id_user, int $id)
{
return $this->_delete($this->get_table_name(), ['id_user' => $id_user, 'id' => $id]);
}
/**
* Delete a entry by his id
* Delete a entry by his id.
*
* @param int $id : Entry id
*
* @return int : Number of removed rows
*/
public function delete(int $id)
@ -133,24 +135,26 @@ namespace models;
return $this->_delete($this->get_table_name(), ['id' => $id]);
}
/**
* Insert a entry
* Insert a entry.
*
* @param array $entry : Entry to insert
*
* @return mixed bool|int : false on error, new entry id else
*/
public function insert($entry)
{
$result = $this->_insert($this->get_table_name(), $entry);
return ($result ? $this->_last_id() : false);
return $result ? $this->_last_id() : false;
}
/**
* Update a entry for a user
* @param int $id_user : User id
* Update a entry for a user.
*
* @param int $id_user : User id
* @param int $id : Entry id
* @param array $datas : datas to update
* @param array $datas : datas to update
*
* @return int : number of modified rows
*/
@ -158,11 +162,11 @@ namespace models;
{
return $this->_update($this->get_table_name(), $entry, ['id_user' => $id_user, 'id' => $id]);
}
/**
* Update a entry by his id
* @param int $id : Entry id
* Update a entry by his id.
*
* @param int $id : Entry id
* @param array $datas : datas to update
*
* @return int : number of modified rows
@ -172,14 +176,22 @@ namespace models;
return $this->_update($this->get_table_name(), $entry, ['id' => $id]);
}
/**
* Count number of entry for a user
* Count number of entry for a user.
*
* @param int $id_user : User id
*
* @return int : number of entries
*/
public function count_for_user(int $id_user)
{
return $this->_count($this->get_table_name(), ['id_user' => $id_user]);
}
/**
* Return table name.
*
* @return string
*/
abstract protected function get_table_name(): string;
}

42
models/User.php
View file

@ -12,34 +12,37 @@
namespace models;
/**
* Class for user table administration. Not a standard model because has absolutly no user based restrictions
* Class for user table administration. Not a standard model because has absolutly no user based restrictions.
*/
class User extends \descartes\Model
{
/**
* Find a user by his id
* Find a user by his id.
*
* @param string $id : User id
*
* @return mixed array
*/
public function get ($id)
public function get($id)
{
return $this->_select_one('user', ['id' => $id]);
}
/**
* Find a user using his email
* Find a user using his email.
*
* @param string $email : User email
*
* @return mixed array
*/
public function get_by_email($email)
{
return $this->_select_one('user', ['email' => $email]);
}
/**
* Get a user by his api_key address
* Get a user by his api_key address.
*
* @param string $api_key : User api key
*
* @return mixed boolean | array : false if cannot find user for this api key, the user else
@ -49,7 +52,6 @@ namespace models;
return $this->_select_one('user', ['api_key' => $api_key]);
}
/**
* Return list of user.
*
@ -61,7 +63,6 @@ namespace models;
return $this->_select('user', [], null, false, $limit, $offset);
}
/**
* Retourne une liste de useres sous forme d'un tableau.
*
@ -75,23 +76,26 @@ namespace models;
return $this->_delete('user', ['id' => $id]);
}
/**
* Insert a new user
* Insert a new user.
*
* @param array $user : User to insert
*
* @return mixed bool|int : false if fail, new user id else
*/
public function insert($user)
{
$success = $this->_insert('user', $user);
return ($success ? $this->_last_id() : false);
return $success ? $this->_last_id() : false;
}
/**
* Update a user using his is
* @param int $id : User id
* Update a user using his is.
*
* @param int $id : User id
* @param array $datas : Datas to update
*
* @return int : number of modified rows
*/
public function update($id, $datas)
@ -99,11 +103,12 @@ namespace models;
return $this->_update('user', $datas, ['id' => $id]);
}
/**
* Update a user password by his id.
*
* @param int $id : User id
* @param array $password : The new password of the user
*
* @return int : Number of modified lines
*/
public function update_password($id, $password)
@ -111,11 +116,12 @@ namespace models;
return $this->_update('user', ['password' => $password], ['id' => $id]);
}
/**
* Update a user email by his id.
*
* @param int $id : User id
* @param array $email : The new email
*
* @return int : Number of modified lines
*/
public function update_email($id, $email)

27
models/Webhook.php
View file

@ -14,20 +14,25 @@ namespace models;
class Webhook extends StandardModel
{
/**
* Return table name
* @return string
*/
protected function get_table_name() : string { return 'webhook'; }
/**
* Find all webhooks for a user and for a type of webhook
* @param int $id_user : User id
* @param string $type : Webhook type
* Find all webhooks for a user and for a type of webhook.
*
* @param int $id_user : User id
* @param string $type : Webhook type
*
* @return array
*/
public function gets_for_type_and_user (int $id_user, string $type)
public function gets_for_type_and_user(int $id_user, string $type)
{
return $this->_select($this->get_table_name(), ['id_user' => $id_user, 'type' => $type]);
}
/**
* Return table name.
*
* @return string
*/
protected function get_table_name(): string
{
return 'webhook';
}
}