The Repository folder

[Redaktor]

Maybe this is where we should start before creating any add-on for XenForo, but each in their own way. Here I will try to collect information about what each folder in the Xenforo add-ons is for, if I have missed any, please share.

What is the Repository folder for in xenforo add-ons?​

In XenForo, the Repository folder in the addons structure is typically used to store classes that contain the business logic or database interaction for a specific data type. This is part of the XenForo architectural model and helps organize the code.

1. Database query management:
   • Classes in this folder often contain methods for retrieving, filtering, or modifying data from the database.
   • For example: retrieving a list of topics, users, or other objects.
2. Centralization of business logic:
   • Instead of logic being scattered across different controllers, models, or other classes, it is centralized in Repository classes.
   • This makes code reuse easier and improves readability.
3. Structure and standard:
   • XenForo encourages the use of Repository classes for data management to maintain a good coding standard.
   • This makes it easier to integrate new features and support add-ons.

If you are creating a news display plugin, you might have a class in the Repository that looks like this:

namespace YourAddon\Repository;

use XF\Mvc\Entity\Repository;

class News extends Repository
{
    public function getLatestNews($limit = 5)
    {
        return $this->finder('YourAddon:News')
            ->order('publish_date', 'DESC')
            ->limit($limit)
            ->fetch();
    }
}

Usage:​

This Repository class can be called from another class, for example a controller or cron job:

$newsRepo = \XF::repository('YourAddon:News');
$latestNews = $newsRepo->getLatestNews(10);

The Repository folder in XenForo add-ons is used to organize the code that deals with data management and business logic. It makes it easier to work with the database, centralize logic, and maintain add-ons.