Documentation

PlasmidRecord

The storage shape of a Plasmid. The immutable Plasmid aggregate stays independent of Doctrine : convert between the two with PlasmidRecordMapper rather than persisting the aggregate itself.

Class PlasmidRecord

Tags
author

Amélie DUVERNET aka Amelaye amelieonline@gmail.com

Attributes
#[Entity]
#[Table]
$name: "plasmid"

Table of Contents

Properties

$description  : string|null
$externalId  : string|null
$features  : Collection<int, PlasmidFeatureRecord>
$id  : int|null
$metadata  : array<string|int, mixed>
$name  : string
$sequence  : string

Methods

__construct()  : mixed
PlasmidRecord constructor.
addFeature()  : $this
Attaches $oFeature and keeps both sides of the association in sync.
getDescription()  : string|null
getExternalId()  : string|null
getFeatures()  : Collection<int, PlasmidFeatureRecord>
getId()  : int|null
getMetadata()  : array<string|int, mixed>
getName()  : string
getSequence()  : string
setDescription()  : $this
setExternalId()  : $this
setMetadata()  : $this
setName()  : $this
setSequence()  : $this

Properties

$description

private string|null $description = null
Attributes
#[Column]
$type: \Doctrine\DBAL\Types\Types::TEXT
$nullable: true

$externalId

private string|null $externalId = null
Attributes
#[Column]
$type: \Doctrine\DBAL\Types\Types::STRING
$length: 255
$nullable: true

$features

private Collection<int, PlasmidFeatureRecord> $features

Kept in the order of PlasmidFeatureRecord::$position

Attributes
#[OneToMany]
$targetEntity: \Amelaye\BioPHP\Domain\Cloning\Entity\PlasmidFeatureRecord::class
$mappedBy: "plasmid"
$cascade: ["persist", "remove"]
$orphanRemoval: true
#[OrderBy]
["position" => "ASC"]

$id

private int|null $id = null
Attributes
#[Column]
$type: \Doctrine\DBAL\Types\Types::INTEGER
#[GeneratedValue]
#[Id]

$metadata

private array<string|int, mixed> $metadata = []

Only scalars, null and arrays of the same, recursively

Attributes
#[Column]
$type: \Doctrine\DBAL\Types\Types::JSON

$name

private string $name = ""
Attributes
#[Column]
$type: \Doctrine\DBAL\Types\Types::STRING
$length: 255

$sequence

private string $sequence = ""

The circular sequence, upper case, as held by CircularDnaSequence

Attributes
#[Column]
$type: \Doctrine\DBAL\Types\Types::TEXT

Methods

__construct()

PlasmidRecord constructor.

public __construct() : mixed

getDescription()

public getDescription() : string|null
Return values
string|null

getExternalId()

public getExternalId() : string|null
Return values
string|null

getId()

public getId() : int|null
Return values
int|null —

Null until the record has been flushed

getMetadata()

public getMetadata() : array<string|int, mixed>
Return values
array<string|int, mixed>

getSequence()

public getSequence() : string
Return values
string

setDescription()

public setDescription(string|null $sDescription) : $this
Parameters
$sDescription : string|null
Return values
$this

setExternalId()

public setExternalId(string|null $sExternalId) : $this
Parameters
$sExternalId : string|null
Return values
$this

setMetadata()

public setMetadata(array<string|int, mixed> $aMetadata) : $this
Parameters
$aMetadata : array<string|int, mixed>
Return values
$this

setName()

public setName(string $sName) : $this
Parameters
$sName : string
Return values
$this

setSequence()

public setSequence(string $sSequence) : $this
Parameters
$sSequence : string
Return values
$this
On this page

Search results