Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
SchemaProvider Class Reference
Inheritance diagram for SchemaProvider:
Activity BlubberComment BlubberThread CalendarEvent ConfigValue ConsultationBlock ConsultationBooking ConsultationSlot ContentTermsOfUse Course CourseEvent CourseMember Block BlockComment BlockFeedback Container Instance PublicLink StructuralElement StructuralElementComment StructuralElementFeedback Task TaskFeedback TaskGroup Template UserDataField UserProgress FeedbackElement FeedbackEntry File FileRef Folder ForumCategory ForumEntry Institute InstituteMember LibraryFile Message ScheduleEntry SemClass Semester SeminarCycleDate SemType SlimRoute StatusGroup Studip StudipComment StudipNews StudipProperty StudyArea User WikiPage

Public Member Functions

 __construct (FactoryInterface $factory, SchemaContainerInterface $schemaContainer,?\User $user)
 
 getType ()
 
 isAddSelfLinkInRelationshipByDefault (string $relationshipName)
 
 isAddRelatedLinkInRelationshipByDefault (string $relationshipName)
 
 createLinkToResource ($resource)
 
 shouldInclude (ContextInterface $context, string $key)
 

Data Fields

const TYPE = ''
 

Protected Attributes

 $schemaContainer
 
 $currentUser
 

Constructor & Destructor Documentation

__construct ( FactoryInterface  $factory,
SchemaContainerInterface  $schemaContainer,
?\User  $user 
)

Member Function Documentation

createLinkToResource (   $resource)
Parameters
mixed$resource
getType ( )
isAddRelatedLinkInRelationshipByDefault ( string  $relationshipName)
isAddSelfLinkInRelationshipByDefault ( string  $relationshipName)
shouldInclude ( ContextInterface  $context,
string  $key 
)
Parameters
ContextInterface$context
string$key
Returns
bool true, if the given relationship should be included in the response

Field Documentation

$currentUser
protected
$schemaContainer
protected
const TYPE = ''

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