Skip to content

Latest commit

 

History

History
101 lines (71 loc) · 2.86 KB

03-usage.md

File metadata and controls

101 lines (71 loc) · 2.86 KB
Raw

Usage – Tags Bundle

  1. Installation
  2. Configuration
  3. Usage
  4. Managers
  5. Backend interface
  6. Insert tags

Usage

The defined managers can be injected like any other services into your classes:

# services.yml
services:
    App\MyService:
        arguments:
            - '@codefog_tags.manager.my_manager'

Then simply assign it to the class property and you are good to go:

<?php

namespace App;

use Codefog\TagsBundle\Manager\DefaultManager;

class MyService
{
    private $tagsManager;

    public function __construct(DefaultManager $tagsManager)
    {
        $this->tagsManager = $tagsManager;    
    }
}

Finding the source records

The source records can be obtained using the SourceFinder service obtained from the tag manager. The default service does not know what kind of records you are expecting, so by default it always returns the source record IDs.

use Codefog\TagsBundle\Tag;

// Set some dummy criteria
$criteria = $this->tagsManager->createSourceCriteria()->setTag(new Tag(123, 'foobar'));

// Get total number of records
$this->tagsManager->getSourceFinder()->count($criteria);

// Find the source record IDs with tag values/IDs 123 and 456
$this->tagsManager->getSourceFinder()->findMultiple($criteria->setTagValues([123, 456]));

// Find the source record IDs related to IDs set in criteria (e.g. 1, 2, 3) 
$this->tagsManager->getSourceFinder()->findRelatedSourceRecords($criteria->setIds([1, 2, 3]));

Finding the tag records

The tags can be obtained using the TagFinder service obtained from the tag manager.

// Set some dummy criteria
$criteria = $this->tagsManager->createTagCriteria()->setSourceIds([1, 2, 3]);

// Get total number of tags
$this->tagsManager->getTagFinder()->count($criteria);

// Find multiple tags
$this->tagsManager->getTagFinder()->findMultiple($criteria);

// Find multiple tags in the exact order (useful in combination with backend manual sorting)
$this->tagsManager->getTagFinder()->findMultiple($criteria->setOrder(\Contao\Database::getInstance()->findInSet('id', [3, 2, 1])));

// Find top 5 tags with count data ($tag->getData()['count'])
$this->tagsManager->getTagFinder()->getTopTags($criteria, 5, true);

// Find the top 10 tag IDs 
$this->tagsManager->getTagFinder()->getTopTagIds($criteria, 10, true);

// Find a single tag with 123 value/ID
$this->tagsManager->getTagFinder()->findSingle($criteria->setValue(123));

Note on multiple sources

If you defined multiple sources for a tag manager, you may need to explicitly define the source which you will fetch the data from:

// Tag criteria
$criteria = $this->tagsManager->createTagCriteria('tl_table_1.tags');

// Source criteria
$criteria = $this->tagsManager->createSourceCriteria('tl_table_2.tags');