CMS  Version 3.9
Public Member Functions | Protected Attributes | List of all members
SimpleQueryAPIEndPoint Class Reference
Api
+ Inheritance diagram for SimpleQueryAPIEndPoint:
+ Collaboration diagram for SimpleQueryAPIEndPoint:

Public Member Functions

 __construct ($class, $roles="", $searchFilter=null, $outputFilter=null, $constraints="")
 
 get ()
 
 checkAccess ()
 
 allowAnonymous ()
 
- Public Member Functions inherited from APIEndPoint
 __construct ()
 

Protected Attributes

 $helper
 
 $roles
 

Detailed Description

Definition at line 27 of file api_manager.inc.

Constructor & Destructor Documentation

◆ __construct()

SimpleQueryAPIEndPoint::__construct (   $class,
  $roles = "",
  $searchFilter = null,
  $outputFilter = null,
  $constraints = "" 
)

Definition at line 32 of file api_manager.inc.

33  {
34  $this->roles = $roles;
35  $this->helper = new APIHelper($class, $searchFilter, $outputFilter, $constraints);
36  }
$class
$class
Definition: data_import_field_mapping.inc:5

Member Function Documentation

◆ allowAnonymous()

SimpleQueryAPIEndPoint::allowAnonymous ( )

Reimplemented from APIEndPoint.

Definition at line 49 of file api_manager.inc.

50  {
51  return ($this->roles == "");
52  }

◆ checkAccess()

SimpleQueryAPIEndPoint::checkAccess ( )

Reimplemented from APIEndPoint.

Definition at line 44 of file api_manager.inc.

45  {
46  return checkRole($this->roles);
47  }

◆ get()

SimpleQueryAPIEndPoint::get ( )

Definition at line 38 of file api_manager.inc.

39  {
40  return $this->helper->query();
41  }

Member Data Documentation

◆ $helper

SimpleQueryAPIEndPoint::$helper
protected

Definition at line 29 of file api_manager.inc.

◆ $roles

SimpleQueryAPIEndPoint::$roles
protected

Definition at line 30 of file api_manager.inc.

The documentation for this class was generated from the following file: