Version 1
[yaffs-website] / web / modules / contrib / permissions_by_term / src / AccessCheckInterface.php
diff --git a/web/modules/contrib/permissions_by_term/src/AccessCheckInterface.php b/web/modules/contrib/permissions_by_term/src/AccessCheckInterface.php
new file mode 100644 (file)
index 0000000..49b6da8
--- /dev/null
@@ -0,0 +1,66 @@
+<?php
+
+namespace Drupal\permissions_by_term;
+
+interface AccessCheckInterface {
+
+  /**
+   * Checks if a user can access a node by given node id.
+   */
+  public function canUserAccessByNodeId($iNid, $uid = FALSE);
+
+  /**
+   * Returns a boolean if the view is containing nodes.
+   */
+  public function viewContainsNode($view);
+
+  /**
+   * Removes forbidden nodes from view listing.
+   */
+  public function removeForbiddenNodesFromView(&$view);
+
+  /**
+   * @param int $tid
+   * @param bool|int $uid
+   * @return mixed
+   */
+  public function isAccessAllowedByDatabase($tid, $uid = FALSE);
+
+  /**
+   * Returns a boolean if the term is allowed by given user id.
+   *
+   * @param int $iTid
+   *   The taxonomy term id.
+   * @param int $iUid
+   *   The user id.
+   *
+   * @return bool
+   *   Determines by boolean if the given term id is allowed by given user id.
+   */
+  public function isTermAllowedByUserId($iTid, $iUid);
+
+  /**
+   * Returns a boolean if the term is allowed by given user role id.
+   *
+   * @param int $iTid
+   *   The term id.
+   * @param string $sUserRole
+   *   The user role.
+   *
+   * @return bool
+   *   Determines if the term is allowed by the given user role.
+   */
+  public function isTermAllowedByUserRole($iTid, $sUserRole);
+
+  /**
+   * Gets boolean for set permission on a term.
+   *
+   * @param int $iTid
+   *   The taxonomy term id.
+   *
+   * @return bool
+   *   Returns either TRUE or FALSE if there is any permission set for the term.
+   */
+  public function isAnyPermissionSetForTerm($iTid);
+
+}