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

Show: PublicProtectedPrivateinherited
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

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

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

Creates new entity property.

Parameters
NameTypeDescription
$namestring

The property name.

$edmTypestring

The property edm type.

$valuemixed

The property value.

$rawValuestring

The raw value of the property.

methodpublicgetETag() : string

Gets entity etag.

Returns
TypeDescription
string
methodpublicgetPartitionKey() : string

Gets entity PartitionKey.

Returns
TypeDescription
string
methodpublicgetProperties() : array

Gets the entity properties array.

Returns
TypeDescription
array
methodpublicgetProperty(string $name) : \MicrosoftAzure\Storage\Table\Models\Property | null

Gets property object from the entity properties.

Parameters
NameTypeDescription
$namestring

The property name.

Returns
TypeDescription
\MicrosoftAzure\Storage\Table\Models\Property | null
methodpublicgetPropertyValue(string $name) : mixed

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

Parameters
NameTypeDescription
$namestring

The property name.

Returns
TypeDescription
mixed
methodpublicgetRowKey() : string

Gets entity RowKey.

Returns
TypeDescription
string
methodpublicgetTimestamp() : \DateTime

Gets entity Timestamp.

Returns
TypeDescription
\DateTime
methodpublicsetETag(string $etag) : void

Sets entity etag.

Parameters
NameTypeDescription
$etagstring

The entity ETag value.

methodpublicsetPartitionKey(string $partitionKey) : void

Sets entity PartitionKey.

Parameters
NameTypeDescription
$partitionKeystring

The entity PartitionKey value.

methodpublicsetProperties(array $properties) : void

Sets the entity properties array.

Parameters
NameTypeDescription
$propertiesarray

The entity properties.

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

Sets entity property.

Parameters
NameTypeDescription
$namestring

The property name.

$property\MicrosoftAzure\Storage\Table\Models\Property

The property object.

methodpublicsetPropertyValue(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
NameTypeDescription
$namestring

The property name.

$valuemixed

The property value.

Returns
TypeDescription
mixed
methodpublicsetRowKey(string $rowKey) : void

Sets entity RowKey.

Parameters
NameTypeDescription
$rowKeystring

The entity RowKey value.

methodpublicsetTimestamp(\DateTime $timestamp) : void

Sets entity Timestamp.

Parameters
NameTypeDescription
$timestamp\DateTime

The entity Timestamp value.

Documentation was generated by phpDocumentor 2.9.1.