<?php
/**
* @brief Follow Model
* @author <a href='https://www.invisioncommunity.com'>Invision Power Services, Inc.</a>
* @copyright (c) Invision Power Services, Inc.
* @license https://www.invisioncommunity.com/legal/standards/
* @package Invision Community
* @since 13 Nov 2017
* @todo Adjust follow code over time to use this class instead
*/
namespace IPS\core\Followed;
/* To prevent PHP errors (extending class does not exist) revealing path */
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
{
header( ( isset( $_SERVER['SERVER_PROTOCOL'] ) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0' ) . ' 403 Forbidden' );
exit;
}
/**
* Follow Model
*/
class _Follow extends \IPS\Patterns\ActiveRecord
{
/**
* @brief Database Table
*/
public static $databaseTable = 'core_follow';
/**
* @brief Database Prefix
*/
public static $databasePrefix = 'follow_';
/**
* @brief Multiton Store
*/
protected static $multitons;
/**
* @brief [ActiveRecord] ID Database Column
*/
public static $databaseColumnId = 'id';
/**
* @brief [ActiveRecord] Multiton Map
*/
protected static $multitonMap = array();
/**
* Save
*
* @return void
*/
public function save()
{
if( $this->_new )
{
$this->visible = 1;
$this->notify_sent = 0;
$this->added = time();
$this->index_id = NULL;
}
$this->id = md5( $this->app . ';' . $this->area . ';' . $this->rel_id . ';' . $this->member_id );
parent::save();
}
/**
* Get output for API
*
* @param \IPS\Member|NULL $authorizedMember The member making the API request or NULL for API Key / client_credentials
* @return array
* @apiresponse int followKey Unique key that represents the follow
* @apiresponse string followApp The application of the content that was followed
* @apiresponse string followArea The area of the content that was followed
* @apiresponse int followId The ID of the content that was followed
* @apiresponse bool followAnon Flag to indicate if the member is following anonymously
* @apiresponse bool followNotify Flag to indicate if notifications should be sent
* @apiresponse string|null followType Notification preference for this follow, or null if notifications are not being sent
* @apiresponse datetime|null followSent Date and time the last notification was sent, or NULL if none has been sent
* @apiresponse string followName Textual representation of the content that was followed (title, name, etc.)
* @apiresponse string followUrl URL to the content that was followed
*/
public function apiOutput( \IPS\Member $authorizedMember = NULL )
{
if( $this->area == 'member' AND $this->app == 'core' )
{
$followed = \IPS\Member::load( $this->rel_id );
$name = $followed->name;
$url = $followed->url();
}
else
{
foreach( \IPS\Application::load( $this->app )->extensions( 'core', 'ContentRouter' ) as $key => $router )
{
foreach( $router->classes as $class )
{
$followArea = mb_strtolower( mb_substr( $class, mb_strrpos( $class, '\\' ) + 1 ) );
if( $followArea == $this->area AND $class::$application == $this->app )
{
try
{
$followed = $class::load( $this->rel_id );
$name = $followed->mapped('title');
$url = $followed->url();
}
catch( \OutOfRangeException $e )
{
/* If the item doesn't exist we may as well clean up core_follow */
parent::delete();
return NULL;
}
}
else
{
$containers = array();
if( isset( $class::$containerNodeClass ) )
{
$containers[ $class::$containerNodeClass ] = $class::$containerNodeClass;
}
if( isset( $class::$containerFollowClasses ) )
{
foreach( $class::$containerFollowClasses as $followClass )
{
$containers[ $followClass ] = $followClass;
}
}
foreach( $containers as $container )
{
$containerArea = mb_strtolower( mb_substr( $container, mb_strrpos( $container, '\\' ) + 1 ) );
if( $containerArea == $this->area AND $class::$application == $this->app )
{
try
{
$followed = $container::load( $this->rel_id );
$name = $followed->_title;
$url = $followed->url();
}
catch( \OutOfRangeException $e )
{
/* If the item doesn't exist we may as well clean up core_follow */
parent::delete();
return NULL;
}
}
}
}
}
}
}
return array(
'followKey' => $this->id,
'followApp' => $this->app,
'followArea' => $this->area,
'followId' => $this->rel_id,
'followAnon' => (bool) $this->is_anon,
'followNotify' => (bool) $this->notify_do,
'followType' => $this->notify_do ? $this->notify_freq : NULL,
'followSent' => $this->notify_sent ? \IPS\DateTime::ts( $this->notify_sent )->rfc3339() : NULL,
'followName' => $name,
'followUrl' => (string) $url,
);
}
}