• Главная
• Google
• Cloud
• Datastore
• Key

PHP Класс Google\Cloud\Datastore\Key

Keys are unique identifiers for entities. Keys may be considered either "named" or "incomplete". A named Key is one in which each element of the Key path specify a Kind and a Name or ID. An incomplete Key omits the Name or ID from the final path element. Named Keys are required for any lookup, update, upsert or delete operations. They may also be used for inserting records, so long as you are certain that the identifier is available in Datastore. Incomplete Keys may be used for inserting records into Datastore. When an incomplete Key is used, Datastore will allocate an ID before inserting. Incomplete Keys are useful for guaranteeing the availability of an identifier without requiring an additional operation to check whether a given name or ID is available. Key state can be checked by calling Key::state(). The return will be one of Key::STATE_NAMED or Key::STATE_INCOMPLETE. Example: use Google\Cloud\ServiceBuilder; $cloud = new ServiceBuilder(); $datastore = $cloud->datastore(); $key = $datastore->key('Person', 'Bob'); Keys with complex paths can be constructed with additional method calls. $key = $datastore->key('Person', 'Bob'); $key->ancestor('Parents', 'Joe'); $key->ancestor('Grandparents', 'Barb'); Path elements can also be appended, so long as the current last path element contains a kind and identifier. $key = $datastore->key('Grandparents', 'Barb'); $key->pathElement('Parents', 'Joe'); $key->pathElement('Person'); $key->pathElement('Child', 'Dave'); // Error here. Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод	Описание
__construct ( string $projectId, array $options = [] )	Create a Key.
__toString ( )	Represent the path as a string.
ancestor ( string $kind, string | integer $identifier, array $options = [] ) : Key	Add a path element to the beginning of the Key path.
ancestorKey ( Key $key ) : Key	Use another Key's path as the current Key's ancestor
jsonSerialize ( )
keyObject ( ) : array	Get the key object formatted for the datastore service.
path ( ) : array	Get the key path
pathElement ( string $kind, string | integer $identifier = null, array $options = [] ) : Key	Add a path element to the end of the Key path
pathEnd ( ) : array	Get the last pathElement in the key
pathEndIdentifier ( ) : string | integer | null	Get the last pathElement identifier.
pathEndIdentifierType ( ) : string | null	Get the last pathElement identifier type.
setLastElementIdentifier ( string $value, string $type = Key::TYPE_ID ) : void	Set the value of the last path element in a Key
state ( ) : boolean	Check if the Key is considered Named or Incomplete.

Приватные методы

Метод	Описание
determineIdentifierType ( mixed $identifier, string | null $identifierType ) : string	Determine whether the given identifier is an ID or a Name
normalizeElement ( string $kind, mixed $identifier, string $identifierType ) : array	Determine the identifier type and return the valid pathElement
normalizePath ( array $path ) : array	Normalize the internal representation of a path

Описание методов