Tell if user logged in to edit/dashboard in Concrete5 from block

Question

I'm writing a block and want to be able to tell if the user is logged in to the dashboard when the block is being viewed. I'm imagining there should be something like isAdminArea() or isEditing() but haven't been able to find it on my own accord so far!

Answer 1

If you're using Concrete5.6.0 or higher, you can do this:

global $cp;
$canViewToolbar = (isset($cp) && is_object($cp) && $cp->canViewToolbar());
if ($canViewToolbar) {
    //do something...
}

If you're doing this in a theme template or block view, you can leave out a lot of that junk and just do this:

global $cp;
if ($cp->canViewToolbar()) {
    //do something...
}

But if you're doing this in a package controller or during a system event, you'll want to use my first example (to make sure the global "Collection Permissions" object exists).

If you're running a version of Concrete5 that's older than 5.6, use this code:

global $cp;
$canViewToolbar = (isset($cp) && ($cp->canWrite() || $cp->canAddSubContent() || $cp->canAdminPage() || $cp->canApproveCollection()));
if ($canViewToolbar) {
    //do something...
}

Answer 2

To improve on the above: whilst global is a valid construct in PHP, it's use really should be avoided. It's lazy and dangerous. The correct way to access the active permission model in the C5 architecture is

$cp = new Permissions(Page::getCurrentPage());

if ($cp->canViewToolbar()) {
  ...
}