aerisnet/fiesta-online-bundle

This bundle eases the development to Fiesta Online Homepages

v1.0.1 2021-08-06 11:41 UTC

Requires

• php: >=7.2.5
• doctrine/annotations: ^1.0
• doctrine/doctrine-bundle: ^2.2
• doctrine/doctrine-migrations-bundle: ^3.0
• doctrine/orm: ^2.8

MIT

• Daniel Engelke

README

A Symfony 4+ Bundle for Fiesta Online web projects

Basic Information

This bundle includes all most relevant Entities and Managers needed to create a basic Fiesta Online homepage.

Installation for Symfony 4 & 5

The bundle is available via packagist to directly integrate into your application

1. Go into your root directory of your project
2. Run composer require aerisnet/fiesta-online-bundle
3. To use the included Entities with your application, you have to refer to the bundle entities in your doctrine configuration. An example mapping can be found below

dbal:
    connections:
        character:
            url: '%env(resolve:CHARACTER_URL)%'
            driver: 'pdo_sqlsrv'
            charset: UTF-8
...

orm:
    entity_managers:
        character:
            connection: character
            mappings:
                Character:
                type: annotation
                dir: '%kernel.project_dir%/vendor/aeris/fiesta-online-bundle/src/Entity/Character'
                prefix: 'Aeris\FiestaOnlineBundle\Entity\Character'
                alias: Character

Examples

Account Manager

public function indexAction(AccountManager $accountManager)
{
    /** 
     * @var User $user 
     * returns a User instance or null by the given Account ID
     */
    $user = $accountManager->getAccountById(5);
    ...
    
    /** 
     * @var User[] $user 
     * returns all accounts
     */
    $user = $accountManager->getAllAccounts();
    ...
    
    /**
     * @var User $user
     * returns a User instance with all characters belonging to the account as Proxy objects
     */
    $user = $accountManager->getAccountWithCharacters(5);
}

Character Manager

public function indexAction(CharacterManager $characterManager)
{
    /** 
     * @var Character $character 
     * returns a Character instance or null by the given Character ID
     */
    $character = $characterManager->getCharacterById(123);
    ...
    
    /** 
     * @var Character $character 
     * returns a Character instance or null by the given Character Name
     */
    $character = $characterManager->getCharacterByName('Visionaire');
    ...
    
    /**
     * Check if a character has an item in their inventory
     * Parameters are Character ID and Item ID
     */
    $hasItem = $characterManager->hasItemInInventory($character->getId(), 385782);
}