Documentation

FlexDirectory
in package

Grav

Framework

Flex

implements FlexDirectoryInterface uses FlexAuthorizeTrait

Class FlexDirectory

Interfaces

FlexDirectoryInterface: Interface FlexDirectoryInterface

Properties

$blueprint_file : string
$blueprints : array<string|int, Blueprint>
$cache : array<string|int, CacheInterface>
$collection : FlexCollectionInterface|null
$collectionClassName : string
$config : Config
$defaults : array<string|int, mixed>
$enabled : bool
$indexClassName : string
$indexes : array<string|int, FlexIndexInterface>
$objectClassName : string
$objects : array<string|int, FlexObjectInterface>
$storage : FlexStorageInterface
$type : string
$_authorize : string|null

Methods

__construct() : mixed: FlexDirectory constructor.
clearCache() : $this
createCollection() : FlexCollectionInterface
createIndex() : FlexIndexInterface
createObject() : FlexObjectInterface
getAuthorizeRule() : string
getBlueprint() : Blueprint: Returns a new uninitialized instance of blueprint.
getBlueprintFile() : string
getCache() : CacheInterface
getCollection() : FlexCollectionInterface: Get collection. In the site this will be filtered by the default filters (published etc).
getCollectionClass() : string
getConfig() : mixed
getDescription() : string
getDirectoryConfigUri() : string
getFlexType() : string
getIndex() : FlexIndexInterface: Get the full collection of all stored objects.
getIndexClass() : string
getMediaFolder() : string|null
getObject() : FlexObjectInterface|null: Returns an object if it exists. If no arguments are passed (or both of them are null), method creates a new empty object.
getObjectClass() : string
getSearchOptions() : array<string|int, mixed>
getSearchProperties() : array<string|int, mixed>
getStorage() : FlexStorageInterface
getStorageFolder() : string|null
getTitle() : string
getType() : string
isAuthorized() : bool|null: Check if user is authorized for the action.
isEnabled() : bool
isListed() : bool
loadCollection() : FlexCollectionInterface
reloadIndex() : void
remove() : FlexObjectInterface|null
update() : FlexObjectInterface
createStorage() : FlexStorageInterface
dynamicAuthorizeField() : void
dynamicDataField() : void
dynamicFlexField() : void
getActiveUser() : UserInterface|null
getAuthorizeAction() : string
getAuthorizeScope() : string
getBlueprintInternal() : Blueprint
getDirectoryConfig() : array<string|int, mixed>
isAuthorizedAction() : bool|null: Check if user is authorized for the action.
isAuthorizedOverride() : bool|null: Please override this method
isAuthorizedSuperAdmin() : bool|null
loadCachedObjects() : array<string|int, mixed>
loadIndex() : FlexIndexInterface
mergeArrays() : array<string|int, mixed>

$blueprint_file


        protected
            string
    $blueprint_file

$blueprints


        protected
            array<string|int, Blueprint>
    $blueprints

$cache


        protected
            array<string|int, CacheInterface>
    $cache

$collection


        protected
            FlexCollectionInterface|null
    $collection

$collectionClassName


        protected
            string
    $collectionClassName

$config


        protected
            Config
    $config

$defaults


        protected
            array<string|int, mixed>
    $defaults

$enabled


        protected
            bool
    $enabled

$indexClassName


        protected
            string
    $indexClassName

$indexes


        protected
            array<string|int, FlexIndexInterface>
    $indexes
     = []

$objectClassName


        protected
            string
    $objectClassName

$objects


        protected
            array<string|int, FlexObjectInterface>
    $objects

$storage


        protected
            FlexStorageInterface
    $storage

$type


        protected
            string
    $type

$_authorize


        private
            string|null
    $_authorize

__construct()

FlexDirectory constructor.


    public
                    __construct(string $type, string $blueprint_file[, array<string|int, mixed> $defaults = [] ]) : mixed

Parameters

$type : string
$blueprint_file : string
$defaults : array<string|int, mixed> = []

clearCache()


    public
                    clearCache() : $this

Return values

$this

createCollection()


    public
                    createCollection(array<string|int, mixed> $entries[, string|null $keyField = null ]) : FlexCollectionInterface

Parameters

$entries : array<string|int, mixed>
$keyField : string|null = null

Return values

FlexCollectionInterface

createIndex()


    public
                    createIndex(array<string|int, mixed> $entries[, string|null $keyField = null ]) : FlexIndexInterface

Parameters

$entries : array<string|int, mixed>
$keyField : string|null = null

Return values

FlexIndexInterface

createObject()


    public
                    createObject(array<string|int, mixed> $data[, string $key = '' ][, bool $validate = false ]) : FlexObjectInterface

Parameters

$data : array<string|int, mixed>
$key : string = ''
$validate : bool = false

Return values

FlexObjectInterface

getAuthorizeRule()


    public
                    getAuthorizeRule(string $scope, string $action) : string

Parameters

$scope : string
$action : string

Return values

string

getBlueprint()

Returns a new uninitialized instance of blueprint.


    public
                    getBlueprint([string $type = '' ][, string $context = '' ]) : Blueprint

Always use $object->getBlueprint() or $object->getForm()->getBlueprint() instead.

Parameters

$type : string = ''
$context : string = ''

Return values

Blueprint

getBlueprintFile()


    public
                    getBlueprintFile([string $view = '' ]) : string

Parameters

$view : string = ''

Return values

string

getCache()


    public
                    getCache([string|null $namespace = null ]) : CacheInterface

Parameters

$namespace : string|null = null

Return values

CacheInterface

getCollection()

Get collection. In the site this will be filtered by the default filters (published etc).


    public
                    getCollection([array<string|int, mixed>|null $keys = null ][, string|null $keyField = null ]) : FlexCollectionInterface

Use $directory->getIndex() if you want unfiltered collection.

Parameters

$keys : array<string|int, mixed>|null = null: Array of keys.
$keyField : string|null = null: Field to be used as the key.

Return values

FlexCollectionInterface

getCollectionClass()


    public
                    getCollectionClass() : string

Return values

string

getConfig()


    public
                    getConfig([string|null $name = null ][, mixed $default = null ]) : mixed

Parameters

$name : string|null = null
$default : mixed = null

getDescription()


    public
                    getDescription() : string

Return values

string

getDirectoryConfigUri()


    public
                    getDirectoryConfigUri([string|null $name = null ]) : string

Parameters

$name : string|null = null

Return values

string

getFlexType()


    public
                    getFlexType() : string

Return values

string

getIndex()

Get the full collection of all stored objects.


    public
                    getIndex([array<string|int, mixed>|null $keys = null ][, string|null $keyField = null ]) : FlexIndexInterface

Use $directory->getCollection() if you want a filtered collection.

Parameters

$keys : array<string|int, mixed>|null = null: Array of keys.
$keyField : string|null = null: Field to be used as the key.

Return values

FlexIndexInterface

getIndexClass()


    public
                    getIndexClass() : string

Return values

string

getMediaFolder()


    public
                    getMediaFolder([string|null $key = null ]) : string|null

Parameters

$key : string|null = null

Return values

string|null

getObject()

Returns an object if it exists. If no arguments are passed (or both of them are null), method creates a new empty object.


    public
                    getObject([string|null $key = null ][, string|null $keyField = null ]) : FlexObjectInterface|null

Note: It is not safe to use the object without checking if the user can access it.

Parameters

$key : string|null = null
$keyField : string|null = null: Field to be used as the key.

Return values

FlexObjectInterface|null

getObjectClass()


    public
                    getObjectClass() : string

Return values

string

getSearchOptions()


    public
                    getSearchOptions([array<string|int, mixed>|null $options = null ]) : array<string|int, mixed>

Parameters

$options : array<string|int, mixed>|null = null

Return values

array<string|int, mixed>

getSearchProperties()


    public
                    getSearchProperties([string|array<string|int, string>|null $properties = null ]) : array<string|int, mixed>

Parameters

$properties : string|array<string|int, string>|null = null

Return values

array<string|int, mixed>

getStorage()


    public
                    getStorage() : FlexStorageInterface

Return values

FlexStorageInterface

getStorageFolder()


    public
                    getStorageFolder([string|null $key = null ]) : string|null

Parameters

$key : string|null = null

Return values

string|null

getTitle()


    public
                    getTitle() : string

Return values

string

getType()


    public
                    getType() : string

Use ->getFlexType() method instead.

Return values

string

isAuthorized()

Check if user is authorized for the action.


    public
                    isAuthorized(string $action[, string|null $scope = null ][, UserInterface|null $user = null ]) : bool|null

Note: There are two deny values: denied (false), not set (null). This allows chaining multiple rules together when the previous rules were not matched.

To override the default behavior, please use isAuthorizedOverride().

Parameters

$action : string
$scope : string|null = null
$user : UserInterface|null = null

Return values

bool|null

isEnabled()


    public
                    isEnabled() : bool

Return values

bool

isListed()


    public
                    isListed() : bool

Return values

bool

loadCollection()


    public
                    loadCollection(array<string|int, mixed> $entries[, string|null $keyField = null ]) : FlexCollectionInterface

Parameters

$entries : array<string|int, mixed>
$keyField : string|null = null

Return values

FlexCollectionInterface

reloadIndex()


    public
                    reloadIndex() : void

remove()


    public
                    remove(string $key) : FlexObjectInterface|null

Use $object->delete() instead.

Parameters

$key : string

Return values

FlexObjectInterface|null

update()


    public
                    update(array<string|int, mixed> $data[, string|null $key = null ]) : FlexObjectInterface

Use $object->update()->save() instead.

Parameters

$data : array<string|int, mixed>
$key : string|null = null

Return values

FlexObjectInterface

createStorage()


    protected
                    createStorage() : FlexStorageInterface

Return values

FlexStorageInterface

dynamicAuthorizeField()


    protected
                    dynamicAuthorizeField(array<string|int, mixed> &$field, string $property, array<string|int, mixed> $call) : void

Parameters

$field : array<string|int, mixed>
$property : string
$call : array<string|int, mixed>

dynamicDataField()


    protected
                    dynamicDataField(array<string|int, mixed> &$field, string $property, array<string|int, mixed> $call) : void

Parameters

$field : array<string|int, mixed>
$property : string
$call : array<string|int, mixed>

dynamicFlexField()


    protected
                    dynamicFlexField(array<string|int, mixed> &$field, string $property, array<string|int, mixed> $call) : void

Parameters

$field : array<string|int, mixed>
$property : string
$call : array<string|int, mixed>

getActiveUser()


    protected
                    getActiveUser() : UserInterface|null

Return values

UserInterface|null

getAuthorizeAction()


    protected
                    getAuthorizeAction(string $action) : string

Parameters

$action : string

Return values

string

getAuthorizeScope()


    protected
                    getAuthorizeScope() : string

Return values

string

getBlueprintInternal()


    protected
                    getBlueprintInternal([string $type_view = '' ][, string $context = '' ]) : Blueprint

Parameters

$type_view : string = ''
$context : string = ''

Return values

Blueprint

getDirectoryConfig()


    protected
                    getDirectoryConfig([string|null $name = null ]) : array<string|int, mixed>

Parameters

$name : string|null = null

Return values

array<string|int, mixed>

isAuthorizedAction()

Check if user is authorized for the action.


    protected
                    isAuthorizedAction(UserInterface $user, string $action, string $scope, bool $isMe) : bool|null

Parameters

$user : UserInterface
$action : string
$scope : string
$isMe : bool

Return values

bool|null

isAuthorizedOverride()

Please override this method


    protected
                    isAuthorizedOverride(UserInterface $user, string $action, string $scope, bool $isMe) : bool|null

Parameters

$user : UserInterface
$action : string
$scope : string
$isMe : bool

Return values

bool|null

isAuthorizedSuperAdmin()


    protected
                    isAuthorizedSuperAdmin(UserInterface $user) : bool|null

Not needed for Flex Users.

Parameters

$user : UserInterface

Return values

bool|null

loadCachedObjects()


    protected
                    loadCachedObjects(array<string|int, mixed> $fetch) : array<string|int, mixed>

Parameters

$fetch : array<string|int, mixed>

Return values

array<string|int, mixed>

loadIndex()


    protected
                    loadIndex(string $keyField) : FlexIndexInterface

Parameters

$keyField : string

Return values

FlexIndexInterface

mergeArrays()


    protected
                    mergeArrays(array<string|int, mixed> $array1, array<string|int, mixed> $array2) : array<string|int, mixed>

Parameters

$array1 : array<string|int, mixed>
$array2 : array<string|int, mixed>

Return values

array<string|int, mixed>

FlexDirectory in package Grav Framework Flex implements FlexDirectoryInterface uses FlexAuthorizeTrait

Table of Contents

Interfaces

Properties

Methods

Properties

$blueprint_file

$blueprints

$cache

$collection

Tags

$collectionClassName

$config

$defaults

$enabled

$indexClassName

$indexes

Tags

$objectClassName

$objects

$storage

$type

$_authorize

Methods

__construct()

Parameters

clearCache()

Return values

createCollection()

Parameters

Tags

Return values

createIndex()

Parameters

Tags

Return values

createObject()

Parameters

Return values

getAuthorizeRule()

Parameters

Return values

getBlueprint()

Parameters

Return values

getBlueprintFile()

Parameters

Return values

getCache()

Parameters

Return values

getCollection()

Parameters

Tags

Return values

getCollectionClass()

Return values

getConfig()

Parameters

getDescription()

Return values

getDirectoryConfigUri()

Parameters

Return values

getFlexType()

Return values

getIndex()

Parameters

Tags

Return values

getIndexClass()

Return values

getMediaFolder()

Parameters

Return values

getObject()

Parameters

Return values

getObjectClass()

Return values

FlexDirectory
in package

Grav

Framework

Flex

implements FlexDirectoryInterface uses FlexAuthorizeTrait