Civi/Api4/Relationship.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11 namespace Civi\Api4;
  12
  13 /**
  14  * Relationship entity.
  15  *
  16  * @see https://docs.civicrm.org/user/en/latest/organising-your-data/relationships/
  17  * @searchable none
  18  * @package Civi\Api4
  19  */
  20 class Relationship extends Generic\DAOEntity {
  21
  22   /**
  23    * @param bool $checkPermissions
  24    * @return Action\Relationship\Get
  25    */
  26   public static function get($checkPermissions = TRUE) {
  27     return (new Action\Relationship\Get(static::class, __FUNCTION__))
  28       ->setCheckPermissions($checkPermissions);
  29   }
  30
  31 }