220 lines
6.4 KiB
PHP
220 lines
6.4 KiB
PHP
<?php
|
|
/**
|
|
* @brief Warning Reason Node
|
|
* @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 23 Apr 2013
|
|
*/
|
|
|
|
namespace IPS\core\Warnings;
|
|
|
|
/* To prevent PHP errors (extending class does not exist) revealing path */
|
|
|
|
use IPS\Db;
|
|
use IPS\File;
|
|
use IPS\Helpers\Form;
|
|
use IPS\Helpers\Form\Custom;
|
|
use IPS\Helpers\Form\Editor;
|
|
use IPS\Helpers\Form\Number;
|
|
use IPS\Helpers\Form\Translatable;
|
|
use IPS\Helpers\Form\YesNo;
|
|
use IPS\Lang;
|
|
use IPS\Member;
|
|
use IPS\Node\Model;
|
|
use IPS\Theme;
|
|
use function defined;
|
|
|
|
if ( !defined( '\IPS\SUITE_UNIQUE_KEY' ) )
|
|
{
|
|
header( ( $_SERVER['SERVER_PROTOCOL'] ?? 'HTTP/1.0' ) . ' 403 Forbidden' );
|
|
exit;
|
|
}
|
|
|
|
/**
|
|
* Warning Reason Node
|
|
*/
|
|
class Reason extends Model
|
|
{
|
|
/**
|
|
* @brief [ActiveRecord] Multiton Store
|
|
*/
|
|
protected static array $multitons;
|
|
|
|
/**
|
|
* @brief [ActiveRecord] Database Table
|
|
*/
|
|
public static ?string $databaseTable = 'core_members_warn_reasons';
|
|
|
|
/**
|
|
* @brief [ActiveRecord] Database Prefix
|
|
*/
|
|
public static string $databasePrefix = 'wr_';
|
|
|
|
/**
|
|
* @brief [ActiveRecord] ID Database Column
|
|
*/
|
|
public static string $databaseColumnId = 'id';
|
|
|
|
/**
|
|
* @brief [Node] Order Database Column
|
|
*/
|
|
public static ?string $databaseColumnOrder = 'order';
|
|
|
|
/**
|
|
* @brief [Node] Node Title
|
|
*/
|
|
public static string $nodeTitle = 'warn_reasons';
|
|
|
|
/**
|
|
* @brief [Node] Show forms modally?
|
|
*/
|
|
public static bool $modalForms = TRUE;
|
|
|
|
/**
|
|
* @brief [Node] ACP Restrictions
|
|
*/
|
|
protected static ?array $restrictions = array(
|
|
'app' => 'core',
|
|
'module' => 'moderation',
|
|
'prefix' => 'reasons_',
|
|
);
|
|
|
|
/**
|
|
* @brief [Node] Title prefix. If specified, will look for a language key with "{$key}_title" as the key
|
|
*/
|
|
public static ?string $titleLangPrefix = 'core_warn_reason_';
|
|
|
|
/**
|
|
* [Node] Add/Edit Form
|
|
*
|
|
* @param Form $form The form
|
|
* @return void
|
|
*/
|
|
public function form( Form &$form ) : void
|
|
{
|
|
$form->add( new Translatable( 'wr_name', NULL, TRUE, array( 'app' => 'core', 'key' => ( $this->id ? "core_warn_reason_{$this->id}" : NULL ) ) ) );
|
|
$form->add( new Number( 'wr_points', $this->id ? $this->points : 0, TRUE ) );
|
|
$form->add( new YesNo( 'wr_points_override', $this->id ? $this->points_override : TRUE ) );
|
|
$form->add( new Custom( 'wr_remove', $this->id ? array( $this->remove, $this->remove_unit ) : NULL, FALSE, array(
|
|
'getHtml' => function( $element )
|
|
{
|
|
return Theme::i()->getTemplate( 'members' )->warningTime( $element->name, $element->value, 'after', 'never' );
|
|
}
|
|
, 'unlimited' => -1, 'unlimitedLang' => 'never'
|
|
) ) );
|
|
$form->add( new YesNo( 'wr_remove_override', $this->id ? $this->remove_override : TRUE ) );
|
|
$form->add( new Number( 'wr_cheev_point_reduction', $this->cheev_point_reduction ? $this->cheev_point_reduction : 0 ) );
|
|
$form->add( new YesNo( 'wr_cheev_override', $this->id ? $this->remove_override : TRUE ) );
|
|
$form->add( new Editor( 'wr_notes', $this->id ? $this->notes : NULL, FALSE, array( 'app' => 'core', 'key' => 'Modcp', 'autoSaveKey' => "warn-member-default", 'attachIds' => ( $this->id ? array( $this->id, NULL, 'warndefault' ) : NULL ), 'minimize' => 'warn_member_note_placeholder' ) ) );
|
|
}
|
|
|
|
/**
|
|
* [Node] Format form values from add/edit form for save
|
|
*
|
|
* @param array $values Values from the form
|
|
* @return array
|
|
*/
|
|
public function formatFormValues( array $values ): array
|
|
{
|
|
if( isset( $values['wr_remove'] ) )
|
|
{
|
|
if( isset( $values['wr_remove'][3] ) or $values['wr_remove'][0] < 1 )
|
|
{
|
|
$values['remove'] = -1;
|
|
}
|
|
else
|
|
{
|
|
$values['remove'] = (int) $values['wr_remove'][0];
|
|
$values['remove_unit'] = $values['wr_remove'][1];
|
|
}
|
|
unset( $values['wr_remove'] );
|
|
}
|
|
|
|
if( !$this->id )
|
|
{
|
|
$values['order'] = 0;
|
|
$this->save();
|
|
}
|
|
|
|
if( isset( $values['wr_name'] ) )
|
|
{
|
|
Lang::saveCustom( 'core', "core_warn_reason_{$this->id}", $values['wr_name'] );
|
|
unset( $values['wr_name'] );
|
|
}
|
|
|
|
foreach( $values as $k => $v )
|
|
{
|
|
if( mb_substr( $k, 0, 3 ) === 'wr_' )
|
|
{
|
|
unset( $values[ $k ] );
|
|
$values[ mb_substr( $k, 3 ) ] = $v;
|
|
}
|
|
}
|
|
|
|
return $values;
|
|
}
|
|
|
|
/**
|
|
* [Node] Perform actions after saving the form
|
|
*
|
|
* @param array $values Values from the form
|
|
* @return void
|
|
*/
|
|
public function postSaveForm( array $values ) : void
|
|
{
|
|
File::claimAttachments( "warn-member-default", $this->id, NULL, 'warndefault' );
|
|
}
|
|
|
|
/**
|
|
* [Node] Does the currently logged in user have permission to add a child node to this node?
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function canAdd(): bool
|
|
{
|
|
return FALSE;
|
|
}
|
|
|
|
/**
|
|
* [ActiveRecord] Delete Record
|
|
*
|
|
* @return void
|
|
*/
|
|
public function delete(): void
|
|
{
|
|
File::unclaimAttachments( "warn-member-default", $this->id, NULL, 'warndefault' );
|
|
Db::i()->update( 'core_members_warn_logs', array( 'wl_reason' => 0 ), array( "wl_reason=?", $this->id ) );
|
|
|
|
parent::delete();
|
|
}
|
|
|
|
/**
|
|
* Get output for API
|
|
*
|
|
* @param Member|NULL $authorizedMember The member making the API request or NULL for API Key / client_credentials
|
|
* @return array
|
|
* @apiresponse int id ID number
|
|
* @apiresponse string name Warn reason name
|
|
* @apiresponse string defaultNotes Default notes for warning (moderator can override)
|
|
* @apiresponse int points The warning points levied with the warning
|
|
* @apiresponse bool pointsOverride Whether the moderator can override the default points or not
|
|
* @apiresponse bool removeOverride Whether the moderator can override when the points will be removed or not
|
|
* @apiresponse string|null removePoints Time frame as a date interval when points will automatically be removed, or null if points do not automatically remove
|
|
* @apiresponse bool pointsAutoRemove Whether points are automatically removed or not
|
|
*/
|
|
public function apiOutput( Member $authorizedMember = NULL ): array
|
|
{
|
|
return array(
|
|
'id' => $this->id,
|
|
'name' => $this->_title,
|
|
'defaultNotes' => $this->notes,
|
|
'points' => (int) $this->points,
|
|
'pointsOverride' => (bool) $this->points_override,
|
|
'pointsAutoRemove' => !( $this->remove AND $this->remove == -1 ),
|
|
'removePoints' => ( $this->remove AND $this->remove != -1 ) ? 'P' . ( ( $this->remove_unit == 'h' ) ? 'T' : '' ) . $this->remove . mb_strtoupper( $this->remove_unit ) : NULL,
|
|
'removeOverride' => (bool) $this->remove_override
|
|
);
|
|
}
|
|
} |