From 535e100b51a32ff103478c8a1b7215c215405f16 Mon Sep 17 00:00:00 2001 From: Chris Lloyd Date: Wed, 7 Apr 2021 20:12:14 +0100 Subject: [PATCH] WIP --- README.md | 3 +- .../Flat3-Lodata-Drivers-CSVEntityType.html | 1921 +++++++++++++++++ 2 files changed, 1923 insertions(+), 1 deletion(-) create mode 100644 docs/classes/Flat3-Lodata-Drivers-CSVEntityType.html diff --git a/README.md b/README.md index 6a19315e0..0c17927fd 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,8 @@ 1. [Drivers](#drivers) 1. [Database](#database) 1. [Redis](#redis) - 1. [Filesystem](#filesystem) + 1. [Filesystems](#filesystem) + 1. [CSV Files](#csv-files) 1. [Advanced usage](#advanced-usage) 1. [Annotations](#annotations) 1. [Generated properties](#generated-properties) diff --git a/docs/classes/Flat3-Lodata-Drivers-CSVEntityType.html b/docs/classes/Flat3-Lodata-Drivers-CSVEntityType.html new file mode 100644 index 000000000..21572f1bf --- /dev/null +++ b/docs/classes/Flat3-Lodata-Drivers-CSVEntityType.html @@ -0,0 +1,1921 @@ + + + + + Lodata + + + + + + + + + + + + + + + + + + +
+

Lodata

+ + +
+ +
+ + +
+ +
+
+ + + + +
+ + +
+

+ CSVEntityType + + + extends EntityType + + + + +

+ + + +

Class CSVEntityType

+ +
+ + + + + + + + +

+ Table of Contents + +

+ +
+
+ __callStatic() + +  : PrimitiveType +
+
Generate a new type container
+ +
+ __construct() + +  : mixed +
+
+ +
+ addDeclaredProperty() + +  : $this +
+
Create and add a declared property
+ +
+ addProperty() + +  : $this +
+
Add a property
+ +
+ binary() + +  : +
+
+ +
+ boolean() + +  : +
+
+ +
+ byte() + +  : +
+
+ +
+ date() + +  : +
+
+ +
+ datetimeoffset() + +  : +
+
+ +
+ decimal() + +  : +
+
+ +
+ double() + +  : +
+
+ +
+ dropProperty() + +  : $this +
+
Drop a property
+ +
+ duration() + +  : +
+
+ +
+ factory() + +  : ComplexType +
+
Generate a new complex type
+ +
+ getContextUrl() + +  : string +
+
Get the context URL for this type
+ +
+ getDeclaredProperties() + +  : ObjectArray|array<string|int, DeclaredProperty> +
+
Get all declared properties on this type
+ +
+ getDeclaredProperty() + +  : DeclaredProperty|null +
+
Get a declared property by name from this type
+ +
+ getGeneratedProperties() + +  : ObjectArray +
+
Get all generated properties on this type
+ +
+ getGeneratedProperty() + +  : GeneratedProperty|null +
+
Get a generated property by name from this type
+ +
+ getKey() + +  : DeclaredProperty|null +
+
Return the defined key of this entity type
+ +
+ getNavigationProperties() + +  : ObjectArray +
+
Get all navigation properties defined on this type
+ +
+ getNavigationProperty() + +  : NavigationProperty|null +
+
Get a navigation property by name from this type
+ +
+ getProperties() + +  : ObjectArray +
+
Get all properties defined on this type
+ +
+ getProperty() + +  : Property|null +
+
Get a property by name from this type
+ +
+ getResourceUrl() + +  : string +
+
Get the resource URL for this type
+ +
+ guid() + +  : +
+
+ +
+ instance() + +  : Primitive +
+
Generate a new primitive instance of this type from the provided value
+ +
+ int16() + +  : +
+
+ +
+ int32() + +  : +
+
+ +
+ int64() + +  : +
+
+ +
+ pipe() + +  : PipeInterface|null +
+
Path component handler
+ +
+ sbyte() + +  : +
+
+ +
+ setKey() + +  : $this +
+
Set the entity type key property
+ +
+ single() + +  : +
+
+ +
+ stream() + +  : +
+
+ +
+ string() + +  : +
+
+ +
+ timeofday() + +  : +
+
+ +
+ + + + + + + +
+

+ Methods + +

+
+

+ __callStatic() + +

+ + +

Generate a new type container

+ + + public + static __callStatic(string $name, mixed $arguments) : PrimitiveType + +
+ +
Parameters
+
+
+ $name + : string +
+
+

Type name

+
+ +
+
+ $arguments + : mixed +
+
+ +
+
+ + + +
Return values
+ PrimitiveType + — +

OData primitive type

+
+ + +
+
+

+ __construct() + +

+ + + + + public + __construct(mixed $identifier) : mixed + + +
Parameters
+
+
+ $identifier + : mixed +
+
+ +
+
+ + + +
Return values
+ mixed + — +
+ + +
+
+

+ addDeclaredProperty() + +

+ + +

Create and add a declared property

+ + + public + addDeclaredProperty(mixed $name, Type $type) : $this + +
+ +
Parameters
+
+
+ $name + : mixed +
+
+

Property name

+
+ +
+
+ $type + : Type +
+
+

Property type

+
+ +
+
+ + + +
Return values
+ $this + — +
+ + +
+
+

+ addProperty() + +

+ + +

Add a property

+ + + public + addProperty(Property $property) : $this + +
+ +
Parameters
+
+
+ $property + : Property +
+
+

The property to add

+
+ +
+
+ + + +
Return values
+ $this + — +
+ + +
+
+

+ binary() + +

+ + + + + public + static binary() : + +

Binary type

+
+ + + + +
Return values
+ + — +
+ + +
+
+

+ boolean() + +

+ + + + + public + static boolean() : + +

Boolean type

+
+ + + + +
Return values
+ + — +
+ + +
+
+

+ byte() + +

+ + + + + public + static byte() : + +

Byte type

+
+ + + + +
Return values
+ + — +
+ + +
+
+

+ date() + +

+ + + + + public + static date() : + +

Date type

+
+ + + + +
Return values
+ + — +
+ + +
+
+

+ datetimeoffset() + +

+ + + + + public + static datetimeoffset() : + +

DateTimeOffset type

+
+ + + + +
Return values
+ + — +
+ + +
+
+

+ decimal() + +

+ + + + + public + static decimal() : + +

Decimal type

+
+ + + + +
Return values
+ + — +
+ + +
+
+

+ double() + +

+ + + + + public + static double() : + +

Double type

+
+ + + + +
Return values
+ + — +
+ + +
+
+

+ dropProperty() + +

+ + +

Drop a property

+ + + public + dropProperty(mixed $property) : $this + +
+ +
Parameters
+
+
+ $property + : mixed +
+
+

The property to drop

+
+ +
+
+ + + +
Return values
+ $this + — +
+ + +
+
+

+ duration() + +

+ + + + + public + static duration() : + +

Duration type

+
+ + + + +
Return values
+ + — +
+ + +
+
+

+ factory() + +

+ + +

Generate a new complex type

+ + + public + static factory(string|Identifier $identifier) : ComplexType + +
+ +
Parameters
+
+
+ $identifier + : string|Identifier +
+
+
+ +
+
+ + +
+ Tags + +
+
+
+ codeCoverageIgnore +
+
+ +
+ +
+
+ +
Return values
+ ComplexType + — +

Complex Type

+
+ + +
+
+

+ getContextUrl() + +

+ + +

Get the context URL for this type

+ + + public + getContextUrl(Transaction $transaction) : string + +
+ +
Parameters
+
+
+ $transaction + : Transaction +
+
+

Related transaction

+
+ +
+
+ + + +
Return values
+ string + — +

Context URL

+
+ + +
+ +
+

+ getDeclaredProperty() + +

+ + +

Get a declared property by name from this type

+ + + public + getDeclaredProperty(string $property) : DeclaredProperty|null + +
+ +
Parameters
+
+
+ $property + : string +
+
+
+ +
+
+ + + +
Return values
+ DeclaredProperty|null + — +

Declared property

+
+ + +
+
+

+ getGeneratedProperties() + +

+ + +

Get all generated properties on this type

+ + + public + getGeneratedProperties() : ObjectArray + +
+ + + + +
Return values
+ ObjectArray + — +

Generated properties

+
+ + +
+
+

+ getGeneratedProperty() + +

+ + +

Get a generated property by name from this type

+ + + public + getGeneratedProperty(string $property) : GeneratedProperty|null + +
+ +
Parameters
+
+
+ $property + : string +
+
+
+ +
+
+ + + +
Return values
+ GeneratedProperty|null + — +

Generated property

+
+ + +
+ +
+

+ getNavigationProperties() + +

+ + +

Get all navigation properties defined on this type

+ + + public + getNavigationProperties() : ObjectArray + +
+ + + + +
Return values
+ ObjectArray + — +

Navigation properties

+
+ + +
+
+

+ getNavigationProperty() + +

+ + +

Get a navigation property by name from this type

+ + + public + getNavigationProperty(string $property) : NavigationProperty|null + +
+ +
Parameters
+
+
+ $property + : string +
+
+
+ +
+
+ + + +
Return values
+ NavigationProperty|null + — +

Navigation property

+
+ + +
+
+

+ getProperties() + +

+ + +

Get all properties defined on this type

+ + + public + getProperties() : ObjectArray + +
+ + + + +
Return values
+ ObjectArray + — +

Properties

+
+ + +
+
+

+ getProperty() + +

+ + +

Get a property by name from this type

+ + + public + getProperty(string $property) : Property|null + +
+ +
Parameters
+
+
+ $property + : string +
+
+
+ +
+
+ + + +
Return values
+ Property|null + — +

Property

+
+ + +
+
+

+ getResourceUrl() + +

+ + +

Get the resource URL for this type

+ + + public + getResourceUrl(Transaction $transaction) : string + +
+ +
Parameters
+
+
+ $transaction + : Transaction +
+
+

Related transaction

+
+ +
+
+ + + +
Return values
+ string + — +

Resource URL

+
+ + +
+
+

+ guid() + +

+ + + + + public + static guid() : + +

GUID type

+
+ + + + +
Return values
+ + — +
+ + +
+
+

+ instance() + +

+ + +

Generate a new primitive instance of this type from the provided value

+ + + public + abstract instance([mixed|null $value = null ]) : Primitive + +
+ +
Parameters
+
+
+ $value + : mixed|null + = null
+
+

Value

+
+ +
+
+ + + +
Return values
+ Primitive + — +

OData primitive

+
+ + +
+
+

+ int16() + +

+ + + + + public + static int16() : + +

Int16 type

+
+ + + + +
Return values
+ + — +
+ + +
+
+

+ int32() + +

+ + + + + public + static int32() : + +

Int32 type

+
+ + + + +
Return values
+ + — +
+ + +
+
+

+ int64() + +

+ + + + + public + static int64() : + +

Int64 type

+
+ + + + +
Return values
+ + — +
+ + +
+
+

+ pipe() + +

+ + +

Path component handler

+ + + public + static pipe(Transaction $transaction, string $currentSegment, string|null $nextSegment, PipeInterface|null $argument) : PipeInterface|null + +
+ +
Parameters
+
+
+ $transaction + : Transaction +
+
+

Related transaction

+
+ +
+
+ $currentSegment + : string +
+
+

The current path segment

+
+ +
+
+ $nextSegment + : string|null +
+
+

The next path segment

+
+ +
+
+ $argument + : PipeInterface|null +
+
+

The previous path segment

+
+ +
+
+ + + +
Return values
+ PipeInterface|null + — +

The processed path segment if handled by this implementation

+
+ + +
+
+

+ sbyte() + +

+ + + + + public + static sbyte() : + +

SByte type

+
+ + + + +
Return values
+ + — +
+ + +
+
+

+ setKey() + +

+ + +

Set the entity type key property

+ + + public + setKey(DeclaredProperty $key) : $this + +
+ +
Parameters
+
+
+ $key + : DeclaredProperty +
+
+

Key property

+
+ +
+
+ + + +
Return values
+ $this + — +
+ + +
+
+

+ single() + +

+ + + + + public + static single() : + +

Single type

+
+ + + + +
Return values
+ + — +
+ + +
+
+

+ stream() + +

+ + + + + public + static stream() : + +

Stream type

+
+ + + + +
Return values
+ + — +
+ + +
+
+

+ string() + +

+ + + + + public + static string() : + +

String type

+
+ + + + +
Return values
+ + — +
+ + +
+
+

+ timeofday() + +

+ + + + + public + static timeofday() : + +

TimeOfDay type

+
+ + + + +
Return values
+ + — +
+ + +
+
+ +
+
+
+
+

Search results

+ +
+
+
    +
    +
    +
    +
    +
    + + +
    + + + + + + +