Page MenuHomeWickedGov Phorge
Files F5973411

CNDeviceTarget.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

CNDeviceTarget.php
View Options

<?php
/**
* Manages device targeting for CentralNotice banners
*/
class CNDeviceTarget {
/**
* Get a listing of all known targetable devices.
*
* @param bool $flip If true will return
* {<header string value>: {'id': <id>, 'label': <wiki text label>}}
*
* @return array[] Array of devices in format
* {id: {'header': <internal string value>, 'label': <wiki text label>}}
*/
public static function getAvailableDevices( $flip = false ) {
$dbr = CNDatabase::getDb();
$devices = [];
$res = $dbr->newSelectQueryBuilder()
->select( [ 'dev_id', 'dev_name', 'dev_display_label' ] )
->from( 'cn_known_devices' )
->caller( __METHOD__ )
->fetchResultSet();
foreach ( $res as $row ) {
if ( $flip ) {
$devices[ $row->dev_name ] = [
'label' => $row->dev_display_label,
'id' => intval( $row->dev_id ),
];
} else {
$devices[ intval( $row->dev_id ) ] = [
'header' => $row->dev_name,
'label' => $row->dev_display_label,
];
}
}
return $devices;
}
/**
* Obtain all device IDs associated with a given banner ID
*
* @param int $bannerId
*
* @return array Device names that are associated with the banner
*/
public static function getDevicesAssociatedWithBanner( $bannerId ) {
$dbr = CNDatabase::getDb();
$devices = [];
$res = $dbr->newSelectQueryBuilder()
->select( [ 'devices.dev_id', 'dev_name' ] )
->from( 'cn_template_devices', 'tdev' )
->join( 'cn_known_devices', 'devices', 'tdev.dev_id = devices.dev_id' )
->where( [
'tdev.tmp_id' => $bannerId,
] )
->caller( __METHOD__ )
->fetchResultSet();
foreach ( $res as $row ) {
$devices[ intval( $row->dev_id ) ] = $row->dev_name;
}
return $devices;
}
/**
* Add a new device target to the database
*
* @param string $deviceName Name of the device as sent by the controller (read: MobileFrontEnd)
* @param string $displayLabel Friendly wikitext name of the device
* @return int The ID of the device added
*/
public static function addDeviceTarget( $deviceName, $displayLabel ) {
$db = CNDatabase::getDb( DB_PRIMARY );
$db->newInsertQueryBuilder()
->insertInto( 'cn_known_devices' )
->row( [
'dev_name' => $deviceName,
'dev_display_label' => $displayLabel
] )
->caller( __METHOD__ )
->execute();
return $db->insertId();
}
/**
* Sets the associated devices with a banner
*
* @param int $bannerId Banner ID to modify
* @param string|array $newDevices Single name, or array of names, of devices that should be
* associated with a banner
* @throws RangeException
*
* FIXME Unused, remove
*/
public static function setBannerDeviceTargets( $bannerId, $newDevices ) {
$db = CNDatabase::getDb();
$knownDevices = self::getAvailableDevices( true );
$newDevices = (array)$newDevices;
// Remove all entries from the table for this banner
$db->newDeleteQueryBuilder()
->deleteFrom( 'cn_template_devices' )
->where( [ 'tmp_id' => $bannerId ] )
->caller( __METHOD__ )
->execute();
// Add the new device mappings
if ( $newDevices ) {
$modifyArray = [];
foreach ( $newDevices as $device ) {
if ( !array_key_exists( $device, $knownDevices ) ) {
throw new RangeException( "Device name '$device' not known! Cannot add." );
}
$modifyArray[] = [
'tmp_id' => $bannerId,
'dev_id' => $knownDevices[$device]['id']
];
}
$db->newInsertQueryBuilder()
->insertInto( 'cn_template_devices' )
->rows( $modifyArray )
->caller( __METHOD__ )
->execute();
}
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 16:36 (15 h, 8 m ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
ce/e3/e476cd1e760a9427eec0d9e5a62f
Default Alt Text
CNDeviceTarget.php (3 KB)

Event Timeline