azure-storage-table\src\Table\Models\Entity.php

Show:

inherited

Classes
- \MicrosoftAzure\Storage\Table\Models\Entity

Table of Contents

LICENSE: The MIT License (the "License") you may not use this file except in compliance with the License.

You may obtain a copy of the License at https://github.com/azure/azure-storage-php/LICENSE

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

PHP version 5

Author: Azure Storage PHP SDK
Category: Microsoft
Copyright: 2016 Microsoft Corporation
License: https://github.com/azure/azure-storage-php/LICENSE
Link: https://github.com/azure/azure-storage-php
Package: MicrosoftAzure\Storage\Table\Models

\MicrosoftAzure\Storage\Table\Models\Entity
jump to top

Package: MicrosoftAzure\Storage\Table\Models

Represents entity object used in tables

Author: Azure Storage PHP SDK
Category: Microsoft
Copyright: 2016 Microsoft Corporation
License: https://github.com/azure/azure-storage-php/LICENSE
Link: https://github.com/azure/azure-storage-php

Methods

addProperty(string $name, string $edmType, mixed $value, string $rawValue = '') : void

Creates new entity property.

Parameters

Name	Type	Description
$name	string	The property name.
$edmType	string	The property edm type.
$value	mixed	The property value.
$rawValue	string	The raw value of the property.

getETag() : string

Gets entity etag.

Returns

Type	Description
string

getPartitionKey() : string

Gets entity PartitionKey.

Returns

Type	Description
string

getProperties() : array

Gets the entity properties array.

Returns

Type	Description
array

getProperty(string $name) : \MicrosoftAzure\Storage\Table\Models\Property | null

Gets property object from the entity properties.

Parameters

Name	Type	Description
$name	string	The property name.

Returns

Type	Description
\MicrosoftAzure\Storage\Table\Models\Property \| null

getPropertyValue(string $name) : mixed

Gets property value and if the property name is not found return null.

Parameters

Name	Type	Description
$name	string	The property name.

Returns

Type	Description
mixed

getRowKey() : string

Gets entity RowKey.

Returns

Type	Description
string

getTimestamp() : \DateTime

Gets entity Timestamp.

Returns

Type	Description
\DateTime

setETag(string $etag) : void

Sets entity etag.

Parameters

Name	Type	Description
$etag	string	The entity ETag value.

setPartitionKey(string $partitionKey) : void

Sets entity PartitionKey.

Parameters

Name	Type	Description
$partitionKey	string	The entity PartitionKey value.

setProperties(array $properties) : void

Sets the entity properties array.

Parameters

Name	Type	Description
$properties	array	The entity properties.

setProperty(string $name, \MicrosoftAzure\Storage\Table\Models\Property $property) : void

Sets entity property.

Parameters

Name	Type	Description
$name	string	The property name.
$property	\MicrosoftAzure\Storage\Table\Models\Property	The property object.

setPropertyValue(string $name, mixed $value) : mixed

Sets property value.

Note that if the property doesn't exist, it doesn't add it. Use addProperty to add new properties.

Parameters

Name	Type	Description
$name	string	The property name.
$value	mixed	The property value.

Returns

Type	Description
mixed

setRowKey(string $rowKey) : void

Sets entity RowKey.

Parameters

Name	Type	Description
$rowKey	string	The entity RowKey value.

setTimestamp(\DateTime $timestamp) : void

Sets entity Timestamp.

Parameters

Name	Type	Description
$timestamp	\DateTime	The entity Timestamp value.

azure-storage-table\src\Table\Models\Entity.php

\MicrosoftAzure\Storage\Table\Models\Entityjump to top

Methods

\MicrosoftAzure\Storage\Table\Models\Entity
jump to top