2017 © Pedro Peláez
 

claroline-plugin tag-bundle

Claroline tag plugin

image

claroline/tag-bundle

Claroline tag plugin

  • Monday, May 30, 2016
  • by claroline
  • Repository
  • 5 Watchers
  • 0 Stars
  • 444 Installations
  • PHP
  • 1 Dependents
  • 0 Suggesters
  • 2 Forks
  • 0 Open issues
  • 5 Versions
  • 0 % Grown

The README.md

TagBundle

WARNING

DEVELOPMENT HAS MOVED TO claroline/Distribution. THIS REPOSITORY IS NO LONGER MAINTAINED., (*1)

#

HOW TO TAG AN ENTITY

#

To tag an Object, a "Claroline\CoreBundle\Event\GenericDatasEvent" event has to be dispatched. Event name must be "claroline_tag_object". Event "datas" field must be an array defined as followed :, (*2)

array ( 'tag' => [String], // Name of the tag 'object' => [Any entity], // Object that has to be tagged 'user' => [User] // Optional. Owner of the tag. NULL by default. ), (*3)

Here is an example of a call from a controller function to tag a workspace with "My Tags" :, (*4)

*******************************************************************
    $datas = array('tag' => 'My Tags', 'object' => $workspace);

    $this->get('claroline.event.event_dispatcher')->dispatch(
        'claroline_tag_object',
        'GenericDatas',
        array($datas)
    );
*******************************************************************

OR

*******************************************************************
    $datas = array('tag' => 'My Tags', 'object' => $workspace);
    $event = new GenericDatasEvent();
    $event->setDatas($datas);

    $this->get('event_dispatcher')->dispatch(
        'claroline_tag_object',
        $event
    );
*******************************************************************
#

HOW TO FETCH TAGGED OBJECTS

#

To fetch tagged objects, a "Claroline\CoreBundle\Event\GenericDatasEvent" event has also to be dispatched. Event name must be "claroline_retrieve_tagged_objects". Event "datas" field must be an array defined as followed :, (*5)

array ( 'tag' => [String], // Name of the tag 'user' => [User] // Optional. Owner of the tag. NULL by default. 'with_platform' => [Boolean] // Optional. Define if platform tags have to be considered too when user option is defined. False by default. 'strict' => [Boolean] // Optional. Define if the tag option has to be completely or partially matched. False by default. 'class' => [String] // Optional. Class of the desired fetched objects. If used, only objects of that class will be fetched. NULL by default. 'object_response' => [Boolean] // Optional. Define if returned values are casted to class option. If not, it is simply an array of values. False by default. 'class' option is required. 'ordered_by' => [String] // Optional. Field to order. Define order of casted returned objects. 'id' by default. 'class' option is required. 'order' => [String] // Optional. Order. Define order of casted returned objects. 'ASC' by default. 'class' option is required. ), (*6)

Here is an example to fetch all workspaces tagged as "My Tags", ordered by name :, (*7)

**************************************************************************
    $datas = array(
        'tag' => 'My Tags',
        'strict' => true,
        'class' => 'Claroline\CoreBundle\Entity\Workspace\Workspace',
        'object_response' => true,
        'ordered_by' => 'name',
        'order' => 'ASC'
    );

    $event = $this->get('claroline.event.event_dispatcher')->dispatch(
        'claroline_retrieve_tagged_objects',
        'GenericDatas',
        array($datas)
    );

    $workspaces = $event->getResponse();
**************************************************************************

If 'class' option is not defined or 'object_response' is not true, the response value is an array defined as followed :, (*8)

array( array( 'class' => 'Claroline\CoreBundle\Entity\Workspace\Workspace', 'id' => 45, 'name' => 'Workspace ABC' ), array( 'class' => 'Claroline\CoreBundle\Entity\Workspace\Workspace', 'id' => 74, 'name' => 'Workspace XYZ' ), array( 'class' => 'Claroline\CoreBundle\Entity\User', 'id' => 11, 'name' => 'John DOE' ), ... ), (*9)

The Versions

30/05 2016

dev-master

9999999-dev http://www.claroline.net

Claroline tag plugin

  Sources   Download

GPL-3.0+

The Requires

 

plugin tag claroline

03/02 2016

6.0.3

6.0.3.0 http://www.claroline.net

Claroline tag plugin

  Sources   Download

GPL-3.0+

The Requires

 

plugin tag claroline

30/09 2015

6.0.2

6.0.2.0 http://www.claroline.net

Claroline tag plugin

  Sources   Download

GPL-3.0+

The Requires

 

plugin tag claroline

28/09 2015

6.0.1

6.0.1.0 http://www.claroline.net

Claroline tag plugin

  Sources   Download

GPL-3.0+

The Requires

 

plugin tag claroline

25/09 2015

6.0.0

6.0.0.0 http://www.claroline.net

Claroline tag plugin

  Sources   Download

GPL-3.0+

The Requires

 

plugin tag claroline