Skip to content

Commit

Permalink
adding some phpdoc comments and phpcs fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@lornajane
lornajane committed Jul 4, 2011
1 parent 17414a5 commit 69fd71b
Showing 1 changed file with 163 additions and 36 deletions.
199 changes: 163 additions & 36 deletions src/api-v2/models/EventModel.php
View file
@@ -1,7 +1,22 @@
<?php

class EventModel extends ApiModel {
public static function getDefaultFields() {
/**
* EventModel
*
* @uses ApiModel
* @package API
*/
class EventModel extends ApiModel
{
/**
* Default mapping for column names to API field names
*
* @static
*
* @return array with keys as API fields and values as db columns
*/
public static function getDefaultFields()
{
$fields = array(
'event_id' => 'ID',
'name' => 'event_name',
Expand All @@ -15,7 +30,15 @@ public static function getDefaultFields() {
return $fields;
}

public static function getVerboseFields() {
/**
* Field/column name mappings for the verbose version
*
* This should contain everything above and then more in most cases
*
* @return array with keys as API fields and values as db columns
*/
public static function getVerboseFields()
{
$fields = array(
'event_id' => 'ID',
'name' => 'event_name',
Expand All @@ -38,16 +61,26 @@ public static function getVerboseFields() {
return $fields;
}

public static function getEventById($db, $event_id, $verbose = false) {
/**
* Fetch the details for a single event
*
* @param PDO $db database object
* @param int $event_id events.ID value
* @param boolean $verbose used to determine how many fields are needed
*
* @return array the event detail
*/
public static function getEventById($db, $event_id, $verbose = false)
{
$sql = 'select * from events '
. 'where active = 1 and '
. '(pending = 0 or pending is NULL) and '
. 'ID = :event_id';
$stmt = $db->prepare($sql);
$response = $stmt->execute(array(
':event_id' => $event_id
));
if($response) {
$response = $stmt->execute(
array(':event_id' => $event_id)
);
if ($response) {
$results = $stmt->fetchAll(PDO::FETCH_ASSOC);
$retval = static::transformResults($results, $verbose);
return $retval;
Expand All @@ -56,23 +89,40 @@ public static function getEventById($db, $event_id, $verbose = false) {

}

protected static function getEvents($db, $resultsperpage, $start, $where = null, $order = null) {
/**
* Internal function called by other event-fetching code, with changeable SQL
*
* @param PDO $db database object
* @param int $resultsperpage how many records to return
* @param int $start offset to start returning records from
* @param string $where one final thing to add to the where after an "AND"
* @param string $order what goes after "ORDER BY"
*
* @return array the raw database results
*/
protected static function getEvents($db, $resultsperpage, $start,
$where = null, $order = null)
{
$sql = 'select events.*, '
. '(select count(*) from user_attend where user_attend.eid = events.ID) as attendee_count, '
. '(select count(*) from event_comments where event_comments.event_id = events.ID) as event_comment_count, '
. 'abs(datediff(from_unixtime(events.event_start), from_unixtime('.mktime(0,0,0).'))) as score '
. '(select count(*) from user_attend where user_attend.eid = events.ID)
as attendee_count, '
. '(select count(*) from event_comments where
event_comments.event_id = events.ID)
as event_comment_count, '
. 'abs(datediff(from_unixtime(events.event_start),
from_unixtime('.mktime(0, 0, 0).'))) as score '
. 'from events '
. 'where active = 1 and '
. '(pending = 0 or pending is NULL) and '
. 'private <> "y" ';

// where
if($where) {
if ($where) {
$sql .= ' and ' . $where;
}

// order by
if($order) {
if ($order) {
$sql .= ' order by ' . $order;
}

Expand All @@ -81,79 +131,156 @@ protected static function getEvents($db, $resultsperpage, $start, $where = null,

$stmt = $db->prepare($sql);
$response = $stmt->execute();
if($response) {
if ($response) {
return $stmt->fetchAll(PDO::FETCH_ASSOC);
}
return false;
}

public static function getEventList($db, $resultsperpage, $start, $verbose = false) {
/**
* getEventList
*
* @param PDO $db database object
* @param int $resultsperpage how many records to return
* @param int $start offset to start returning records from
* @param boolean $verbose used to determine how many fields are needed
*
* @return array the data, or false if something went wrong
*/
public static function getEventList($db, $resultsperpage, $start,
$verbose = false)
{
$order = 'events.event_start desc';
$results = static::getEvents($db, $resultsperpage, $start, null, $order);
if($results) {
if ($results) {
$retval = static::transformResults($results, $verbose);
return $retval;
}
return false;
}

public static function getHotEventList($db, $resultsperpage, $start, $verbose = false) {
/**
* Events which are current and popular
*
* formula taken from original joindin codebase, uses number of people
* attending and how soon/recent something is to calculate it's "hotness"
*
* @param PDO $db database object
* @param int $resultsperpage how many records to return
* @param int $start offset to start returning records from
* @param boolean $verbose used to determine how many fields are needed
*
* @return array the data, or false if something went wrong
*/
public static function getHotEventList($db, $resultsperpage, $start,
$verbose = false)
{
$order = '(((attendee_count + event_comment_count) * 0.5)
- EXP(GREATEST(1,score)/10)) desc';
$results = static::getEvents($db, $resultsperpage, $start, null, $order);
if($results) {
if ($results) {
$retval = static::transformResults($results, $verbose);
return $retval;
}
return false;
}

public static function getUpcomingEventList($db, $resultsperpage, $start, $verbose = false) {
$where = '(events.event_start >=' . (mktime(0,0,0) - (3 * 86400)) . ')';
/**
* Future events, soonest first
*
* @param PDO $db database object
* @param int $resultsperpage how many records to return
* @param int $start offset to start returning records from
* @param boolean $verbose used to determine how many fields are needed
*
* @return array the data, or false if something went wrong
*/
public static function getUpcomingEventList($db, $resultsperpage, $start,
$verbose = false)
{
$where = '(events.event_start >=' . (mktime(0, 0, 0) - (3 * 86400)) . ')';
$order = 'events.event_start';
$results = static::getEvents($db, $resultsperpage, $start, $where, $order);
if($results) {
if ($results) {
$retval = static::transformResults($results, $verbose);
return $retval;
}
return false;
}

public static function getPastEventList($db, $resultsperpage, $start, $verbose = false) {
$where = '(events.event_start <' . (mktime(0,0,0)) . ')';
/**
* Past events, most recent first
*
* @param PDO $db database object
* @param int $resultsperpage how many records to return
* @param int $start offset to start returning records from
* @param boolean $verbose used to determine how many fields are needed
*
* @return array the data, or false if something went wrong
*/
public static function getPastEventList($db, $resultsperpage, $start,
$verbose = false)
{
$where = '(events.event_start <' . (mktime(0, 0, 0)) . ')';
$order = 'events.event_start desc';
$results = static::getEvents($db, $resultsperpage, $start, $where, $order);
if($results) {
if ($results) {
$retval = static::transformResults($results, $verbose);
return $retval;
}
return false;
}

public static function getOpenCfPEventList($db, $resultsperpage, $start, $verbose = false) {
$where = 'events.event_cfp_url IS NOT NULL AND events.event_cfp_end >= ' . mktime(0,0,0);
/**
* Events with CfPs that close in the future and a cfp_url
*
* @param PDO $db database object
* @param int $resultsperpage how many records to return
* @param int $start offset to start returning records from
* @param boolean $verbose used to determine how many fields are needed
*
* @return array the data, or false if something went wrong
*/
public static function getOpenCfPEventList($db, $resultsperpage, $start,
$verbose = false)
{
$where = 'events.event_cfp_url IS NOT NULL AND events.event_cfp_end >= ' . mktime(0, 0, 0);
$order = 'events.event_start';
$results = static::getEvents($db, $resultsperpage, $start, $where, $order);
if($results) {
if ($results) {
$retval = static::transformResults($results, $verbose);
return $retval;
}
return false;
}

public static function addHyperMedia($list, $request) {
/**
* Add links to related stuff, including the talks/comments for this event
*
* @param array $list Current data set
* @param Request $request The Request object created at bootstrap
*
* @return array A dataset now with each record having its links,
* and pagination if appropriate
*/
public static function addHyperMedia($list, $request)
{
$host = $request->host;

// add per-item links
if(is_array($list) && count($list)) {
foreach($list as $key => $row) {
$list[$key]['uri'] = 'http://' . $host . '/v2/events/' . $row['event_id'];
$list[$key]['verbose_uri'] = 'http://' . $host . '/v2/events/' . $row['event_id'] . '?verbose=yes';
$list[$key]['comments_link'] = 'http://' . $host . '/v2/events/' . $row['event_id'] . '/comments';
$list[$key]['talks_link'] = 'http://' . $host . '/v2/events/' . $row['event_id'] . '/talks';
if (is_array($list) && count($list)) {
foreach ($list as $key => $row) {
$list[$key]['uri'] = 'http://' . $host . '/v2/events/'
. $row['event_id'];
$list[$key]['verbose_uri'] = 'http://' . $host . '/v2/events/'
. $row['event_id'] . '?verbose=yes';
$list[$key]['comments_link'] = 'http://' . $host . '/v2/events/'
. $row['event_id'] . '/comments';
$list[$key]['talks_link'] = 'http://' . $host . '/v2/events/'
. $row['event_id'] . '/talks';
}

if(count($list) > 1) {
if (count($list) > 1) {
$list = static::addPaginationLinks($list, $request);
}
}
Expand Down

0 comments on commit 69fd71b

Please sign in to comment.