XF 2.1 How to detect if an add-on is installed

[Matt C.]

Can you detect if an add-on is installed in the template system?

Thank you

 

[DragonByte Tech]

This is how to do it in PHP:

$addOns = \XF::app()->container('addon.cache');
if (array_key_exists('Some/Id', $addOns) && $addOns['Some/Id'] >= 1010031)
{
    // Your code goes here
}

I'm not 100% sure if this is possible in the templates, but I don't think so since template functions have to have a prefix like "get", "is", "has" (implying only checking or fetching data, not writing data. Security reasons and all.)

A workaround would be for you to create an AddOn repository where you could create a method like

public function hasAddOn($addOnId, $atLeastVersion = null)
{
    $addOns = \XF::app()->container('addon.cache');
    if (!array_key_exists($addOnId, $addOns))
    {
        return false;
    }

    if ($atLeastVersion !== null && $addOns[$addOnId] < $atLeastVersion)
    {
        return false;
    }

    return true;
}

Then use the following in your template code:

<xf:set var="$addOnRepo" value="{{ $xf.app.em.getRepository('MattC\SomeAddon:AddOn') }}" />
<xf:if is="$addOnRepo.hasAddOn('Some/Id', 1010031)">
    AddOn "Some/Id" is installed and at least version 1.1.0 Beta 1
</xf:if>

There may be a built-in method for this that I'm not aware of but I couldn't find one from a brief search.

(Edit: Just a wee note to clarify that the forward slashes are intended here, though normally you refer to add-on IDs with backslashes like in the getRepository call. The addon.cache container stores add-on IDs with forward slashes, so that's what we must use.)

Hope this helps!


Fillip

 

[Matt C.]

Thank you @DragonByte Tech, that worked perfectly.

<xf:if is="$addOnRepo.hasAddOn('XFRM', 100030)">
&[data-nav-id="xfrm"]::before
{
    content: @fa-var-{$xf.options.ahfaMNResources};
}
</xf:if>

 

[Lukas W.]

is_addon_active('your/addon')

 

[DragonByte Tech]

is_addon_active('your/addon')

TIL. Thanks!


Fillip

 

[SyTry]

This is how to do it in PHP:

$addOns = \XF::app()->container('addon.cache');
if (array_key_exists('Some/Id', $addOns) && $addOns['Some/Id'] >= 1010031)
{
    // Your code goes here
}

I'm not 100% sure if this is possible in the templates, but I don't think so since template functions have to have a prefix like "get", "is", "has" (implying only checking or fetching data, not writing data. Security reasons and all.)

A workaround would be for you to create an AddOn repository where you could create a method like

public function hasAddOn($addOnId, $atLeastVersion = null)
{
    $addOns = \XF::app()->container('addon.cache');
    if (!array_key_exists($addOnId, $addOns))
    {
        return false;
    }

    if ($atLeastVersion !== null && $addOns[$addOnId] < $atLeastVersion)
    {
        return false;
    }

    return true;
}

Then use the following in your template code:

<xf:set var="$addOnRepo" value="{{ $xf.app.em.getRepository('MattC\SomeAddon:AddOn') }}" />
<xf:if is="$addOnRepo.hasAddOn('Some/Id', 1010031)">
    AddOn "Some/Id" is installed and at least version 1.1.0 Beta 1
</xf:if>

There may be a built-in method for this that I'm not aware of but I couldn't find one from a brief search.

(Edit: Just a wee note to clarify that the forward slashes are intended here, though normally you refer to add-on IDs with backslashes like in the getRepository call. The addon.cache container stores add-on IDs with forward slashes, so that's what we must use.)

Hope this helps!


Fillip

Hello,

I have an add-on that add the number of resources/media/albums but if you don't have XFMG & XFRM it didn't work. So how to make a condition in PHP ? I tried this one :

        $activeAddons = \XF::app()->container('addon.cache');

        if (array_key_exists('XFRM', $activeAddons))
        {
            $forumResources = $this->db()->fetchOne("
            SELECT COUNT(resource_id)
            FROM xf_rm_resource
            ");
        }

But it doesn't work either, thank you !

Regards, SyTry

EDIT : solved :

XF 2.0 - Extending AddOn classes

I have some code that needs to run on install of certain other add-ons, and am trying to find the best class to extend to accomplish this. From what I can tell \XF\Addon\AddOn isn't run through XFCP so I can't extend that, and same goes for the Setup classes for each add-on. I even tried...

xenforo.com