FileMount extends AbstractEntity

An abstract Entity. An Entity is an object fundamentally defined not by its attributes, but by a thread of continuity and identity (e.g. a person).

Internal

This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.

Table of Contents

Constants

PROPERTY_LANGUAGE_UID  = '_languageUid'
PROPERTY_LOCALIZED_UID  = '_localizedUid'
PROPERTY_PID  = 'pid'
PROPERTY_UID  = 'uid'
PROPERTY_VERSIONED_UID  = '_versionedUid'

Properties

$_languageUid  : int<-1, max>|null
$_localizedUid  : int<0, max>|null
$_versionedUid  : int|null
The uid of the versioned record.
$description  : string
Description of the file mount.
$hidden  : bool
Status of the file mount
$identifier  : string
Identifier of the file mount
$pid  : int<0, max>|null
$readOnly  : bool
Determines whether this file mount should be read only.
$title  : string
Title of the file mount.
$uid  : int<1, max>|null

Methods

__clone()  : void
__toString()  : non-empty-string
_getCleanProperties()  : array<non-empty-string, mixed>
Returns a hash map of clean properties and $values.
_getCleanProperty()  : mixed
Returns the clean value of the given property. The returned value will be NULL if the clean state was not memorized before, or if the clean value is NULL.
_getProperties()  : array<non-empty-string, mixed>
_getProperty()  : mixed
_hasProperty()  : bool
_isClone()  : bool
_isDirty()  : bool
Returns TRUE if the properties were modified after reconstitution
_isNew()  : bool
Returns TRUE if the object is new (the uid was not set, yet)
_memorizeCleanState()  : void
Register an object's clean state, e.g. after it has been reconstituted from the database.
_memorizePropertyCleanState()  : void
Register a property's clean state, e.g. after it has been reconstituted from the database.
_setClone()  : mixed
Setter whether this Domain Object is a clone of another one.
_setProperty()  : bool
getDescription()  : string
Getter for the description of the file mount.
getIdentifier()  : string
getPath()  : string
returns the path segment of the file mount (without the storage id)
getPid()  : int<0, max>|null
getStorage()  : ResourceStorage|null
getTitle()  : string
Getter for the title of the file mount.
getUid()  : int<1, max>|null
isHidden()  : bool
isReadOnly()  : bool
Getter for the readOnly property of the file mount.
setDescription()  : void
Setter for the description of the file mount.
setHidden()  : void
setIdentifier()  : void
setPid()  : void
setReadOnly()  : void
Setter for the readOnly property of the file mount.
setTitle()  : void
Setter for the title of the file mount.
isPropertyDirty()  : bool
Checks the $value against the $cleanState.

Constants

PROPERTY_LANGUAGE_UID

public mixed PROPERTY_LANGUAGE_UID = '_languageUid'

PROPERTY_LOCALIZED_UID

public mixed PROPERTY_LOCALIZED_UID = '_localizedUid'

PROPERTY_PID

public mixed PROPERTY_PID = 'pid'

PROPERTY_UID

public mixed PROPERTY_UID = 'uid'

PROPERTY_VERSIONED_UID

public mixed PROPERTY_VERSIONED_UID = '_versionedUid'

Properties

$_languageUid

protected int<-1, max>|null $_languageUid = null

The uid of the language of the object. This is the id of the corresponding sing language.

Internal
Tags
todo

make private in 13.0 and expose value via getter

$_localizedUid

protected int<0, max>|null $_localizedUid = null

The uid of the localized record. Holds the uid of the record in default language (the translationOrigin).

Internal
Tags
todo

make private in 13.0 and expose value via getter

$_versionedUid

The uid of the versioned record.

protected int|null $_versionedUid = null
Internal
Tags
todo

make private in 13.0 and expose value via getter

$description

Description of the file mount.

protected string $description = ''

$hidden

Status of the file mount

protected bool $hidden = false

$identifier

Identifier of the file mount

protected string $identifier = ''

$pid

protected int<0, max>|null $pid = null

The id of the page the record is "stored".

$readOnly

Determines whether this file mount should be read only.

protected bool $readOnly = false

$title

Title of the file mount.

protected string $title = ''
Attributes
#[Validate]
['validator' => 'NotEmpty']

$uid

protected int<1, max>|null $uid = null

The uid of the record. The uid is only unique in the context of the database table.

Methods

__toString()

public __toString() : non-empty-string
Return values
non-empty-string

_getCleanProperties()

Returns a hash map of clean properties and $values.

public _getCleanProperties() : array<non-empty-string, mixed>
Return values
array<non-empty-string, mixed>

_getCleanProperty()

Returns the clean value of the given property. The returned value will be NULL if the clean state was not memorized before, or if the clean value is NULL.

public _getCleanProperty(non-empty-string $propertyName) : mixed
Parameters
$propertyName : non-empty-string

The name of the property to be memorized.

Internal
Return values
mixed —

The clean property value or NULL

_getProperties()

public _getProperties() : array<non-empty-string, mixed>
Internal
Return values
array<non-empty-string, mixed> —

a hash map of property names and property values.

_getProperty()

public _getProperty(string $propertyName) : mixed
Parameters
$propertyName : string
Internal

_hasProperty()

public _hasProperty(non-empty-string $propertyName) : bool
Parameters
$propertyName : non-empty-string
Internal
Return values
bool

_isClone()

public _isClone() : bool
Return values
bool

_isDirty()

Returns TRUE if the properties were modified after reconstitution

public _isDirty([non-empty-string|null $propertyName = null ]) : bool
Parameters
$propertyName : non-empty-string|null = null

An optional name of a property to be checked if its value is dirty

Tags
throws
TooDirtyException
Return values
bool

_isNew()

Returns TRUE if the object is new (the uid was not set, yet)

public _isNew() : bool
Internal
Return values
bool

_memorizeCleanState()

Register an object's clean state, e.g. after it has been reconstituted from the database.

public _memorizeCleanState([non-empty-string|null $propertyName = null ]) : void
Parameters
$propertyName : non-empty-string|null = null

The name of the property to be memorized. If omitted all persistable properties are memorized.

_memorizePropertyCleanState()

Register a property's clean state, e.g. after it has been reconstituted from the database.

public _memorizePropertyCleanState(non-empty-string $propertyName) : void
Parameters
$propertyName : non-empty-string

The name of the property to be memorized. If omitted all persistable properties are memorized.

_setClone()

Setter whether this Domain Object is a clone of another one.

public _setClone(bool $clone) : mixed

NEVER SET THIS PROPERTY DIRECTLY. We currently need it to make the _isDirty check inside AbstractEntity work, but it is just a work- around right now.

Parameters
$clone : bool
Internal

_setProperty()

public _setProperty(string $propertyName, mixed $value) : bool
Parameters
$propertyName : string
$value : mixed
Internal
Return values
bool

getDescription()

Getter for the description of the file mount.

public getDescription() : string
Return values
string

getIdentifier()

public getIdentifier() : string
Return values
string

getPath()

returns the path segment of the file mount (without the storage id)

public getPath() : string
Return values
string

getPid()

public getPid() : int<0, max>|null
Return values
int<0, max>|null

getTitle()

Getter for the title of the file mount.

public getTitle() : string
Return values
string

getUid()

public getUid() : int<1, max>|null
Return values
int<1, max>|null

isHidden()

public isHidden() : bool
Return values
bool

isReadOnly()

Getter for the readOnly property of the file mount.

public isReadOnly() : bool
Return values
bool

setDescription()

Setter for the description of the file mount.

public setDescription(string $description) : void
Parameters
$description : string

setHidden()

public setHidden(bool $hidden) : void
Parameters
$hidden : bool

setIdentifier()

public setIdentifier(string $identifier) : void
Parameters
$identifier : string

setPid()

public setPid(int<0, max> $pid) : void
Parameters
$pid : int<0, max>

setReadOnly()

Setter for the readOnly property of the file mount.

public setReadOnly(bool $readOnly) : void
Parameters
$readOnly : bool

setTitle()

Setter for the title of the file mount.

public setTitle(string $value) : void
Parameters
$value : string

isPropertyDirty()

Checks the $value against the $cleanState.

protected isPropertyDirty(mixed $previousValue, mixed $currentValue) : bool
Parameters
$previousValue : mixed
$currentValue : mixed
Return values
bool 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results