Documentation

MediaSource extends MediaSource
in package
implements Proxy

DO NOT EDIT THIS FILE - IT WAS CREATED BY DOCTRINE'S PROXY GENERATOR

Table of Contents

Interfaces

Proxy

Properties

$__cloner__  : Closure
$__initializer__  : Closure
$__isInitialized__  : bool
$lazyPropertiesDefaults  : array<string|int, mixed>
$accessIds  : array<string|int, mixed>
Array with access ids to use with \Permission::checkAccess($id, 'static', true)
$dataAccesses  : Collection
$directory  : array<string|int, mixed>
Array with the web and normal path to the directory.
$fileSystem  : FileSystem
$humanName  : string
Human readable name
$id  : int
$identifier  : string
$localeCodes  : array<string|int, mixed>
List of locale codes ordered by translation fallback order per Cx instance
$name  : string
Name of the mediatype e.g. files, shop, media1
$nestingCount  : int
Counts the nesting level of __call()
$options  : string
$position  : int
$stringRepresentationBlank  : bool
Whether blank string representations are valid
$stringRepresentationFields  : array<string|int, mixed>
List of fields that should be available in the string representation
$stringRepresentationFormat  : string
Sprintf format for the string representation
$supportedOperations  : array<string|int, mixed>
List of operations supported by this DataSource
$systemComponentController  : SystemComponentController
$type  : string
$validators  : array<string|int, mixed>
Initialize this array as follows: array( 'columName' => Zend_Validate )
$virtual  : bool
Defines if an entity is virtual and therefore not persistable.

Methods

__call()  : mixed
{@inheritDoc}
__clone()  : mixed
__construct()  : mixed
Constructor
__get()  : mixed
{@inheritDoc}
__getCloner()  : mixed
{@inheritDoc}
__getInitializer()  : mixed
{@inheritDoc}
__getLazyProperties()  : mixed
{@inheritDoc}
__isInitialized()  : mixed
{@inheritDoc}
__load()  : mixed
Forces initialization of the proxy
__setCloner()  : mixed
{@inheritDoc}
__setInitialized()  : mixed
{@inheritDoc}
__setInitializer()  : mixed
{@inheritDoc}
__sleep()  : array<string|int, mixed>
__toString()  : mixed
{@inheritDoc}
__wakeup()  : mixed
add()  : mixed
Adds a new entry to this DataSource
addDataAccess()  : mixed
{@inheritDoc}
checkAccess()  : bool
get()  : array<string|int, mixed>
Gets one or more entries from this DataSource
getAccessIds()  : array<string|int, mixed>
getComponentController()  : mixed
{@inheritDoc}
getCurrentVersion()  : mixed
{@inheritDoc}
getDataAccesses()  : mixed
{@inheritDoc}
getDirectory()  : array<string|int, mixed>
getFileSystem()  : FileSystem
getHumanName()  : string
getId()  : mixed
{@inheritDoc}
getIdentifier()  : mixed
{@inheritDoc}
getIdentifierFieldNames()  : array<string|int, mixed>
Returns a list of field names that uniquely identify objects
getKeyAsString()  : string
Returns this entity's key
getName()  : string
getOption()  : mixed
{@inheritDoc}
getOptions()  : mixed
{@inheritDoc}
getPosition()  : int
getSupportedOperations()  : mixed
{@inheritDoc}
getSystemComponentController()  : SystemComponentController
getTranslatedFieldValue()  : mixed
{@inheritDoc}
getType()  : mixed
{@inheritDoc}
hasField()  : mixed
{@inheritDoc}
initializeValidators()  : mixed
{@inheritDoc}
isVersionable()  : mixed
{@inheritDoc}
isVirtual()  : mixed
{@inheritDoc}
listFields()  : array<string|int, mixed>
Returns a list of field names this DataSource consists of
remove()  : mixed
Drops an entry from this DataSource
removeDataAccess()  : mixed
{@inheritDoc}
setAccessIds()  : mixed
setDataAccesses()  : mixed
{@inheritDoc}
setHumanName()  : mixed
setIdentifier()  : mixed
{@inheritDoc}
setName()  : mixed
setOptions()  : mixed
{@inheritDoc}
setPosition()  : mixed
setVirtual()  : mixed
{@inheritDoc}
supportsOperation()  : mixed
{@inheritDoc}
update()  : mixed
Updates an existing entry of this DataSource
validate()  : mixed
{@inheritDoc}
getFallbackLocaleCodes()  : array<string|int, mixed>
Returns a list of all locale codes ordered by fallback order
getMediaSource()  : MediaSource
Returns the real instance of this MediaSource
getStringRepresentationBlank()  : bool
Whether blank string representations are valid
getStringRepresentationFields()  : array<string|int, mixed>
Returns a list of fields available in the string representation
getStringRepresentationFormat()  : string
Returns the sprintf() format for the string representation

Properties

$__initializer__

public Closure $__initializer__

the callback responsible for loading properties in the proxy object. This callback is called with three parameters, being respectively the proxy object to be initialized, the method that triggered the initialization process and an array of ordered parameters that were passed to that method.

Tags
see
Proxy::__setInitializer

$lazyPropertiesDefaults

public static array<string|int, mixed> $lazyPropertiesDefaults = array()

properties to be lazy loaded, with keys being the property names and values being their default values

Tags
see
Proxy::__getLazyProperties

$accessIds

Array with access ids to use with \Permission::checkAccess($id, 'static', true)

protected array<string|int, mixed> $accessIds = array()

Accepts various formats. Most basic is as follows: array( [,,...] )

This will set the access as follows:

  • for both, read and write access, the user must have access to every listed id (as specified by ).

Use the following format instead, to change the requirement of having access to all listed IDs, but instead only one of the listed IDs: array( 'any' => array( [,,...] ), )

To set different read and write access permissions, do specify as follows: array( 'read' => array( [,,...] ), 'write' => array( [,,...] ), )

Again, to make the user only require having access to one of the listed IDs, do specify as follows: array( 'read' => array( 'any' => array( [,,...] ), ), 'write' => array( 'any' => array( [,,...] ), ), )

$directory

Array with the web and normal path to the directory.

protected array<string|int, mixed> $directory = array()

e.g: array( $this->cx->getWebsiteImagesContentPath(), $this->cx->getWebsiteImagesContentWebPath(), )

$localeCodes

List of locale codes ordered by translation fallback order per Cx instance

protected static array<string|int, mixed> $localeCodes = array()

Array in the form: array(<instanceId> => array(<localeCode>, ...))

Tags
see
getFallbackLocaleCodes()

$name

Name of the mediatype e.g. files, shop, media1

protected string $name

$nestingCount

Counts the nesting level of __call()

protected static int $nestingCount = 0

$stringRepresentationBlank

Whether blank string representations are valid

protected bool $stringRepresentationBlank = false

Whether blank string representations are valid

Tags
see
getStringRepresentationBlank()

$stringRepresentationFields

List of fields that should be available in the string representation

protected array<string|int, mixed> $stringRepresentationFields = array()

List of field names

Tags
see
getStringRepresentationFields()

$stringRepresentationFormat

Sprintf format for the string representation

protected string $stringRepresentationFormat = ''

Sprintf format string

Tags
see
getStringRepresentationFormat()

$supportedOperations

List of operations supported by this DataSource

protected array<string|int, mixed> $supportedOperations = array('eq')

List of operations

$validators

Initialize this array as follows: array( 'columName' => Zend_Validate )

protected array<string|int, mixed> $validators = array()

$virtual

Defines if an entity is virtual and therefore not persistable.

protected bool $virtual = false

Defaults to FALSE - not virtual.

Methods

__setCloner()

{@inheritDoc}

public __setCloner([Closure $cloner = null ]) : mixed
Parameters
$cloner : Closure = null
Tags
internal

generated method: use only when explicitly handling proxy specific loading logic

__setInitialized()

{@inheritDoc}

public __setInitialized(mixed $initialized) : mixed
Parameters
$initialized : mixed
Tags
internal

generated method: use only when explicitly handling proxy specific loading logic

__setInitializer()

{@inheritDoc}

public __setInitializer([Closure $initializer = null ]) : mixed
Parameters
$initializer : Closure = null
Tags
internal

generated method: use only when explicitly handling proxy specific loading logic

checkAccess()

public checkAccess([mixed $scope = 'read' ]) : bool
Parameters
$scope : mixed = 'read'

Set to 'read' or 'write' to check for specific access permissions.

Return values
bool

get()

Gets one or more entries from this DataSource

public get([mixed $elementId = array() ][, mixed $filter = array() ][, mixed $order = array() ][, mixed $limit = 0 ][, mixed $offset = 0 ][, mixed &$count = 0 ][, mixed $fieldList = array() ]) : array<string|int, mixed>
Parameters
$elementId : mixed = array()

(optional) field=>value-type condition array identifying an entry

$filter : mixed = array()

(optional) field=>value-type condition array, only supports = for now

$order : mixed = array()

(optional) field=>order-type array, order is either "ASC" or "DESC"

$limit : mixed = 0

(optional) If set, no more than $limit results are returned

$offset : mixed = 0

(optional) Entry to start with

$count : mixed = 0

(optional / passed by reference) Will be set to the total matched entries

$fieldList : mixed = array()

(optional) Limits the result to the values for the fields in this list

Return values
array<string|int, mixed> —

Two dimensional array (/table) of results (array($row=>array($fieldName=>$value)))

getIdentifierFieldNames()

Returns a list of field names that uniquely identify objects

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

List of field names

getKeyAsString()

Returns this entity's key

public final getKeyAsString([string $separator = '/' ]) : string

If this entity has a composite key, the fields are separated by $separator.

Parameters
$separator : string = '/'

(optional) Separator for composite key fields, default "/"

Return values
string —

Entity key as string

update()

Updates an existing entry of this DataSource

public update(mixed $elementId, mixed $data) : mixed
Parameters
$elementId : mixed

field=>value-type condition array identifying an entry

$data : mixed

Field=>value-type array. Not all fields are required.

getFallbackLocaleCodes()

Returns a list of all locale codes ordered by fallback order

protected getFallbackLocaleCodes() : array<string|int, mixed>
  • First entry is the current locale
  • Second entry is the default locale (if different from current, it's omitted otherwise)
  • Then all other locales follow (in no particular order)
Tags
todo

Order the array by the fallback order (same as in ContentManager)

Return values
array<string|int, mixed> —

List of locale codes

getMediaSource()

Returns the real instance of this MediaSource

protected getMediaSource() : MediaSource

DataSources are loaded from DB, MediaSources are loaded via event hooks, MediaSource is a DataSource --> MediaSources cannot be loaded from DB yet. As soon as this is possible this can be removed.

Return values
MediaSource —

Real instance of this MediaSource

getStringRepresentationBlank()

Whether blank string representations are valid

protected getStringRepresentationBlank() : bool
Return values
bool —

Whether blank string representations are valid

getStringRepresentationFields()

Returns a list of fields available in the string representation

protected getStringRepresentationFields() : array<string|int, mixed>
Return values
array<string|int, mixed> —

List of field names

getStringRepresentationFormat()

Returns the sprintf() format for the string representation

protected getStringRepresentationFormat() : string
Return values
string —

sprintf() format string


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results