Index | Appengine PHP SDK for PHP API Reference

A

AppIdentityException — Class in namespace Google\AppEngine\Api\AppIdentity: Thrown when there is a general failure using the AppIdentityService.
AppIdentityService — Class in namespace Google\AppEngine\Api\AppIdentity: The AppIdentityService allows you to sign arbitrary byte array using per app private key maintained by App Engine. You can also retrieve a list of public certificates which can be used to verify the signature.
AdminMessage — Class in namespace Google\AppEngine\Api\Mail: Allows users to send mail to application admins using the App Engine mail APIs.
$BaseMessage#allowed_headers — Property in class BaseMessage
BaseMessage::addAttachment() — Method in class BaseMessage: Adds an attachment to the Message object.
BaseMessage::addAttachmentArray() — Method in class BaseMessage: Adds an array of attachments to the Message object.
BaseMessage::addAttachmentsArray() — Method in class BaseMessage: Adds an array of attachments to the Message object.
BaseMessage::addHeader() — Method in class BaseMessage: Adds a header pair to the mail object.
BaseMessage::addHeaderArray() — Method in class BaseMessage: Adds an array of headers to the mail object.
Message::addBcc() — Method in class Message: Adds a "bcc" address, or array of addresses, to the mail object.
Message::addCc() — Method in class Message: Adds a "cc" address, or array of addresses, to the mail object.
Message::addTo() — Method in class Message: Adds a "to" address, or array of addresses, to the mail object.
Memcache::add() — Method in class Memcache: Adds a new item to the cache. Will fail if the key is already present in the cache.
Memcache::addServer() — Method in class Memcache: This function is present only for compatibility and does nothing.
Memcached::add() — Method in class Memcached: add is similar to set(), but the operation fails if the key already exists on the server.
Memcached::addByKey() — Method in class Memcached: Memcached::addByKey() is functionally equivalent to Memcached::add(), except that the free-form server_key can be used to map the key to a specific server. This is useful if you need to keep a bunch of related keys on a certain server.
Memcached::addServer() — Method in class Memcached: This function is present only for compatibility and does nothing.
Memcached::addServers() — Method in class Memcached: This function is present only for compatibility and does nothing.
Memcached::append() — Method in class Memcached: Memcached::append() appends the given value string to the value of an existing item. The reason that value is forced to be a string is that appending mixed types is not well-defined.
Memcached::appendByKey() — Method in class Memcached
PushQueue::addTasks() — Method in class PushQueue: Add tasks to the queue.
PushTask::add() — Method in class PushTask: Adds the task to a queue.
ApiProxy — Class in namespace Google\AppEngine\Runtime
ApiProxyBase — Class in namespace Google\AppEngine\Runtime
ApplicationError — Class in namespace Google\AppEngine\Runtime: Thrown by APIProxy in the event of an application-level error.
ArgumentError — Class in namespace Google\AppEngine\Runtime: Thrown by APIProxy calls if there is an error parsing the arguments.
ApiCallArguments — Class in namespace Google\AppEngine\Testing
ApiProxyMock — Class in namespace Google\AppEngine\Testing
ApiProxyTestBase — Class in namespace Google\AppEngine\Testing
ArrayUtil — Class in namespace Google\AppEngine\Util: Various PHP array related utility functions.
ArrayUtil::arrayMergeIgnoreCase() — Method in class ArrayUtil: Merge a number of arrays using a case insensitive comparison for the array keys.
ArrayUtil::all() — Method in class ArrayUtil: Checks whether every value in an array passes the provided predicate.
ArrayUtil::allInstanceOf() — Method in class ArrayUtil: Checks whether every value in an array is an instance of a class.
AppIdentityServiceError — Class in namespace google\appengine
AppOverride — Class in namespace google\appengine
GetAccessTokenRequest::addScope() — Method in class GetAccessTokenRequest
GetModulesResponse::addModule() — Method in class GetModulesResponse
GetOAuthUserRequest::addScopes() — Method in class GetOAuthUserRequest
GetOAuthUserResponse::addScopes() — Method in class GetOAuthUserResponse
GetPublicCertificateForAppResponse::addPublicCertificateList() — Method in class GetPublicCertificateForAppResponse
GetVersionsResponse::addVersion() — Method in class GetVersionsResponse
MailMessage::addTo() — Method in class MailMessage
MailMessage::addCc() — Method in class MailMessage
MailMessage::addBcc() — Method in class MailMessage
MailMessage::addAttachment() — Method in class MailMessage
MailMessage::addHeader() — Method in class MailMessage
MemcacheBatchIncrementRequest::addItem() — Method in class MemcacheBatchIncrementRequest
MemcacheBatchIncrementResponse::addItem() — Method in class MemcacheBatchIncrementResponse
MemcacheDeleteRequest::addItem() — Method in class MemcacheDeleteRequest
MemcacheDeleteResponse::addDeleteStatus() — Method in class MemcacheDeleteResponse
MemcacheGetRequest::addKey() — Method in class MemcacheGetRequest
MemcacheGetResponse::addItem() — Method in class MemcacheGetResponse
MemcacheGrabTailResponse::addItem() — Method in class MemcacheGrabTailResponse
MemcacheSetRequest::addItem() — Method in class MemcacheSetRequest
MemcacheSetResponse::addSetStatus() — Method in class MemcacheSetResponse
TaskQueueAcl::addUserEmail() — Method in class TaskQueueAcl
TaskQueueAcl::addWriterEmail() — Method in class TaskQueueAcl
TaskQueueAddRequest::addHeader() — Method in class TaskQueueAddRequest
TaskQueueBulkAddRequest::addAddRequest() — Method in class TaskQueueBulkAddRequest
TaskQueueBulkAddResponse::addTaskResult() — Method in class TaskQueueBulkAddResponse
TaskQueueDeleteRequest::addTaskName() — Method in class TaskQueueDeleteRequest
TaskQueueDeleteResponse::addResult() — Method in class TaskQueueDeleteResponse
TaskQueueFetchQueueStatsRequest::addQueueName() — Method in class TaskQueueFetchQueueStatsRequest
TaskQueueFetchQueueStatsResponse::addQueueStats() — Method in class TaskQueueFetchQueueStatsResponse
TaskQueueFetchQueuesResponse::addQueue() — Method in class TaskQueueFetchQueuesResponse
Queue::addHeaderOverride() — Method in class Queue
TaskQueueQueryAndOwnTasksResponse::addTask() — Method in class TaskQueueQueryAndOwnTasksResponse
TaskQueueQueryTasksResponse::addTask() — Method in class TaskQueueQueryTasksResponse
Task::addHeader() — Method in class Task
TaskQueueUpdateQueueRequest::addHeaderOverride() — Method in class TaskQueueUpdateQueueRequest
URLFetchRequest::addHeader() — Method in class URLFetchRequest
URLFetchResponse::addHeader() — Method in class URLFetchResponse
ApplicationError — Class in namespace google\appengine\ext\remote_api
TransactionRequest::addPrecondition() — Method in class TransactionRequest
Action — Class in namespace google\appengine_datastore_v3
AddActionsRequest — Class in namespace google\appengine_datastore_v3
AddActionsRequest::addAction() — Method in class AddActionsRequest
AddActionsResponse — Class in namespace google\appengine_datastore_v3
AllocateIdsRequest — Class in namespace google\appengine_datastore_v3
AllocateIdsRequest::addReserve() — Method in class AllocateIdsRequest
AllocateIdsResponse — Class in namespace google\appengine_datastore_v3
CommitResponse::addVersion() — Method in class CommitResponse
Position::addIndexValue() — Method in class Position
CompiledQuery::addMergeJoinScan() — Method in class CompiledQuery
CompiledQuery::addPropertyName() — Method in class CompiledQuery
MergeJoinScan::addPrefixValue() — Method in class MergeJoinScan
PrimaryScan::addStartPostfixValue() — Method in class PrimaryScan
PrimaryScan::addEndPostfixValue() — Method in class PrimaryScan
CompositeIndices::addIndex() — Method in class CompositeIndices
DeleteRequest::addKey() — Method in class DeleteRequest
DeleteRequest::addSnapshot() — Method in class DeleteRequest
DeleteRequest::addCompositeIndex() — Method in class DeleteRequest
DeleteResponse::addVersion() — Method in class DeleteResponse
GetRequest::addKey() — Method in class GetRequest
GetResponse::addEntity() — Method in class GetResponse
GetResponse::addDeferred() — Method in class GetResponse
PutRequest::addEntity() — Method in class PutRequest
PutRequest::addCompositeIndex() — Method in class PutRequest
PutRequest::addSnapshot() — Method in class PutRequest
AutoIdPolicy — Class in namespace google\appengine_datastore_v3\PutRequest
PutResponse::addKey() — Method in class PutResponse
PutResponse::addVersion() — Method in class PutResponse
Query::addFilter() — Method in class Query
Query::addOrder() — Method in class Query
Query::addCompositeIndex() — Method in class Query
Query::addPropertyName() — Method in class Query
Query::addGroupByPropertyName() — Method in class Query
Query::addSafeReplicaName() — Method in class Query
QueryResult::addResult() — Method in class QueryResult
QueryResult::addIndex() — Method in class QueryResult
QueryResult::addVersion() — Method in class QueryResult
QueryResult::addResultCompiledCursor() — Method in class QueryResult
Filter::addProperty() — Method in class Filter
TouchRequest::addKey() — Method in class TouchRequest
TouchRequest::addCompositeIndex() — Method in class TouchRequest
TouchRequest::addSnapshot() — Method in class TouchRequest
Transaction::addCompositeIndex() — Method in class Transaction
Decoder::avail() — Method in class Decoder
CompositeIndex::addReadDivisionFamily() — Method in class CompositeIndex
CompositeProperty::addValue() — Method in class CompositeProperty
Document::addField() — Method in class Document
Document::addFacet() — Method in class Document
EntityProto::addProperty() — Method in class EntityProto
EntityProto::addRawProperty() — Method in class EntityProto
FieldTypes::addType() — Method in class FieldTypes
Index::addProperty() — Method in class Index
IndexPostfix::addIndexValue() — Method in class IndexPostfix
IndexShardSettings::addPrevNumShards() — Method in class IndexShardSettings
IndexShardSettings::addPrevNumShardsSearchFalse() — Method in class IndexShardSettings
Path::addElement() — Method in class Path
ReferenceValue::addPathElement() — Method in class ReferenceValue

B

C

D

Memcache::decrement() — Method in class Memcache: Decrements a cached item's value. The value must be a int, float or string representing an integer e.g. 5, 5.0 or "5" or the call with fail.
Memcache::delete() — Method in class Memcache: Deletes an item from the cache.
Memcached::decrement() — Method in class Memcached: Decrements a numeric item's value by $offset.
Memcached::decrementByKey() — Method in class Memcached
Memcached::delete() — Method in class Memcached: deletes the $key from the server.
Memcached::deleteByKey() — Method in class Memcached
Memcached::deleteMulti() — Method in class Memcached: deletes an array of $keys from the server.
Memcached::deleteMultiByKey() — Method in class Memcached
MemcacheContainer::delete() — Method in class MemcacheContainer: Removes the key value pair, keyed with the input variable.
MemcacheSessionHandler::destroy() — Method in class MemcacheSessionHandler: Destroy the data associated with a particular session ID.
DeadlineExceededError — Class in namespace Google\AppEngine\Runtime: Thrown by APIProxy calls if the call took too long to respond.
MemcacheUtils::deserializeValue() — Method in class MemcacheUtils
DeleteStatusCode — Class in namespace google\appengine\MemcacheDeleteResponse
Direction — Class in namespace google\appengine\MemcacheIncrementRequest
DoubleProto — Class in namespace google\appengine\base
DeleteRequest — Class in namespace google\appengine_datastore_v3
DeleteResponse — Class in namespace google\appengine_datastore_v3
Direction — Class in namespace google\appengine_datastore_v3\Query\Order
Decoder — Class in namespace google\net: Class to decode protocol buffer from serialized form. Used by protocol buffer implementation.
ProtocolMessage::debugFormatString() — Method in class ProtocolMessage: Format protocol buffer as a text string for debugging.
ProtocolMessage::debugFormatDouble() — Method in class ProtocolMessage
ProtocolMessage::debugFormatBool() — Method in class ProtocolMessage
ProtocolMessage::debugFormatFloat() — Method in class ProtocolMessage
ProtocolMessage::debugFormatFixed32() — Method in class ProtocolMessage
ProtocolMessage::debugFormatFixed64() — Method in class ProtocolMessage
ProtocolMessage::debugFormatInt32() — Method in class ProtocolMessage
ProtocolMessage::debugFormatInt64() — Method in class ProtocolMessage
Document — Class in namespace storage_onestore_v3
DocumentMetadata — Class in namespace storage_onestore_v3
Direction — Class in namespace storage_onestore_v3\Index\Property

E

F

Memcache::flush() — Method in class Memcache: Removes all items from cache.
Memcached::fetch() — Method in class Memcached: fetch retrieves the next result from the last getDelayed() request.
Memcached::fetchAll() — Method in class Memcached: Fetch all of the remaining results from the last getDelayed() request.
Memcached::flush() — Method in class Memcached: Invalidates all existing cache items immediately.
UrlFetch::fetch() — Method in class UrlFetch: Fetches a URL.
FeatureNotEnabledError — Class in namespace Google\AppEngine\Runtime: Thrown by APIProxy when the app must enable a feature to use this call.
ArrayUtil::findByKeyOrNull() — Method in class ArrayUtil: Find an item in an associative array by a key value, or return null if not found.
ArrayUtil::findByKeyOrDefault() — Method in class ArrayUtil: Find an item in an associative array by a key value, or return default if not found.
Filter — Class in namespace google\appengine_datastore_v3\Query
Facet — Class in namespace storage_onestore_v3
FacetValue — Class in namespace storage_onestore_v3
Field — Class in namespace storage_onestore_v3
FieldTypes — Class in namespace storage_onestore_v3
FieldValue — Class in namespace storage_onestore_v3

G

H

I

Memcache::increment() — Method in class Memcache: Increments a cached item's value. The value must be a int, float or string representing an integer e.g. 5, 5.0 or "5" or the call with fail.
Memcached::increment() — Method in class Memcached: Increments a numeric item's value by the specified offset. If the item's value is not numeric, and error will result.
Memcached::incrementByKey() — Method in class Memcached
Memcached::isPersistent() — Method in class Memcached: This function is present only for compatibility and does nothing.
Memcached::isPristine() — Method in class Memcached: This function is present only for compatibility and does nothing.
InvalidModuleStateException — Class in namespace Google\AppEngine\Api\Modules: Thrown when the current state was unexpected when starting/stopping a module.
UserService::isCurrentUserAdmin() — Method in class UserService: Return true if the user making this request is an admin for this application, false otherwise.
ApiCallArguments::isInputEqual() — Method in class ApiCallArguments
ApiProxyMock::init() — Method in class ApiProxyMock
TestUtils::invokeMethod() — Method in class TestUtils: Call protected/private non-static method of an object.
TestUtils::invokeStaticMethod() — Method in class TestUtils: Call protected/private static method of a class.
ArrayUtil::isAssociative() — Method in class ArrayUtil: Checks whether an array's keys are associative. An array's keys are associate if they are not values 0 to count(array) - 1.
Item — Class in namespace google\appengine\MemcacheDeleteRequest
Item — Class in namespace google\appengine\MemcacheGetResponse
Item — Class in namespace google\appengine\MemcacheGrabTailResponse
IncrementStatusCode — Class in namespace google\appengine\MemcacheIncrementResponse
Item — Class in namespace google\appengine\MemcacheSetRequest
Integer32Proto — Class in namespace google\appengine\base
Integer64Proto — Class in namespace google\appengine\base
IndexValue — Class in namespace google\appengine_datastore_v3\CompiledCursor\Position
ProtocolMessage::isInitialized() — Method in class ProtocolMessage: Checks if this protocol message has all of the requried fields initialized.
ProtocolMessage::integerEquals() — Method in class ProtocolMessage: Checks if two integers are equal.
Index — Class in namespace storage_onestore_v3
IndexMetadata — Class in namespace storage_onestore_v3
IndexState — Class in namespace storage_onestore_v3\IndexMetadata
IndexPosition — Class in namespace storage_onestore_v3
IndexPostfix — Class in namespace storage_onestore_v3
IndexValue — Class in namespace storage_onestore_v3\IndexPostfix
IndexShardSettings — Class in namespace storage_onestore_v3

K

L

M

N

O

P

PublicCertificate — Class in namespace Google\AppEngine\Api\AppIdentity: PublicCertificate contains an X509 public certificate in PEM format and a string which is used to identify this certificate.
Memcache::pconnect() — Method in class Memcache: This function is present only for compatibility and does nothing.
Memcached::prepend() — Method in class Memcached: Prepends the given value string to an existing item.
Memcached::prependByKey() — Method in class Memcached
PushQueue — Class in namespace Google\AppEngine\Api\TaskQueue: A PushQueue executes PushTasks by sending the task back to the application in the form of an HTTP request to one of the application's handlers.
PushTask — Class in namespace Google\AppEngine\Api\TaskQueue: A PushTask encapsulates a unit of work that an application places onto a Push Queue for asynchronous execution. The queue executes that work by sending the task back to the application in the form of an HTTP request to one of the application's handlers.
PublicCertificate — Class in namespace google\appengine
Precondition — Class in namespace google\appengine\ext\remote_api\TransactionRequest
Position — Class in namespace google\appengine_datastore_v3\CompiledCursor
PrimaryScan — Class in namespace google\appengine_datastore_v3\CompiledQuery
PutRequest — Class in namespace google\appengine_datastore_v3
PutResponse — Class in namespace google\appengine_datastore_v3
Decoder::pos() — Method in class Decoder
Encoder::putVarInt32() — Method in class Encoder
Encoder::putVarUint64Internal() — Method in class Encoder
Encoder::putVarUint32() — Method in class Encoder
Encoder::putVarUint64() — Method in class Encoder
Encoder::putVarInt64() — Method in class Encoder
Encoder::putBoolean() — Method in class Encoder
Encoder::put32() — Method in class Encoder
Encoder::put64() — Method in class Encoder
Encoder::putFloat() — Method in class Encoder
Encoder::putDouble() — Method in class Encoder
Encoder::putPrefixedString() — Method in class Encoder
ProtocolBufferDecodeError — Class in namespace google\net: Exception thrown by protocol buffer decoder if the input is corrupted.
ProtocolBufferEncodeError — Class in namespace google\net: Exception thrown by protocol buffer encoder if the input protocol message is cannot be converted to serialized string.
ProtocolMessage — Class in namespace google\net: The parent class of all protocol buffers.
ProtocolMessage::parseFromString() — Method in class ProtocolMessage: Fills the message with a protocol buffer parsed from the given input string.
ProtocolMessage::parsePartialFromString() — Method in class ProtocolMessage: Fills the message with a protocol buffer parsed from the given input string. Will not fail if the resulting protocol buffer is not fully initialized.
Property — Class in namespace storage_onestore_v3\Index
Path — Class in namespace storage_onestore_v3
Property — Class in namespace storage_onestore_v3
PropertyValue — Class in namespace storage_onestore_v3
PointValue — Class in namespace storage_onestore_v3\PropertyValue
PathElement — Class in namespace storage_onestore_v3\PropertyValue\ReferenceValue

Q

R

Memcache::replace() — Method in class Memcache: Replaces an existing item in the cache. Will fail if the key is not already present in the cache.
Memcached::replace() — Method in class Memcached: Replace is similar to Memcache::set(), but the operation will fail if the key is not found on the server.
Memcached::replaceByKey() — Method in class Memcached
Memcached::resetServerList() — Method in class Memcached: This function is present only for compatibility and does nothing.
MockMicrotime::reset() — Method in class MockMicrotime: Reset the mock microtime() function - This clears any potential expected calls.
MemcacheSessionHandler::read() — Method in class MemcacheSessionHandler: Read an element from Memcache with the given ID.
RPCFailedError — Class in namespace Google\AppEngine\Runtime: Thrown by APIProxy calls when the RPC to the application server fails.
RealApiProxy — Class in namespace Google\AppEngine\Runtime: ApiProxy implementation
RequestTooLargeError — Class in namespace Google\AppEngine\Runtime: Thrown by APIProxy calls if the request was too large.
ResponseTooLargeError — Class in namespace Google\AppEngine\Runtime: Thrown by APIProxy calls if the response was too large.
RequestMethod — Class in namespace google\appengine\TaskQueueAddRequest
RequestMethod — Class in namespace google\appengine\TaskQueueQueryTasksResponse\Task
RunLog — Class in namespace google\appengine\TaskQueueQueryTasksResponse\Task
RequestMethod — Class in namespace google\appengine\URLFetchRequest
Request — Class in namespace google\appengine\ext\remote_api
Response — Class in namespace google\appengine\ext\remote_api
RpcError — Class in namespace google\appengine\ext\remote_api
RectangleRegion — Class in namespace google\appengine_datastore_v3
RegionPoint — Class in namespace google\appengine_datastore_v3
ReferenceValue — Class in namespace storage_onestore_v3\PropertyValue
Reference — Class in namespace storage_onestore_v3

S

T

U

V

Message::validEmailsArray() — Method in class Message: Checks that an email input is either: - An array, and each array member is a valid email - A single valid email string And subsequently returns an array of the valid emails.
ApiProxyMock::verify() — Method in class ApiProxyMock
VoidProto — Class in namespace google\appengine\base
Version — Class in namespace google\appengine_datastore_v3\CommitResponse

W

MemcacheSessionHandler::write() — Method in class MemcacheSessionHandler: Write an element to Memcache with the given ID and data.
WorkflowState — Class in namespace storage_onestore_v3\CompositeIndex

_

PublicCertificate::__construct() — Method in class PublicCertificate: Creates a new public certificate.
BaseMessage::__construct() — Method in class BaseMessage: Construct an instance of Message.
Memcached::__construct() — Method in class Memcached
PushQueue::__construct() — Method in class PushQueue: Construct a PushQueue
PushTask::__construct() — Method in class PushTask: Construct a PushTask.
User::__construct() — Method in class User: Constructor.
User::__toString() — Method in class User: Magic method that PHP uses when the object is treated like a string.
MemcacheContainer::__construct() — Method in class MemcacheContainer: Initialises a Memcache instance
MemcacheSessionHandler::__construct() — Method in class MemcacheSessionHandler: Constructs the session handler instance.
ApplicationError::__construct() — Method in class ApplicationError
RealApiProxy::__construct() — Method in class RealApiProxy: Consruct a RealAPiProxy object.
ApiCallArguments::__construct() — Method in class ApiCallArguments
Decoder::__construct() — Method in class Decoder