Which Controller to extend in lieu of XenForo_Abstract

[AndyB]

I have an add-on called Show Deleted, here's the code for version 1.0.

http://xenforo.com/community/threads/creating-the-add-on-show-deleted.60568/

Currently it extends XenForo_Abstract without using XFCP.

My understanding is that it's not possible to extend XenForo_Abstract using XFCP, so which Controller should I extend? Or should I just leave it as it is?

This add-on is called by entering the following URL from your browser:

http://www.site.com/forums/showdeleted/

 

[Chris D]

I can't see anything wrong with your code.

It's simple. There's two options:

1) Create a new route and create a new controller that extends XenForo_ControllerPublic_Abstract

If your board URL is http://xenforo.com/community and your new route is showdeleted, your URL will be http://xenforo.com/community/showdeleted.

2) Extend an existing controller using the XenForo Class Proxy system and load_class_controller code event.

<?php

class Your_Controller_Name extends XFCP_Your_Controller_Name

This allows you to either modify existing actions within that controller or add new actions to the controller.

If your board URL is http://xenforo.com/community and you are extending the forum controller, and you're adding a new action called actionShowDeleted then your URL will be http://xenforo.com/community/forums/forum-name.1/show-deleted

 

[AndyB]

Thank you, Chris.

So if I understand correctly, I should be able to extend XenForo_Abstract class as a XFCP?

<?php

class Andy_ShowDeleted_ControllerPublic_ShowDeleted extends XFCP_XenForo_ControllerPublic_Abstract
...

 

[Marcus]

class Andy_ShowDeleted_ControllerPublic_ShowDeleted extends XFCP_Andy_ShowDeleted_ControllerPublic_ShowDeleted

 

[Chris D]

What I'm trying to say, Andy, is your current code is fine. There should be no reason to change it.

 

[AndyB]

class Andy_ShowDeleted_ControllerPublic_ShowDeleted extends XFCP_Andy_ShowDeleted_ControllerPublic_ShowDeleted

Hi Marcus,

When I try that I get the following error:

An exception occurred: Cannot load class using XFCP. Load the class using the correct loader first. in /home/southbay/www/forums/library/XenForo/Autoloader.php on line 108

Listener.php

<?php

class Andy_ShowDeleted_Listener
{
    public static function showDeleted($class, array &$extend)
    {
        $extend[] = 'Andy_ShowDeleted_ControllerPublic_ShowDeleted';
    }
   
    public static function loadClassModel($class, array &$extend)
    {
        $extend[] = 'Andy_ShowDeleted_Model_DeletionLog';
    }   
}

?>

The Code Event Listener:



ShowDeleted.php

<?php

class Andy_ShowDeleted_ControllerPublic_ShowDeleted extends XFCP_Andy_ShowDeleted_ControllerPublic_ShowDeleted
{	
	public function actionIndex()
	{	
...

 

[AndyB]

What I'm trying to say, Andy, is your current code is fine. There should be no reason to change it.

It's looking that way. So in this situation not using XFCP is fine?

 

[Chris D]

Yeah. But the key thing is, do you understand why?

I can't see anything wrong with your code.

It's simple. There's two options:

1) Create a new route and create a new controller that extends XenForo_ControllerPublic_Abstract

If your board URL is http://xenforo.com/community and your new route is showdeleted, your URL will be http://xenforo.com/community/showdeleted.

2) Extend an existing controller using the XenForo Class Proxy system and load_class_controller code event.

<?php

class Your_Controller_Name extends XFCP_Your_Controller_Name

This allows you to either modify existing actions within that controller or add new actions to the controller.

If your board URL is http://xenforo.com/community and you are extending the forum controller, and you're adding a new action called actionShowDeleted then your URL will be http://xenforo.com/community/forums/forum-name.1/show-deleted

 

[AndyB]

Yeah. But the key thing is, do you understand why?

You are reading my mind.

If I were to guess it has something to do with this add-on not extending any existing class that another add-on might also be extending.

 

[Daniel Hood]

Extending default XenForo files = use Proxy System
Making new files (custom datawriter, model, controller) = don't

 

[AndyB]

Thank you, Daniel.

It's wonderful when things are explained. Now it makes perfect sense.