gedcomx-php-client
  • Namespace
  • Class

Namespaces

  • Gedcomx
    • Agent
    • Atom
    • Common
    • Conclusion
    • Extensions
      • FamilySearch
        • Platform
          • Artifacts
          • Discussions
          • Tree
          • Users
        • Rs
          • Client
            • FamilyTree
            • Helpers
            • Memories
            • Util
        • Rt
        • Types
    • GedcomxFile
    • Links
    • Records
    • Rs
      • Client
        • Exception
        • Options
        • Util
    • Rt
    • Search
    • Source
    • Support
    • Types
    • Util
    • Vocab

Classes

  • CacheDirectives
  • HeaderParameter
  • Preconditions
  • QueryParameter

Interfaces

  • StateTransitionOption

Class CacheDirectives

A REST API request options helper providing cache control features. This is similar to the Preconditions class, but applies inverse logic.

Class CacheDirectives

Gedcomx\Rs\Client\Options\CacheDirectives implements Gedcomx\Rs\Client\Options\StateTransitionOption
Namespace: Gedcomx\Rs\Client\Options
Package: Gedcomx\Rs\Client\Options
Located at Rs/Client/Options/CacheDirectives.php

Methods summary

public
# __construct( Gedcomx\Rs\Client\GedcomxApplicationState $state )

Constructs a cache directives class using the specified state. If the ETag (entity tag) specified here does not match the server's ETag for a resource, the resource will be returned; otherwise, a not-modified status is returned. The same applies to last modified. If the server's last modified date for a resource is greater than the last modified specified here, the resource will be returned; otherwise, a not-modified status is returned.

Constructs a cache directives class using the specified state. If the ETag (entity tag) specified here does not match the server's ETag for a resource, the resource will be returned; otherwise, a not-modified status is returned. The same applies to last modified. If the server's last modified date for a resource is greater than the last modified specified here, the resource will be returned; otherwise, a not-modified status is returned.

Parameters

$state
public GuzzleHttp\Psr7\Request
# apply( GuzzleHttp\Psr7\Request $request, GuzzleHttp\Psr7\Request $request,… )

Applies the ETag or last modified cache control headers to the specified REST API request. If the ETag (entity tag) specified here does not match the server's ETag for a resource, the resource will be returned; otherwise, a not-modified status is returned. The same applies to last modified. If the server's last modified date for a resource is greater than the last modified specified here, the resource will be returned; otherwise, a not-modified status is returned.

Applies the ETag or last modified cache control headers to the specified REST API request. If the ETag (entity tag) specified here does not match the server's ETag for a resource, the resource will be returned; otherwise, a not-modified status is returned. The same applies to last modified. If the server's last modified date for a resource is greater than the last modified specified here, the resource will be returned; otherwise, a not-modified status is returned.

Parameters

$request
$request,…

Returns

GuzzleHttp\Psr7\Request
New request object reflecting the changes

Implementation of

Gedcomx\Rs\Client\Options\StateTransitionOption::apply()
gedcomx-php-client API documentation generated by ApiGen