Documentation

EikonPaginator

Table of Contents

Classes

AbstractElement
Base element.
Set
Set element
Category
Category element
BaseEntity
Abstract base entity element
Datum
Datum element
Page
Page element
Place
Place element
Person
Person element
Member
Team member element
Post
Post element
Interview
Interview element
CachedFile
Class to manage cached text-based files.
CachedJson
Class to manage cached JSON-based files.
SetSpider
Entity Set Spider.

Functions

check_fields_json()  : bool
Check JSON fields
load_json()  : mixed
Load a JSON file
store_json()  : void
Store a JSON-like object to a JSON file
dirtree()  : mixed
Create a multidimensional array directory map
_checkbox()  : mixed
category_checkboxes()  : mixed
entity_checkboxes()  : mixed
_shuffle_assoc()  : mixed
random_categories()  : mixed
random_entities()  : mixed
_sort()  : mixed
_reverse_sort()  : mixed
sort_categories()  : mixed
sort_rev_categories()  : mixed
sort_entities()  : mixed
sort_rev_entities()  : mixed
filter_categories()  : mixed
filter_entities()  : mixed

Functions

check_fields_json()

Check JSON fields

check_fields_json(mixed $json[, array<string|int, mixed> $check_fields = array() ]) : bool
Parameters
$json : mixed

A JSON-like object.

$check_fields : array<string|int, mixed> = array()

Optional. An array of fields which need to be in the JSON file. Default to an empty array

Tags
author

Davide Lanza davide.lanza@eikonproject.org

Return values
bool —

TRUE if the check succeeds.

load_json()

Load a JSON file

load_json(string $path[, array<string|int, mixed> $check_fields = array() ]) : mixed
Parameters
$path : string

The JSON file path.

$check_fields : array<string|int, mixed> = array()

Optional. An array of fields which need to be in the JSON file. Default to an empty array.

Tags
author

Davide Lanza davide.lanza@eikonproject.org

Return values
mixed —

Value encoded in json in appropriate PHP type.

store_json()

Store a JSON-like object to a JSON file

store_json(mixed $json, string $path[, array<string|int, mixed> $check_fields = array() ]) : void
Parameters
$json : mixed

A JSON-like object.

$path : string

The file path for the JSON file created.

$check_fields : array<string|int, mixed> = array()

Optional. An array of fields which need to be in the JSON file. Default to an empty array

Tags
author

Davide Lanza davide.lanza@eikonproject.org

dirtree()

Create a multidimensional array directory map

dirtree(string $dir[, string $regex = '' ][, bool $ignoreEmpty = false ]) : mixed

It builds a directory map for a specified directory, e.g.:

Array
(
    [dir_name] => Array
        (
            [0] => file.ext
            [1] => file.ext
        )

    [dir_name] => Array
        (
            [0] => [dir_name] => Array
                (
                    [0] => file.ext
                    [1] => file.ext
                )
            [1] => [dir_name] => Array
                (
                    [0] => file.ext
                    [1] => file.ext
                )
        )
)
Parameters
$dir : string

root directory from where to start the dirtree.

$regex : string = ''

regex for filtering filenames.

$ignoreEmpty : bool = false

ignore empty directories.

Tags
see
https://stackoverflow.com/questions/45382701/multidimensional-array-directory-map
SuppressWarnings

(PHPMD.BooleanArgumentFlag)

author

Davide Lanza davide.lanza@eikonproject.org

_checkbox()

_checkbox(string $html_id_prefix, mixed $value) : mixed
Parameters
$html_id_prefix : string
$value : mixed

category_checkboxes()

category_checkboxes(string $html_id_prefix, array<string|int, mixed> $set_array, string $key) : mixed
Parameters
$html_id_prefix : string
$set_array : array<string|int, mixed>
$key : string

entity_checkboxes()

entity_checkboxes(string $html_id_prefix, array<string|int, mixed> $set_array, string $key) : mixed
Parameters
$html_id_prefix : string
$set_array : array<string|int, mixed>
$key : string

_shuffle_assoc()

_shuffle_assoc(mixed $list) : mixed
Parameters
$list : mixed

random_categories()

random_categories(array<string|int, mixed> $set_array) : mixed
Parameters
$set_array : array<string|int, mixed>

random_entities()

random_entities(array<string|int, mixed> $set_array) : mixed
Parameters
$set_array : array<string|int, mixed>

_sort()

_sort(array<string|int, mixed> $array, string $key) : mixed
Parameters
$array : array<string|int, mixed>
$key : string

_reverse_sort()

_reverse_sort(array<string|int, mixed> $array, string $key) : mixed
Parameters
$array : array<string|int, mixed>
$key : string

sort_categories()

sort_categories(array<string|int, mixed> $set_array, string $key) : mixed
Parameters
$set_array : array<string|int, mixed>
$key : string

sort_rev_categories()

sort_rev_categories(array<string|int, mixed> $set_array, string $key) : mixed
Parameters
$set_array : array<string|int, mixed>
$key : string

sort_entities()

sort_entities(array<string|int, mixed> $set_array, string $key) : mixed
Parameters
$set_array : array<string|int, mixed>
$key : string

sort_rev_entities()

sort_rev_entities(array<string|int, mixed> $set_array, string $key) : mixed
Parameters
$set_array : array<string|int, mixed>
$key : string

filter_categories()

filter_categories(array<string|int, mixed> $set_array, mixed $metadata_key, array<string|int, mixed> $values) : mixed
Parameters
$set_array : array<string|int, mixed>
$metadata_key : mixed
$values : array<string|int, mixed>

filter_entities()

filter_entities(array<string|int, mixed> $set_array, mixed $metadata_key, array<string|int, mixed> $values) : mixed
Parameters
$set_array : array<string|int, mixed>
$metadata_key : mixed
$values : array<string|int, mixed> 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results