Congegni/sintonia
7
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

SAAS-940: Provide usability hints to user

Browse source 
Customized hints depending on what page the user is on and what action
they just completed.
This commit is contained in:
drigato 2015-07-13 17:02:31 -04:00
parent 48547ee347
commit 25ef70767b
7 changed files with 131 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

83
airtime_mvc/application/common/UsabilityHints.php
View file

@ -2,6 +2,86 @@
class Application_Common_UsabilityHints
{
/**
* @param $userPath User's current location in Airtime (i.e. /Plupload)
* @return string
*/
public static function getUsabilityHint($userPath=null)
{
// We want to display hints in this order:
// 1. Check if files are uploaded
// 2. Check if a show is scheduled
// 3. Check if scheduled show needs content
// Once the user is on the page linked to from the hint we want to
// display a new message further describing what to do. Once this
// action has been done we can hide the message and get the next
// usability hint, if there is one.
$userIsOnCalendarPage = false;
$userIsOnAddMediaPage = false;
// If $userPath is set the request came from AJAX so the user's
// current location inside Airtime gets passed in to this function.
if (!is_null($userPath)) {
// We check if the controller names are in the user's current location
// so we can ignore leading or trailing slashes, special characters like '#',
// and additional controller action names like '/user/add-user'
if (strpos(strtolower($userPath), 'plupload') !== false) {
$userIsOnAddMediaPage = true;
}
if (strpos(strtolower($userPath), 'schedule') !== false) {
$userIsOnCalendarPage = true;
}
} else {
// If $userPath is not set the request came from inside Airtime so
// we can use Zend's Front Controller to get the user's current location.
$currentController = strtolower(Zend_Controller_Front::getInstance()->getRequest()->getControllerName());
if ($currentController == "schedule") {
$userIsOnCalendarPage = true;
}
if ($currentController == "plupload") {
$userIsOnAddMediaPage = true;
}
}
if (self::zeroFilesUploaded()) {
if ($userIsOnAddMediaPage) {
return _("Click the 'Add files' button and select files from your computer to upload.");
} else {
return sprintf(_("It looks like you have not uploaded any audio files yet. %sUpload a file now.%s "),
"<a href=\"/plupload\">",
"</a>");
}
} else if (!self::isFutureOrCurrentShowScheduled()) {
if ($userIsOnCalendarPage) {
return _("Click the 'Create New Show' button and fill out the required fields.");
} else {
return sprintf(_("It looks like you don't have any shows scheduled. %sCreate a show now.%s"),
"<a href=\"/schedule\">",
"</a>");
}
} else if (self::isCurrentOrNextShowEmpty()) {
if ($userIsOnCalendarPage) {
return _("To start broadcasting click on your show and select 'Add / Remove Content'");
} else {
//TODO: break this into two functions (current and next) so message is more clear
return sprintf(_("It looks like your show is empty. %sAdd tracks to your show now.%s"),
"<a href=\"/schedule\">",
"</a>");
}
} else {
return "";
}
}
//TODO: make functions below private?
/**
* Returns true if no files have been uploaded.
*/
@ -48,9 +128,11 @@ class Application_Common_UsabilityHints
if (is_null($futureShow) && is_null($currentShow)) {
return false;
} else {
$now = new DateTime("now", new DateTimeZone("UTC"));
if ($currentShow) {
$scheduledTracks = CcScheduleQuery::create()
->filterByDbInstanceId($currentShow->getDbId())
->filterByDbEnds($now, Criteria::GREATER_EQUAL)
->find();
if ($scheduledTracks->count() == 0) {
return true;
@ -58,6 +140,7 @@ class Application_Common_UsabilityHints
} else if ($futureShow) {
$scheduledTracks = CcScheduleQuery::create()
->filterByDbInstanceId($futureShow->getDbId())
->filterByDbStarts($now, Criteria::GREATER_EQUAL)
->find();
if ($scheduledTracks->count() == 0) {
return true;