XF 2.2 PHP Callback Widget

[Lee]

Looking for some hand holding as it may be.

I want to create a widget with a PHP callback to run a query to select all the children of node "x".

Can someone help point me in the right direction?

Where do I create the file for callback? What is the appropriate way to run the query and display the results in the widget?

Thank you.

 

[Lee]

Not to worry, I have resolve this.

I maybe haven't implemented building the link to the node in the most graceful way, but it works for my application.

In my case, each node has a custom url portion so I have referenced the column node_name in my url and built the link that way.

Permissions are also not an issue as each node is visable to everybody.

For future reference, what would be the correct way to build the url and perform a permission check?

 

[Lee]

My PHP:

<?php

namespace HMH;

class GetCats
{
    public static function fetchcats(\XF\Pub\Controller\AbstractController $controller, \XF\Mvc\Reply\AbstractReply &$reply)
    {
        $db = \XF::db();

        $results = $db->fetchAll('
                SELECT *
                FROM `xf_node`
                WHERE parent_node_id = 55
                ORDER BY title ASC
        ');

$reply->setParam('results', $results);

    }
}

Then the pagenode:

    <xf:foreach loop="$results" value="$result">
           <a href="https://www.helpmindsheal.com/forums/{$result.node_name}">{$result.title|raw}</a><br />
    </xf:foreach>

 

[Lawrence]

If you use the finder, then most of what you need done will be done for you (permission checks, fetching child nodes, etc).

In your widget, something like this:

$node = $this->em()->find('XF:Node', 55);
$results = $this->repository('XF:Node')->getFullNodeList($node)->filterViewable()->toArray();

Notice the filterViewable(), that removes nodes members do not have the permission to view.

 

[Lee]

If you use the finder, then most of what you need done will be done for you (permission checks, fetching child nodes, etc).

In your widget, something like this:

$node = $this->em()->find('XF:Node', 55);
$results = $this->repository('XF:Node')->getFullNodeList($node)->filterViewable()->toArray();

Notice the filterViewable(), that removes nodes members do not have the permission to view.

Hi Lawrence, I have done something wrong I think - I get this error:

Error: Using $this when not in object context in src/addons/HMH/GetCats.php at line 9

1. HMH\GetCats::fetchcats()
2. call_user_func_array() in src/XF/Pub/Controller/Page.php at line 58
3. XF\Pub\Controller\Page->actionIndex() in src/XF/Mvc/Dispatcher.php at line 350
4. XF\Mvc\Dispatcher->dispatchClass() in src/XF/Mvc/Dispatcher.php at line 261
5. XF\Mvc\Dispatcher->dispatchFromMatch() in src/XF/Mvc/Dispatcher.php at line 113
6. XF\Mvc\Dispatcher->dispatchLoop() in src/XF/Mvc/Dispatcher.php at line 55
7. XF\Mvc\Dispatcher->run() in src/XF/App.php at line 2300
8. XF\App->run() in src/XF.php at line 464
9. XF::runApp() in index.php at line 20

<?php

namespace HMH;

class GetCats
{
public function fetchcats()
{
$node = $this->em()->find('XF:Node', 55);
$results = $this->repository('XF:Node')->getFullNodeList($node)->filterViewable()->toArray();
}
}

 

[Lawrence]

As you are making a widget, then you need to extend the AbstractWidget.

<?php

namespace HMH\Widget; // the file path in the addons folder to your widget

use XF\Widget\AbstractWidget;

class GetCats extends AbstractWidget
{
    protected $defaultOptions = [];
    
    public function render()
    {
        // here is where your code goes to fetch a node and their children

        $node = $this->em()->find('XF:Node', 55);
        $results = $this->repository('XF:Node')->getFullNodeList($node)->filterViewable()->toArray();

        $viewParams = [
            'results' => $results
        ];
        return $this->renderer('name_of_your_widget_template', $viewParams);
    }
    
    public function verifyOptions(\XF\Http\Request $request, array &$options, &$error = null)
    {
        // if your widgets have options you would verify them here
        return true;
    }
}

 

[Lee]

As you are making a widget, then you need to extend the AbstractWidget.

<?php

namespace HMH\Widget; // the file path in the addons folder to your widget

use XF\Widget\AbstractWidget;

class GetCats extends AbstractWidget
{
    protected $defaultOptions = [];
   
    public function render()
    {
        // here is where your code goes to fetch a node and their children

        $node = $this->em()->find('XF:Node', 55);
        $results = $this->repository('XF:Node')->getFullNodeList($node)->filterViewable()->toArray();

        $viewParams = [
            'results' => $results
        ];
        return $this->renderer('name_of_your_widget_template', $viewParams);
    }
   
    public function verifyOptions(\XF\Http\Request $request, array &$options, &$error = null)
    {
        // if your widgets have options you would verify them here
        return true;
    }
}

Thank you! I now have this in my file:

<?php

namespace HMH\Widget; // the file path in the addons folder to your widget

use XF\Widget\AbstractWidget;

class GetCats extends AbstractWidget
{
    protected $defaultOptions = [];
    
    public function render()
    {
        // here is where your code goes to fetch a node and their children

        $node = $this->em()->find('XF:Node', 55);
        $results = $this->repository('XF:Node')->getFullNodeList($node)->filterViewable()->toArray();

        $viewParams = [
            'results' => $results
        ];
        return $this->renderer('hmh_ams_cats', $viewParams);
    }
    
    public function verifyOptions(\XF\Http\Request $request, array &$options, &$error = null)
    {
        // if your widgets have options you would verify them here
        return true;
    }
}

When trying to create the PHP Callback Widget, it wont save. No error message, just nothing happpens at all pressing save.

 

[Lawrence]

Are you referring the save doesn't happen in the AdminCP when you are trying to save your widget?

 

[Lee]

Are you referring the save doesn't happen in the AdminCP when you are trying to save your widget?

Yes, sorry I should of been more clear.

 

[Lawrence]

Have you created a widget definition for your widget?

 

[Lee]

I was just trying to use the premade widget "PHP Callback Widget". Is that not appropriate?

 

[Lawrence]

I was just trying to use the premade widget "PHP Callback Widget". Is that not appropriate?

It's appropriate, I read the whole thread wrong, so my apologies. On the bright side, you now have a widget created and there is only a few steps left. If you still want to use the callback widget, let me know, and I'll take a look, as I haven't used that widget before.

 

[Lee]

It's appropriate, I read the whole thread wrong, so my apologies. On the bright side, you now have a widget created and there is only a few steps left. If you still want to use the callback widget, let me know, and I'll take a look, as I haven't used that widget before.

Thanks for your help Lawrence, I'll try creating a widget definition and see if I can figure out the rest.

 

[Lawrence]

Thanks for your help Lawrence, I'll try creating a widget definition and see if I can figure out the rest.

I got the callback widget to work, I'll post an example tomorrow,

 

[Lee]

Is it much of a change?

 

[Lee]

Have you created a widget definition for your widget?

This worked! Thank you Lawrence!

 

[Lawrence]

Is it much of a change?

a few little things, but overall not really

This worked! Thank you Lawrence!

Excellent!

 

[Lawrence]

Using the callback widget, finally,

The test widget I placed here: \src\addons. The only difference compared to the above is the data you need is retrieved through the $widget object:

<?php

class TestWidget
{
    public static function getCat(\XF\Widget\AbstractWidget $widget)
    {
        $node = $widget->app()->find('XF:Node', 10);
        $results = $widget->app()->repository('XF:Node')->getFullNodeList($node)->filterViewable()->toArray();

        $viewParams = [
            'node' => $node,
            'results' => $results
        ];   
        return $widget->renderer('category_test_widget', $viewParams);
    }
}

Then template category_test_widget just contains {{ dump($node) }} {{ dump($results) }} for testing and the result screen shot: