Show:

Streams lookup Class

Defined in: platform/plugins/Streams/handlers/Streams/lookup/tool.php:3
Module: Streams

Lets the user search for streams they can lookup a given stream to, and lookup it

Constructor

Streams lookup

(
  • [$options]
  • $publisherId
  • $streamName
  • [$communityId=Users::communityId()]
  • [$types=Q_Config::expect('Streams','lookup','types')]
  • [$typeNames]
  • [$types=Q_Config::expect('Streams','lookup','types')]
)

Defined in platform/plugins/Streams/handlers/Streams/lookup/tool.php:3

Parameters:

  • [$options] Array optional

    Override various options for this tool

  • $publisherId String

    publisher id of the stream to lookup

  • $streamName String

    name of stream to lookup

  • [$communityId=Users::communityId()] String optional

    id of the user publishing the streams to lookup to

  • [$types=Q_Config::expect('Streams','lookup','types')] Array optional

    the types of streams the user can select

  • [$typeNames] Array optional

    pairs of array($type => $typeName) to override names of the types, which would otherwise be taken from the types

  • [$types=Q_Config::expect('Streams','lookup','types')] String optional

    the types of streams the user can select

Item Index