interface ChannelManipulatorInterface in Entity Share 8.2

Channel manipulators interface methods.

Hierarchy

• interface \Drupal\entity_share_server\Service\ChannelManipulatorInterface

File

modules/entity_share_server/src/Service/ChannelManipulatorInterface.php, line 12

Namespace

Drupal\entity_share_server\Service

interface ChannelManipulatorInterface {

  /**
   * Generate URL query.
   *
   * @param \Drupal\entity_share_server\Entity\ChannelInterface $channel
   *   The channel entity.
   *
   * @return array
   *   The query options to use to request JSON:API.
   */
  public function getQuery(ChannelInterface $channel);

  /**
   * Get field mapping.
   *
   * @param \Drupal\entity_share_server\Entity\ChannelInterface $channel
   *   The channel entity.
   *
   * @return array
   *   The field mapping used for sorting.
   */
  public function getFieldMapping(ChannelInterface $channel);

  /**
   * Get field mapping.
   *
   * @param \Drupal\entity_share_server\Entity\ChannelInterface $channel
   *   The channel entity.
   *
   * @return array
   *   The field mapping used for text search.
   */
  public function getSearchConfiguration(ChannelInterface $channel);

}

Members

Name	Modifiers	Type	Description	Overrides
ChannelManipulatorInterface::getFieldMapping	public	function	Get field mapping.	1
ChannelManipulatorInterface::getQuery	public	function	Generate URL query.	1
ChannelManipulatorInterface::getSearchConfiguration	public	function	Get field mapping.	1