diff --git a/classes/HeimrichHannot-UtilsBundle-Accordion-AccordionUtil.html b/classes/HeimrichHannot-UtilsBundle-Accordion-AccordionUtil.html deleted file mode 100644 index e450e613..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Accordion-AccordionUtil.html +++ /dev/null @@ -1,625 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
-

Contao Utils Bundle

- - -
- -
- - -
- -
-
- - - - -
- - -
-

- AccordionUtil - - -
- in package - -
- - -

- - - - - - -
- Tags - -
-
-
- deprecated -
-
- - -
-
- codeCoverageIgnore -
-
- - -
-
- - - - - - -

- Table of Contents - -

- -
-
- $accordionSingleCache - -  : array<string|int, mixed> -
-
Single cache.
- -
- $accordionStartStopCache - -  : array<string|int, mixed> -
-
Start/Stop cache.
- -
- $framework - -  : ContaoFramework -
-
- -
- $container - -  : ContainerInterface -
-
- -
- __construct() - -  : mixed -
-
- -
- structureAccordionSingle() - -  : void -
-
Adds the following flags to the template data: -- first -- last -- parentId.
- -
- structureAccordionStartStop() - -  : mixed -
-
Adds the following flags to the template data: -- first -- last -- parentId.
- -
- - - - - - -
-

- Properties - -

-
-

- $accordionSingleCache - - - -

- - -

Single cache.

- - - protected - array<string|int, mixed> - $accordionSingleCache - = [] - - - - - -
-
-

- $accordionStartStopCache - - - -

- - -

Start/Stop cache.

- - - protected - array<string|int, mixed> - $accordionStartStopCache - = [] - - - - - -
-
-

- $framework - - - -

- - - - - protected - ContaoFramework - $framework - - - - - - -
-
-

- $container - - - -

- - - - - private - ContainerInterface - $container - - - - - - -
-
- -
-

- Methods - -

-
-

- __construct() - -

- - - - - public - __construct(ContainerInterface $container) : mixed - -
- -
Parameters
-
-
- $container - : ContainerInterface -
-
-
- -
-
- - - -
Return values
- mixed - — - - -
-
-

- structureAccordionSingle() - -

- - -

Adds the following flags to the template data: -- first -- last -- parentId.

- - - public - structureAccordionSingle(array<string|int, mixed> &$data[, string $prefix = 'accordion_' ]) : void - -

This is needed if your want to group multiple single accordion elements into an accordion wrapper like in bootstrap 4.

-
- -
Parameters
-
-
- $data - : array<string|int, mixed> -
-
-

Data describing the accordion. Usually this is taken from \Contao\Template::getData().

-
- -
-
- $prefix - : string - = 'accordion_'
-
-

The prefix for the flags

-
- -
-
- - - -
Return values
- void - — - - -
-
-

- structureAccordionStartStop() - -

- - -

Adds the following flags to the template data: -- first -- last -- parentId.

- - - public - structureAccordionStartStop(array<string|int, mixed> &$data[, string $prefix = 'accordion_' ]) : mixed - - -
Parameters
-
-
- $data - : array<string|int, mixed> -
-
-

Data describing the accordion. Usually this is taken from \Contao\Template::getData().

-
- -
-
- $prefix - : string - = 'accordion_'
-
-

The prefix for the flags

-
- -
-
- - -
- Tags - -
-
-
- deprecated -
-
- -

Use Utils service instead

-
- -
-
- codeCoverageIgnore -
-
- - -
-
- -
Return values
- mixed - — - - -
-
- - - - -
-
-
-
-

Search results

- -
-
-
    -
    -
    -
    -
    -
    - - -
    - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Arrays-ArrayUtil.html b/classes/HeimrichHannot-UtilsBundle-Arrays-ArrayUtil.html deleted file mode 100644 index 616c555d..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Arrays-ArrayUtil.html +++ /dev/null @@ -1,1073 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
    -

    Contao Utils Bundle

    - - -
    - -
    - - -
    - -
    -
    - - - - -
    - - -
    -

    - ArrayUtil - - -
    - in package - -
    - - -

    - - - - -
    - - - - - - - - -

    - Table of Contents - -

    - -
    -
    - $framework - -  : ContaoFramework -
    -
    - -
    - $container - -  : ContainerInterface -
    -
    - -
    - __construct() - -  : mixed -
    -
    - -
    - aasort() - -  : mixed -
    -
    sort an array alphabetically by some key in the second layer (x => array(key1, key2, key3)).
    - -
    - arrayToObject() - -  : stdClass -
    -
    Creates a stdClass from array.
    - -
    - filterByPrefixes() - -  : array<string|int, mixed> -
    -
    Filter an Array by given prefixes.
    - -
    - flattenArray() - -  : array<string|int, mixed> -
    -
    Flattens an multidimensional array to one dimension. Keys are not preserved.
    - -
    - getArrayRowByFieldValue() - -  : mixed -
    -
    Returns a row of an multidimensional array by field value. Returns false, if no row found.
    - -
    - implodeRecursive() - -  : mixed -
    -
    - -
    - insertBeforeKey() - -  : mixed -
    -
    Insert a new entry before an specific key in array.
    - -
    - insertInArrayByName() - -  : mixed -
    -
    Insert a value into an existing array by key name.
    - -
    - removePrefix() - -  : array<string|int, mixed> -
    -
    - -
    - removeValue() - -  : bool -
    -
    Removes a value in an array.
    - -
    - - - - - - -
    -

    - Properties - -

    -
    -

    - $framework - - - -

    - - - - - protected - ContaoFramework - $framework - - - - - - -
    -
    -

    - $container - - - -

    - - - - - private - ContainerInterface - $container - - - - - - -
    -
    - -
    -

    - Methods - -

    -
    -

    - __construct() - -

    - - - - - public - __construct(ContainerInterface $container) : mixed - -
    - -
    Parameters
    -
    -
    - $container - : ContainerInterface -
    -
    -
    - -
    -
    - - - -
    Return values
    - mixed - — - - -
    -
    -

    - aasort() - -

    - - -

    sort an array alphabetically by some key in the second layer (x => array(key1, key2, key3)).

    - - - public - aasort(array<string|int, mixed> &$array, mixed $key) : mixed - - -
    Parameters
    -
    -
    - $array - : array<string|int, mixed> -
    -
    -
    - -
    -
    - $key - : mixed -
    -
    -
    - -
    -
    - - - -
    Return values
    - mixed - — - - -
    -
    -

    - arrayToObject() - -

    - - -

    Creates a stdClass from array.

    - - - public - arrayToObject( $array) : stdClass - - -
    Parameters
    -
    -
    - $array - : -
    -
    - -
    -
    - - - -
    Return values
    - stdClass - — - - -
    -
    -

    - filterByPrefixes() - -

    - - -

    Filter an Array by given prefixes.

    - - - public - filterByPrefixes([array<string|int, mixed> $data = [] ][, array<string|int, mixed> $prefixes = [] ]) : array<string|int, mixed> - - -
    Parameters
    -
    -
    - $data - : array<string|int, mixed> - = []
    -
    -
    - -
    -
    - $prefixes - : array<string|int, mixed> - = []
    -
    - -
    -
    - - - -
    Return values
    - array<string|int, mixed> - — -

    the filtered array or $arrData if $prefix is empty

    -
    - - -
    -
    -

    - flattenArray() - -

    - - -

    Flattens an multidimensional array to one dimension. Keys are not preserved.

    - - - public - flattenArray(array<string|int, mixed> $array) : array<string|int, mixed> - - -
    Parameters
    -
    -
    - $array - : array<string|int, mixed> -
    -
    -
    - -
    -
    - - - -
    Return values
    - array<string|int, mixed> - — - - -
    -
    -

    - getArrayRowByFieldValue() - -

    - - -

    Returns a row of an multidimensional array by field value. Returns false, if no row found.

    - - - public - getArrayRowByFieldValue(string|int $key, mixed $value, array<string|int, mixed> $haystack[, bool $strictType = false ]) : mixed - - -
    Parameters
    -
    -
    - $key - : string|int -
    -
    -

    The array key (fieldname)

    -
    - -
    -
    - $value - : mixed -
    -
    - -
    -
    - $haystack - : array<string|int, mixed> -
    -
    -

    a multidimensional array

    -
    - -
    -
    - $strictType - : bool - = false
    -
    -

    Specifiy if type comparison should be strict (type-safe)

    -
    - -
    -
    - - - -
    Return values
    - mixed - — - - -
    -
    -

    - implodeRecursive() - -

    - - - - - public - implodeRecursive(mixed $var[, mixed $binary = false ]) : mixed - -
    - -
    Parameters
    -
    -
    - $var - : mixed -
    -
    -
    - -
    -
    - $binary - : mixed - = false
    -
    -
    - -
    -
    - - - -
    Return values
    - mixed - — - - -
    -
    -

    - insertBeforeKey() - -

    - - -

    Insert a new entry before an specific key in array.

    - - - public - static insertBeforeKey(array<string|int, mixed> &$array, string $key, string $newKey, mixed $newValue) : mixed - -

    If key not exist, the new entry is added to the end of the array. -Array is passed as reference.

    -

    Usage example: contao config.php to make your hook entry run before another.

    -
    - -
    Parameters
    -
    -
    - $array - : array<string|int, mixed> -
    -
    -

    Array the new entry should inserted to

    -
    - -
    -
    - $key - : string -
    -
    -

    The key where the new entry should be added before

    -
    - -
    -
    - $newKey - : string -
    -
    -

    The key of the entry that should be added

    -
    - -
    -
    - $newValue - : mixed -
    -
    -

    The value of the entry that should be added

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - deprecated -
    -
    - -

    Use Utils::insertBeforeKey() instead

    -
    - -
    -
    - -
    Return values
    - mixed - — - - -
    -
    -

    - insertInArrayByName() - -

    - - -

    Insert a value into an existing array by key name.

    - - - public - insertInArrayByName(array<string|int, mixed> &$current, string $key, mixed $value, int $offset[, bool $strict = false ]) : mixed - - -
    Parameters
    -
    -
    - $current - : array<string|int, mixed> -
    -
    -

    The target array

    -
    - -
    -
    - $key - : string -
    -
    -

    the existing target key in the array

    -
    - -
    -
    - $value - : mixed -
    -
    -

    the new value to be inserted

    -
    - -
    -
    - $offset - : int -
    -
    -

    offset for inserting the new value

    -
    - -
    -
    - $strict - : bool - = false
    -
    -

    use strict behavior for array search

    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - deprecated -
    -
    - -

    Use utils service instead

    -
    - -
    -
    - codeCoverageIgnore -
    -
    - - -
    -
    - -
    Return values
    - mixed - — - - -
    -
    -

    - removePrefix() - -

    - - - - - public - removePrefix(string $prefix, array<string|int, mixed> $array) : array<string|int, mixed> - -
    - -
    Parameters
    -
    -
    - $prefix - : string -
    -
    -
    - -
    -
    - $array - : array<string|int, mixed> -
    -
    -
    - -
    -
    - - - -
    Return values
    - array<string|int, mixed> - — - - -
    -
    -

    - removeValue() - -

    - - -

    Removes a value in an array.

    - - - public - removeValue( $value, array<string|int, mixed> &$array) : bool - - -
    Parameters
    -
    -
    - $value - : -
    -
    - -
    -
    - $array - : array<string|int, mixed> -
    -
    -
    - -
    -
    - - -
    - Tags - -
    -
    -
    - deprecated -
    -
    - -

    Use Utils service instead

    -
    - -
    -
    - codeCoverageIgnore -
    -
    - - -
    -
    - -
    Return values
    - bool - — -

    Returns true if the value has been found and removed, false in other cases

    -
    - - -
    -
    - - - - -
    -
    -
    -
    -

    Search results

    - -
    -
    -
      -
      -
      -
      -
      -
      - - -
      - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Cache-DatabaseCacheUtil.html b/classes/HeimrichHannot-UtilsBundle-Cache-DatabaseCacheUtil.html deleted file mode 100644 index 80db6d1a..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Cache-DatabaseCacheUtil.html +++ /dev/null @@ -1,623 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
      -

      Contao Utils Bundle

      - - -
      - -
      - - -
      - -
      -
      - - - - -
      - - -
      -

      - DatabaseCacheUtil - - -
      - in package - -
      - - -

      - - - - -
      - - - - - - - - -

      - Table of Contents - -

      - -
      -
      - DEFAULT_MAX_CACHE_TIME - -  = ['unit' => 'd', 'value' => 1] -
      -
      - -
      - $container - -  : ContainerInterface -
      -
      - -
      - $database - -  : Database -
      -
      - -
      - $framework - -  : ContaoFrameworkInterface -
      -
      - -
      - __construct() - -  : mixed -
      -
      - -
      - cacheValue() - -  : bool -
      -
      Store a given value to cache.
      - -
      - getValue() - -  : mixed -
      -
      Retrieve a value from cache.
      - -
      - keyExists() - -  : bool -
      -
      Check for a given cache key.
      - -
      - - - - -
      -

      - Constants - -

      -
      -

      - DEFAULT_MAX_CACHE_TIME - -

      - - - - - - public - mixed - DEFAULT_MAX_CACHE_TIME - = ['unit' => 'd', 'value' => 1] - - - -
      - -
      - - - -
      -
      - - -
      -

      - Properties - -

      -
      -

      - $container - - - -

      - - - - - protected - ContainerInterface - $container - - - - - - -
      -
      -

      - $database - - - -

      - - - - - protected - Database - $database - - - - - - -
      -
      -

      - $framework - - - -

      - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
      -
      - -
      -

      - Methods - -

      -
      -

      - __construct() - -

      - - - - - public - __construct(ContainerInterface $container) : mixed - -
      - -
      Parameters
      -
      -
      - $container - : ContainerInterface -
      -
      -
      - -
      -
      - - - -
      Return values
      - mixed - — - - -
      -
      -

      - cacheValue() - -

      - - -

      Store a given value to cache.

      - - - public - cacheValue(string $key,  $value) : bool - - -
      Parameters
      -
      -
      - $key - : string -
      -
      -
      - -
      -
      - $value - : -
      -
      - -
      -
      - - -
      - Tags - -
      -
      -
      - throws -
      -
      - Exception - - -
      -
      - -
      Return values
      - bool - — - - -
      -
      -

      - getValue() - -

      - - -

      Retrieve a value from cache.

      - - - public - getValue(string $key) : mixed - - -
      Parameters
      -
      -
      - $key - : string -
      -
      -
      - -
      -
      - - - -
      Return values
      - mixed - — - - -
      -
      -

      - keyExists() - -

      - - -

      Check for a given cache key.

      - - - public - keyExists(string $key) : bool - - -
      Parameters
      -
      -
      - $key - : string -
      -
      -
      - -
      -
      - - - -
      Return values
      - bool - — - - -
      -
      - - - - -
      -
      -
      -
      -

      Search results

      - -
      -
      -
        -
        -
        -
        -
        -
        - - -
        - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Cache-DatabaseTreeCache.html b/classes/HeimrichHannot-UtilsBundle-Cache-DatabaseTreeCache.html deleted file mode 100644 index 213343cd..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Cache-DatabaseTreeCache.html +++ /dev/null @@ -1,1330 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
        -

        Contao Utils Bundle

        - - -
        - -
        - - -
        - -
        -
        - - - - -
        - - -
        -

        - DatabaseTreeCache - - -
        - in package - -
        - - -

        - - - - -
        - - - - - - - - -

        - Table of Contents - -

        - -
        -
        - $cache - -  : array<string|int, mixed> -
        -
        Cache tree.
        - -
        - $cacheDir - -  : string -
        -
        Tree cache directory.
        - -
        - $containerUtil - -  : ContainerUtil -
        -
        - -
        - $database - -  : Database -
        -
        - -
        - $filesystem - -  : Filesystem -
        -
        - -
        - $framework - -  : ContaoFrameworkInterface -
        -
        - -
        - $modelUtil - -  : ModelUtil -
        -
        - -
        - $requestStack - -  : RequestStack -
        -
        - -
        - __construct() - -  : mixed -
        -
        - -
        - addConfigToTreeCache() - -  : mixed -
        -
        - -
        - generateAllCacheTree() - -  : mixed -
        -
        Generate all cache trees.
        - -
        - generateCacheTree() - -  : array<string|int, mixed> -
        -
        Generate the flat cache tree.
        - -
        - getChildRecords() - -  : array<string|int, mixed> -
        -
        Get all child records for given parent entities.
        - -
        - getParentRecords() - -  : array<string|int, mixed> -
        -
        Get all parent records for given child entity.
        - -
        - getTreeCache() - -  : array<string|int, mixed>|null -
        -
        Get the tree cache for a given table and key.
        - -
        - loadDataContainer() - -  : mixed -
        -
        Generate tree cache.
        - -
        - purgeCacheTree() - -  : mixed -
        -
        Purge the tree cache completely in order to take table relations into consideration.
        - -
        - registerDcaToCacheTree() - -  : bool -
        -
        Register a dca to the tree cache.
        - -
        - isCompleteInstallation() - -  : mixed -
        -
        - -
        - - - - - - -
        -

        - Properties - -

        -
        -

        - $cache - - - -

        - - -

        Cache tree.

        - - - protected - static array<string|int, mixed> - $cache - = [] - - - - - -
        -
        -

        - $cacheDir - - - -

        - - -

        Tree cache directory.

        - - - protected - string - $cacheDir - - - - - - -
        - -
        -

        - $database - - - -

        - - - - - protected - Database - $database - - - - - - -
        -
        -

        - $filesystem - - - -

        - - - - - protected - Filesystem - $filesystem - - - - - - -
        -
        -

        - $framework - - - -

        - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
        - -
        -

        - $requestStack - - - -

        - - - - - protected - RequestStack - $requestStack - - - - - - -
        -
        - -
        -

        - Methods - -

        -
        -

        - __construct() - -

        - - - - - public - __construct(ContaoFrameworkInterface $framework, Filesystem $filesystem, ModelUtil $modelUtil, ContainerUtil $containerUtil, RequestStack $requestStack) : mixed - -
        - -
        Parameters
        -
        -
        - $framework - : ContaoFrameworkInterface -
        -
        -
        - -
        -
        - $filesystem - : Filesystem -
        -
        -
        - -
        -
        - $modelUtil - : ModelUtil -
        -
        -
        - -
        -
        - $containerUtil - : ContainerUtil -
        -
        -
        - -
        -
        - $requestStack - : RequestStack -
        -
        -
        - -
        -
        - - - -
        Return values
        - mixed - — - - -
        -
        -

        - addConfigToTreeCache() - -

        - - - - - public - addConfigToTreeCache(string $table, string $key[, array<string|int, mixed> $config = [] ]) : mixed - -
        - -
        Parameters
        -
        -
        - $table - : string -
        -
        -
        - -
        -
        - $key - : string -
        -
        -
        - -
        -
        - $config - : array<string|int, mixed> - = []
        -
        -
        - -
        -
        - - - -
        Return values
        - mixed - — - - -
        -
        -

        - generateAllCacheTree() - -

        - - -

        Generate all cache trees.

        - - - public - generateAllCacheTree( $cacheDir) : mixed - - -
        Parameters
        -
        -
        - $cacheDir - : -
        -
        - -
        -
        - - - -
        Return values
        - mixed - — - - -
        -
        -

        - generateCacheTree() - -

        - - -

        Generate the flat cache tree.

        - - - public - generateCacheTree(string $table[, array<string|int, mixed> $ids = [] ][, string $key = 'id' ][, array<string|int, mixed> $config = [] ][, array<string|int, mixed> $return = [] ]) : array<string|int, mixed> - - -
        Parameters
        -
        -
        - $table - : string -
        -
        -

        The database table

        -
        - -
        -
        - $ids - : array<string|int, mixed> - = []
        -
        -

        Root identifiers (parent ids)

        -
        - -
        -
        - $key - : string - = 'id'
        -
        -

        Custom index key (default: primary key from model)

        -
        - -
        -
        - $config - : array<string|int, mixed> - = []
        -
        -

        Tree config

        -
        - -
        -
        - $return - : array<string|int, mixed> - = []
        -
        -

        Internal return array

        -
        - -
        -
        - - - -
        Return values
        - array<string|int, mixed> - — -

        The flat cache tree

        -
        - - -
        -
        -

        - getChildRecords() - -

        - - -

        Get all child records for given parent entities.

        - - - public - getChildRecords(string $table[, array<string|int, mixed> $ids = [] ][, int $maxLevels = null ][, string $key = 'id' ][, array<string|int, mixed> $children = [] ], int $level) : array<string|int, mixed> - - -
        Parameters
        -
        -
        - $table - : string -
        -
        -

        The database table

        -
        - -
        -
        - $ids - : array<string|int, mixed> - = []
        -
        -

        The parent entity ids

        -
        - -
        -
        - $maxLevels - : int - = null
        -
        -

        The max stop level

        -
        - -
        -
        - $key - : string - = 'id'
        -
        -
        - -
        -
        - $children - : array<string|int, mixed> - = []
        -
        -

        Internal children return array

        -
        - -
        -
        - $level - : int -
        -
        -

        Internal depth attribute

        -
        - -
        -
        - - - -
        Return values
        - array<string|int, mixed> - — -

        An array containing all children for given parent entities

        -
        - - -
        -
        -

        - getParentRecords() - -

        - - -

        Get all parent records for given child entity.

        - - - public - getParentRecords(string $table, int $id[, int $maxLevels = null ][, string $key = 'id' ][, array<string|int, mixed> $parents = [] ], int $level) : array<string|int, mixed> - - -
        Parameters
        -
        -
        - $table - : string -
        -
        -

        The database table

        -
        - -
        -
        - $id - : int -
        -
        -

        The current entity id

        -
        - -
        -
        - $maxLevels - : int - = null
        -
        -

        The max stop level

        -
        - -
        -
        - $key - : string - = 'id'
        -
        -
        - -
        -
        - $parents - : array<string|int, mixed> - = []
        -
        -

        Internal children return array

        -
        - -
        -
        - $level - : int -
        -
        -

        Internal depth attribute

        -
        - -
        -
        - - - -
        Return values
        - array<string|int, mixed> - — -

        An array containing all children for given parent entities

        -
        - - -
        -
        -

        - getTreeCache() - -

        - - -

        Get the tree cache for a given table and key.

        - - - public - getTreeCache(string $table, mixed $key) : array<string|int, mixed>|null - - -
        Parameters
        -
        -
        - $table - : string -
        -
        -

        The database table

        -
        - -
        -
        - $key - : mixed -
        -
        -
        - -
        -
        - - - -
        Return values
        - array<string|int, mixed>|null - — - - -
        -
        -

        - loadDataContainer() - -

        - - -

        Generate tree cache.

        - - - public - loadDataContainer(mixed $table) : mixed - - -
        Parameters
        -
        -
        - $table - : mixed -
        -
        -
        - -
        -
        - - - -
        Return values
        - mixed - — - - -
        -
        -

        - purgeCacheTree() - -

        - - -

        Purge the tree cache completely in order to take table relations into consideration.

        - - - public - purgeCacheTree() : mixed - - - - - -
        Return values
        - mixed - — - - -
        -
        -

        - registerDcaToCacheTree() - -

        - - -

        Register a dca to the tree cache.

        - - - public - registerDcaToCacheTree(string $table[, array<string|int, mixed> $columns = [] ][, array<string|int, mixed> $values = [] ][, array<string|int, mixed> $options = [] ][, string $key = 'id' ]) : bool - - -
        Parameters
        -
        -
        - $table - : string -
        -
        -

        (The dca table)

        -
        - -
        -
        - $columns - : array<string|int, mixed> - = []
        -
        -

        Parent sql filter columns (e.g. tl_page.type)

        -
        - -
        -
        - $values - : array<string|int, mixed> - = []
        -
        -

        Parent sql filter values (e.g. root for tl_page.type)

        -
        - -
        -
        - $options - : array<string|int, mixed> - = []
        -
        -

        SQL Options for sorting

        -
        - -
        -
        - $key - : string - = 'id'
        -
        -
        - -
        -
        - - - -
        Return values
        - bool - — -

        Acknowledge state if register succeeded

        -
        - - -
        -
        -

        - isCompleteInstallation() - -

        - - - - - private - isCompleteInstallation(mixed $table) : mixed - -
        - -
        Parameters
        -
        -
        - $table - : mixed -
        -
        -
        - -
        -
        - - - -
        Return values
        - mixed - — - - -
        -
        - - - - -
        -
        -
        -
        -

        Search results

        - -
        -
        -
          -
          -
          -
          -
          -
          - - -
          - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Cache-FileCache.html b/classes/HeimrichHannot-UtilsBundle-Cache-FileCache.html deleted file mode 100644 index b995ad9c..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Cache-FileCache.html +++ /dev/null @@ -1,1372 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
          -

          Contao Utils Bundle

          - - -
          - -
          - - -
          - -
          -
          - - - - -
          - - -
          -

          - FileCache - - -
          - in package - -
          - - -

          - - - -

          Class FileCache.

          - -

          The cache will be created in the cache folder defined by the config (default the huh.utils.filecache.folder parameter) -Within the cache folder you can specify a namespace serving as subfolder.

          -
          - - -
          - Tags - -
          -
          -
          - deprecated -
          -
          - -

          Will be removed in version 3.0. Use FileStorageUtil instead.

          -
          - -
          -
          - codeCoverageIgnore -
          -
          - - -
          -
          - - - - - - -

          - Table of Contents - -

          - -
          -
          - $cacheFolder - -  : string -
          -
          The folder where the images should be cached.
          - -
          - $cacheFolderWithNamespace - -  : string -
          -
          The complete path to the current cache folder including namespace.
          - -
          - $container - -  : ContainerInterface -
          -
          - -
          - $namespace - -  : string -
          -
          The subfolder within the cache folder.
          - -
          - $fileUtil - -  : FileUtil -
          -
          - -
          - $projectDir - -  : string -
          -
          - -
          - __construct() - -  : mixed -
          -
          - -
          - exist() - -  : bool -
          -
          Checks if a cached file already exist in cache. Namespace is taken into account.
          - -
          - generateCacheName() - -  : string -
          -
          Generate a file name for cache.
          - -
          - get() - -  : bool|string -
          -
          Get the file path for the given identifier. Namespace is taken into account.
          - -
          - getAbsoluteCachePath() - -  : string -
          -
          Returns the absolute path to the cache folder.
          - -
          - getCacheFileName() - -  : string -
          -
          Get the cache file name by the given identifier.
          - -
          - getCacheFilePath() - -  : string -
          -
          Same as generateCacheName, but returns complete path to cache.
          - -
          - getCacheFolder() - -  : string -
          -
          The cache folder (without namespace).
          - -
          - getCacheFolderWithNamespace() - -  : string -
          -
          Get the cache folder (including namespace).
          - -
          - getNamespace() - -  : string -
          -
          - -
          - setCacheFolder() - -  : mixed -
          -
          Set cache folder (without namespace).
          - -
          - setNamespace() - -  : mixed -
          -
          - -
          - generatePath() - -  : mixed -
          -
          Recreates the path to the current cache folder.
          - -
          - - - - - - -
          -

          - Properties - -

          -
          -

          - $cacheFolder - - - -

          - - -

          The folder where the images should be cached.

          - - - protected - string - $cacheFolder - - - - - - -
          -
          -

          - $cacheFolderWithNamespace - - - -

          - - -

          The complete path to the current cache folder including namespace.

          - - - protected - string - $cacheFolderWithNamespace - - - - - - -
          -
          -

          - $container - - - -

          - - - - - protected - ContainerInterface - $container - - - - - - -
          -
          -

          - $namespace - - - -

          - - -

          The subfolder within the cache folder.

          - - - protected - string - $namespace - = '' - - - - - -
          -
          -

          - $fileUtil - - - -

          - - - - - private - FileUtil - $fileUtil - - - - - - -
          -
          -

          - $projectDir - - - -

          - - - - - private - string - $projectDir - - - - - - -
          -
          - -
          -

          - Methods - -

          -
          -

          - __construct() - -

          - - - - - public - __construct(ContainerInterface $container) : mixed - -
          - -
          Parameters
          -
          -
          - $container - : ContainerInterface -
          -
          -
          - -
          -
          - - - -
          Return values
          - mixed - — - - -
          -
          -

          - exist() - -

          - - -

          Checks if a cached file already exist in cache. Namespace is taken into account.

          - - - public - exist(string $identifier[, string $fileExtension = '' ]) : bool - - -
          Parameters
          -
          -
          - $identifier - : string -
          -
          -

          The identifier

          -
          - -
          -
          - $fileExtension - : string - = ''
          -
          -

          If not set, a file with no file extension is searched

          -
          - -
          -
          - - -
          - Tags - -
          -
          -
          - throws -
          -
          - Exception - - -
          -
          - deprecated -
          -
          - -

          Will be removed in 3.0. Use FileStorageUtil instead

          -
          - -
          -
          - -
          Return values
          - bool - — - - -
          -
          -

          - generateCacheName() - -

          - - -

          Generate a file name for cache.

          - - - public - generateCacheName([string $identifier = '' ][, string $prefix = '' ][, bool $more_entropy = true ][, string $fileExtension = '' ]) : string - -

          If a identifier is given, you get the resulting file name. -If no identifier is given, if will return a unique file name without extension.

          -
          - -
          Parameters
          -
          -
          - $identifier - : string - = ''
          -
          -

          An identifier for the cache. For example be the source file name or path. If empty, a unique filename will be generated.

          -
          - -
          -
          - $prefix - : string - = ''
          -
          -

          Adds a prefix to the generated name. Only if $identifier is empty.

          -
          - -
          -
          - $more_entropy - : bool - = true
          -
          -

          A longer name for the unique filename. Only if $identifier is empty. Default

          -
          - -
          -
          - $fileExtension - : string - = ''
          -
          -

          optional: If set, the file extension will be appended to the generated file name

          -
          - -
          -
          - - -
          - Tags - -
          -
          -
          - deprecated -
          -
          - -

          Will be removed in 3.0. Use FileStorageUtil instead

          -
          - -
          -
          - -
          Return values
          - string - — -

          a unique filename for caching

          -
          - - -
          -
          -

          - get() - -

          - - -

          Get the file path for the given identifier. Namespace is taken into account.

          - - - public - get(string $identifier[, string $fileExtension = '' ][, callable $saveCallback = null ]) : bool|string - - -
          Parameters
          -
          -
          - $identifier - : string -
          -
          -
          - -
          -
          - $fileExtension - : string - = ''
          -
          -
          - -
          -
          - $saveCallback - : callable - = null
          -
          -

          A callback handles the file save functionality. Get filepath, filename and the identifier as parameter. Expects a boolean return value.

          -
          - -
          -
          - - -
          - Tags - -
          -
          -
          - throws -
          -
          - Exception - - -
          -
          - deprecated -
          -
          - -

          Will be removed in 3.0. Use FileStorageUtil instead

          -
          - -
          -
          - -
          Return values
          - bool|string - — -

          returns the path of the cached file or false, if cached file could not be found

          -
          - - -
          -
          -

          - getAbsoluteCachePath() - -

          - - -

          Returns the absolute path to the cache folder.

          - - - public - getAbsoluteCachePath() : string - - - - -
          - Tags - -
          -
          -
          - deprecated -
          -
          - -

          Will be removed in 3.0. Use FileStorageUtil instead

          -
          - -
          -
          - -
          Return values
          - string - — - - -
          -
          -

          - getCacheFileName() - -

          - - -

          Get the cache file name by the given identifier.

          - - - public - getCacheFileName( $identifier) : string - - -
          Parameters
          -
          -
          - $identifier - : -
          -
          - -
          -
          - - -
          - Tags - -
          -
          -
          - deprecated -
          -
          - -

          Will be removed in 3.0. Use FileStorageUtil instead

          -
          - -
          -
          - -
          Return values
          - string - — - - -
          -
          -

          - getCacheFilePath() - -

          - - -

          Same as generateCacheName, but returns complete path to cache.

          - - - public - getCacheFilePath([string $filename = '' ][, string $prefix = '' ][, bool $more_entropy = true ]) : string - -

          If no filename is given, you need to add the file extension by yourself!

          -
          - -
          Parameters
          -
          -
          - $filename - : string - = ''
          -
          -

          The filename of the file that should be cached. If empty, a unique filename will be generated.

          -
          - -
          -
          - $prefix - : string - = ''
          -
          -

          Adds a prefix to the generated name. Only if $filename is empty.

          -
          - -
          -
          - $more_entropy - : bool - = true
          -
          -

          A longer name for the unique filename. Only if filename is empty. Default

          -
          - -
          -
          - - -
          - Tags - -
          -
          -
          - deprecated -
          -
          - -

          Will be removed in 3.0. Use FileStorageUtil instead

          -
          - -
          -
          - -
          Return values
          - string - — -

          the path including the filename to save the file to the cache

          -
          - - -
          -
          -

          - getCacheFolder() - -

          - - -

          The cache folder (without namespace).

          - - - public - getCacheFolder() : string - - - - -
          - Tags - -
          -
          -
          - deprecated -
          -
          - -

          Will be removed in 3.0. Use FileStorageUtil instead

          -
          - -
          -
          - -
          Return values
          - string - — - - -
          -
          -

          - getCacheFolderWithNamespace() - -

          - - -

          Get the cache folder (including namespace).

          - - - public - getCacheFolderWithNamespace() : string - - - - -
          - Tags - -
          -
          -
          - deprecated -
          -
          - -

          Will be removed in 3.0. Use FileStorageUtil instead

          -
          - -
          -
          - -
          Return values
          - string - — - - -
          -
          -

          - getNamespace() - -

          - - - - - public - getNamespace() : string - - - - -
          - Tags - -
          -
          -
          - deprecated -
          -
          - -

          Will be removed in 3.0. Use FileStorageUtil instead

          -
          - -
          -
          - -
          Return values
          - string - — - - -
          -
          -

          - setCacheFolder() - -

          - - -

          Set cache folder (without namespace).

          - - - public - setCacheFolder(string $cacheFolder) : mixed - - -
          Parameters
          -
          -
          - $cacheFolder - : string -
          -
          -
          - -
          -
          - - -
          - Tags - -
          -
          -
          - deprecated -
          -
          - -

          Will be removed in 3.0. Use FileStorageUtil instead

          -
          - -
          -
          - -
          Return values
          - mixed - — - - -
          -
          -

          - setNamespace() - -

          - - - - - public - setNamespace(string $namespace) : mixed - - -
          Parameters
          -
          -
          - $namespace - : string -
          -
          -
          - -
          -
          - - -
          - Tags - -
          -
          -
          - deprecated -
          -
          - -

          Will be removed in 3.0. Use FileStorageUtil instead

          -
          - -
          -
          - -
          Return values
          - mixed - — - - -
          -
          -

          - generatePath() - -

          - - -

          Recreates the path to the current cache folder.

          - - - protected - generatePath() : mixed - - - - - -
          Return values
          - mixed - — - - -
          -
          - - - - -
          -
          -
          -
          -

          Search results

          - -
          -
          -
            -
            -
            -
            -
            -
            - - -
            - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Cache-RemoteImageCache.html b/classes/HeimrichHannot-UtilsBundle-Cache-RemoteImageCache.html deleted file mode 100644 index 4047f8e4..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Cache-RemoteImageCache.html +++ /dev/null @@ -1,464 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
            -

            Contao Utils Bundle

            - - -
            - -
            - - -
            - -
            -
            - - - - -
            - - -
            -

            - RemoteImageCache - - -
            - in package - -
            - - -

            - - - - -
            - - - - - - - - -

            - Table of Contents - -

            - -
            -
            - $framework - -  : ContaoFrameworkInterface -
            -
            - -
            - $container - -  : ContainerInterface -
            -
            - -
            - __construct() - -  : mixed -
            -
            - -
            - get() - -  : bool|string -
            -
            Get a remote file from cache and cache file, if not already in cache.
            - -
            - - - - - - -
            -

            - Properties - -

            -
            -

            - $framework - - - -

            - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
            -
            -

            - $container - - - -

            - - - - - private - ContainerInterface - $container - - - - - - -
            -
            - -
            -

            - Methods - -

            -
            -

            - __construct() - -

            - - - - - public - __construct(ContainerInterface $container) : mixed - -
            - -
            Parameters
            -
            -
            - $container - : ContainerInterface -
            -
            -
            - -
            -
            - - - -
            Return values
            - mixed - — - - -
            -
            -

            - get() - -

            - - -

            Get a remote file from cache and cache file, if not already in cache.

            - - - public - get(string $identifier, string $folder, string $remoteUrl[, bool $returnUuid = false ]) : bool|string - -

            Returns false, if remote file could not be fetched or given uuid is not valid. -Else returns the url or, if $returnUuid is set true, the uuid of the image.

            -
            - -
            Parameters
            -
            -
            - $identifier - : string -
            -
            -

            Used as filename of the cached image. Should be unique within the folder scope

            -
            - -
            -
            - $folder - : string -
            -
            -

            Folder path or uuid of the file

            -
            - -
            -
            - $remoteUrl - : string -
            -
            -

            The url of the cached (or to cache) file

            -
            - -
            -
            - $returnUuid - : bool - = false
            -
            -

            Return uuid instead of the path

            -
            - -
            -
            - - -
            - Tags - -
            -
            -
            - throws -
            -
            - Exception - - -
            -
            - -
            Return values
            - bool|string - — - - -
            -
            - - - - -
            -
            -
            -
            -

            Search results

            - -
            -
            -
              -
              -
              -
              -
              -
              - - -
              - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Cache-UtilCacheWarmer.html b/classes/HeimrichHannot-UtilsBundle-Cache-UtilCacheWarmer.html deleted file mode 100644 index 1cd18754..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Cache-UtilCacheWarmer.html +++ /dev/null @@ -1,741 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
              -

              Contao Utils Bundle

              - - -
              - -
              - - -
              - -
              -
              - - - - -
              - - -
              -

              - UtilCacheWarmer - - -
              - in package - -
              - - - implements - CacheWarmerInterface - -

              - - - - -
              - - - - - - -

              - Interfaces, Classes and Traits - -

              - -
              -
              CacheWarmerInterface
              -
              - - -
              - - -

              - Table of Contents - -

              - -
              -
              - $connection - -  : Connection -
              -
              - -
              - $filesystem - -  : Filesystem -
              -
              - -
              - $framework - -  : ContaoFrameworkInterface -
              -
              - -
              - $templateUtil - -  : TemplateUtil -
              -
              - -
              - __construct() - -  : mixed -
              -
              Constructor.
              - -
              - isOptional() - -  : mixed -
              -
              {@inheritdoc}
              - -
              - warmUp() - -  : mixed -
              -
              {@inheritdoc}
              - -
              - generateDatabaseTreeCache() - -  : mixed -
              -
              - -
              - generateTemplateMapper() - -  : mixed -
              -
              Generates the template mapper array.
              - -
              - isCompleteInstallation() - -  : bool -
              -
              Checks if the installation is complete.
              - -
              - - - - - - -
              -

              - Properties - -

              -
              -

              - $connection - - - -

              - - - - - private - Connection - $connection - - - - - - -
              -
              -

              - $filesystem - - - -

              - - - - - private - Filesystem - $filesystem - - - - - - -
              -
              -

              - $framework - - - -

              - - - - - private - ContaoFrameworkInterface - $framework - - - - - - -
              - -
              - -
              -

              - Methods - -

              -
              -

              - __construct() - -

              - - -

              Constructor.

              - - - public - __construct(Filesystem $filesystem, ResourceFinderInterface $finder, FileLocator $locator, string $rootDir, Connection $connection, TemplateUtil $templateUtil, ContaoFrameworkInterface $framework) : mixed - - -
              Parameters
              -
              -
              - $filesystem - : Filesystem -
              -
              -
              - -
              -
              - $finder - : ResourceFinderInterface -
              -
              -
              - -
              -
              - $locator - : FileLocator -
              -
              -
              - -
              -
              - $rootDir - : string -
              -
              - -
              -
              - $connection - : Connection -
              -
              -
              - -
              -
              - $templateUtil - : TemplateUtil -
              -
              -
              - -
              -
              - $framework - : ContaoFrameworkInterface -
              -
              -
              - -
              -
              - - - -
              Return values
              - mixed - — - - -
              -
              -

              - isOptional() - -

              - - -

              {@inheritdoc}

              - - - public - isOptional() : mixed - - - - - -
              Return values
              - mixed - — - - -
              -
              -

              - warmUp() - -

              - - -

              {@inheritdoc}

              - - - public - warmUp(mixed $cacheDir) : mixed - - -
              Parameters
              -
              -
              - $cacheDir - : mixed -
              -
              -
              - -
              -
              - - - -
              Return values
              - mixed - — - - -
              -
              -

              - generateDatabaseTreeCache() - -

              - - - - - private - generateDatabaseTreeCache(mixed $cacheDir) : mixed - -
              - -
              Parameters
              -
              -
              - $cacheDir - : mixed -
              -
              -
              - -
              -
              - - - -
              Return values
              - mixed - — - - -
              -
              -

              - generateTemplateMapper() - -

              - - -

              Generates the template mapper array.

              - - - private - generateTemplateMapper(string $cacheDir) : mixed - - -
              Parameters
              -
              -
              - $cacheDir - : string -
              -
              -

              The cache directory

              -
              - -
              -
              - - - -
              Return values
              - mixed - — - - -
              -
              -

              - isCompleteInstallation() - -

              - - -

              Checks if the installation is complete.

              - - - private - isCompleteInstallation() : bool - - - - - -
              Return values
              - bool - — - - -
              -
              - - - - -
              -
              -
              -
              -

              Search results

              - -
              -
              -
                -
                -
                -
                -
                -
                - - -
                - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Choice-AbstractChoice.html b/classes/HeimrichHannot-UtilsBundle-Choice-AbstractChoice.html deleted file mode 100644 index d2db97f6..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Choice-AbstractChoice.html +++ /dev/null @@ -1,718 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                -

                Contao Utils Bundle

                - - -
                - -
                - - -
                - -
                -
                - - - - -
                - - -
                -

                - AbstractChoice - - -
                - in package - -
                - - -

                - - - - -
                - - - - - - - - -

                - Table of Contents - -

                - -
                -
                - $cache - -  : FilesystemAdapter -
                -
                Current file cache.
                - -
                - $cacheKey - -  : string -
                -
                Current cache key name.
                - -
                - $context - -  : mixed -
                -
                Current context.
                - -
                - $data - -  : array<string|int, mixed> -
                -
                Context data.
                - -
                - $framework - -  : ContaoFrameworkInterface -
                -
                - -
                - __construct() - -  : mixed -
                -
                - -
                - getCachedChoices() - -  : mixed -
                -
                - -
                - getChoices() - -  : mixed -
                -
                - -
                - getContext() - -  : mixed -
                -
                - -
                - setContext() - -  : mixed -
                -
                - -
                - collect() - -  : array<string|int, mixed> -
                -
                - -
                - - - - - - -
                -

                - Properties - -

                -
                -

                - $cache - - - -

                - - -

                Current file cache.

                - - - protected - FilesystemAdapter - $cache - = null - - - - - -
                -
                -

                - $cacheKey - - - -

                - - -

                Current cache key name.

                - - - protected - string - $cacheKey - - - - - - -
                -
                -

                - $context - - - -

                - - -

                Current context.

                - - - protected - mixed - $context - - - - - - -
                -
                -

                - $data - - - -

                - - -

                Context data.

                - - - protected - array<string|int, mixed> - $data - = [] - - - - - -
                -
                -

                - $framework - - - -

                - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
                -
                - -
                -

                - Methods - -

                -
                -

                - __construct() - -

                - - - - - public - __construct(ContaoFrameworkInterface $framework) : mixed - -
                - -
                Parameters
                -
                -
                - $framework - : ContaoFrameworkInterface -
                -
                -
                - -
                -
                - - - -
                Return values
                - mixed - — - - -
                -
                -

                - getCachedChoices() - -

                - - - - - public - getCachedChoices([mixed $context = [] ]) : mixed - -
                - -
                Parameters
                -
                -
                - $context - : mixed - = []
                -
                -
                - -
                -
                - - - -
                Return values
                - mixed - — - - -
                -
                -

                - getChoices() - -

                - - - - - public - getChoices([mixed $context = [] ]) : mixed - -
                - -
                Parameters
                -
                -
                - $context - : mixed - = []
                -
                -
                - -
                -
                - - - -
                Return values
                - mixed - — - - -
                -
                -

                - getContext() - -

                - - - - - public - getContext() : mixed - - - - - -
                Return values
                - mixed - — - - -
                -
                -

                - setContext() - -

                - - - - - public - setContext(mixed $context) : mixed - - -
                Parameters
                -
                -
                - $context - : mixed -
                -
                - -
                -
                - - - -
                Return values
                - mixed - — - - -
                -
                -

                - collect() - -

                - - - - - protected - abstract collect() : array<string|int, mixed> - - - - - -
                Return values
                - array<string|int, mixed> - — - - -
                -
                - - - - -
                -
                -
                -
                -

                Search results

                - -
                -
                -
                  -
                  -
                  -
                  -
                  -
                  - - -
                  - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Choice-DataContainerChoice.html b/classes/HeimrichHannot-UtilsBundle-Choice-DataContainerChoice.html deleted file mode 100644 index 33eb2a54..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Choice-DataContainerChoice.html +++ /dev/null @@ -1,721 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                  -

                  Contao Utils Bundle

                  - - -
                  - -
                  - - -
                  - -
                  -
                  - - - - -
                  - - -
                  -

                  - DataContainerChoice - - - extends AbstractChoice - - -
                  - in package - -
                  - - -

                  - - - - -
                  - - - - - - - - -

                  - Table of Contents - -

                  - -
                  -
                  - $cache - -  : FilesystemAdapter -
                  -
                  Current file cache.
                  - -
                  - $cacheKey - -  : string -
                  -
                  Current cache key name.
                  - -
                  - $context - -  : mixed -
                  -
                  Current context.
                  - -
                  - $data - -  : array<string|int, mixed> -
                  -
                  Context data.
                  - -
                  - $framework - -  : ContaoFrameworkInterface -
                  -
                  - -
                  - __construct() - -  : mixed -
                  -
                  - -
                  - getCachedChoices() - -  : mixed -
                  -
                  - -
                  - getChoices() - -  : mixed -
                  -
                  - -
                  - getContext() - -  : mixed -
                  -
                  - -
                  - setContext() - -  : mixed -
                  -
                  - -
                  - collect() - -  : array<string|int, mixed> -
                  -
                  - -
                  - - - - - - -
                  -

                  - Properties - -

                  -
                  -

                  - $cache - - - -

                  - - -

                  Current file cache.

                  - - - protected - FilesystemAdapter - $cache - = null - - - - - -
                  -
                  -

                  - $cacheKey - - - -

                  - - -

                  Current cache key name.

                  - - - protected - string - $cacheKey - - - - - - -
                  -
                  -

                  - $context - - - -

                  - - -

                  Current context.

                  - - - protected - mixed - $context - - - - - - -
                  -
                  -

                  - $data - - - -

                  - - -

                  Context data.

                  - - - protected - array<string|int, mixed> - $data - = [] - - - - - -
                  -
                  -

                  - $framework - - - -

                  - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
                  -
                  - -
                  -

                  - Methods - -

                  -
                  -

                  - __construct() - -

                  - - - - - public - __construct(ContaoFrameworkInterface $framework) : mixed - -
                  - -
                  Parameters
                  -
                  -
                  - $framework - : ContaoFrameworkInterface -
                  -
                  -
                  - -
                  -
                  - - - -
                  Return values
                  - mixed - — - - -
                  -
                  -

                  - getCachedChoices() - -

                  - - - - - public - getCachedChoices([mixed $context = [] ]) : mixed - -
                  - -
                  Parameters
                  -
                  -
                  - $context - : mixed - = []
                  -
                  -
                  - -
                  -
                  - - - -
                  Return values
                  - mixed - — - - -
                  -
                  -

                  - getChoices() - -

                  - - - - - public - getChoices([mixed $context = [] ]) : mixed - -
                  - -
                  Parameters
                  -
                  -
                  - $context - : mixed - = []
                  -
                  -
                  - -
                  -
                  - - - -
                  Return values
                  - mixed - — - - -
                  -
                  -

                  - getContext() - -

                  - - - - - public - getContext() : mixed - - - - - -
                  Return values
                  - mixed - — - - -
                  -
                  -

                  - setContext() - -

                  - - - - - public - setContext(mixed $context) : mixed - - -
                  Parameters
                  -
                  -
                  - $context - : mixed -
                  -
                  - -
                  -
                  - - - -
                  Return values
                  - mixed - — - - -
                  -
                  -

                  - collect() - -

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

                  Search results

                  - -
                  -
                  -
                    -
                    -
                    -
                    -
                    -
                    - - -
                    - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Choice-FieldChoice.html b/classes/HeimrichHannot-UtilsBundle-Choice-FieldChoice.html deleted file mode 100644 index b8e93b9c..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Choice-FieldChoice.html +++ /dev/null @@ -1,721 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                    -

                    Contao Utils Bundle

                    - - -
                    - -
                    - - -
                    - -
                    -
                    - - - - -
                    - - -
                    -

                    - FieldChoice - - - extends AbstractChoice - - -
                    - in package - -
                    - - -

                    - - - - -
                    - - - - - - - - -

                    - Table of Contents - -

                    - -
                    -
                    - $cache - -  : FilesystemAdapter -
                    -
                    Current file cache.
                    - -
                    - $cacheKey - -  : string -
                    -
                    Current cache key name.
                    - -
                    - $context - -  : mixed -
                    -
                    Current context.
                    - -
                    - $data - -  : array<string|int, mixed> -
                    -
                    Context data.
                    - -
                    - $framework - -  : ContaoFrameworkInterface -
                    -
                    - -
                    - __construct() - -  : mixed -
                    -
                    - -
                    - getCachedChoices() - -  : mixed -
                    -
                    - -
                    - getChoices() - -  : mixed -
                    -
                    - -
                    - getContext() - -  : mixed -
                    -
                    - -
                    - setContext() - -  : mixed -
                    -
                    - -
                    - collect() - -  : array<string|int, mixed> -
                    -
                    - -
                    - - - - - - -
                    -

                    - Properties - -

                    -
                    -

                    - $cache - - - -

                    - - -

                    Current file cache.

                    - - - protected - FilesystemAdapter - $cache - = null - - - - - -
                    -
                    -

                    - $cacheKey - - - -

                    - - -

                    Current cache key name.

                    - - - protected - string - $cacheKey - - - - - - -
                    -
                    -

                    - $context - - - -

                    - - -

                    Current context.

                    - - - protected - mixed - $context - - - - - - -
                    -
                    -

                    - $data - - - -

                    - - -

                    Context data.

                    - - - protected - array<string|int, mixed> - $data - = [] - - - - - -
                    -
                    -

                    - $framework - - - -

                    - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
                    -
                    - -
                    -

                    - Methods - -

                    -
                    -

                    - __construct() - -

                    - - - - - public - __construct(ContaoFrameworkInterface $framework) : mixed - -
                    - -
                    Parameters
                    -
                    -
                    - $framework - : ContaoFrameworkInterface -
                    -
                    -
                    - -
                    -
                    - - - -
                    Return values
                    - mixed - — - - -
                    -
                    -

                    - getCachedChoices() - -

                    - - - - - public - getCachedChoices([mixed $context = [] ]) : mixed - -
                    - -
                    Parameters
                    -
                    -
                    - $context - : mixed - = []
                    -
                    -
                    - -
                    -
                    - - - -
                    Return values
                    - mixed - — - - -
                    -
                    -

                    - getChoices() - -

                    - - - - - public - getChoices([mixed $context = [] ]) : mixed - -
                    - -
                    Parameters
                    -
                    -
                    - $context - : mixed - = []
                    -
                    -
                    - -
                    -
                    - - - -
                    Return values
                    - mixed - — - - -
                    -
                    -

                    - getContext() - -

                    - - - - - public - getContext() : mixed - - - - - -
                    Return values
                    - mixed - — - - -
                    -
                    -

                    - setContext() - -

                    - - - - - public - setContext(mixed $context) : mixed - - -
                    Parameters
                    -
                    -
                    - $context - : mixed -
                    -
                    - -
                    -
                    - - - -
                    Return values
                    - mixed - — - - -
                    -
                    -

                    - collect() - -

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

                    Search results

                    - -
                    -
                    -
                      -
                      -
                      -
                      -
                      -
                      - - -
                      - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Choice-MessageChoice.html b/classes/HeimrichHannot-UtilsBundle-Choice-MessageChoice.html deleted file mode 100644 index c5f20deb..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Choice-MessageChoice.html +++ /dev/null @@ -1,721 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                      -

                      Contao Utils Bundle

                      - - -
                      - -
                      - - -
                      - -
                      -
                      - - - - -
                      - - -
                      -

                      - MessageChoice - - - extends AbstractChoice - - -
                      - in package - -
                      - - -

                      - - - - -
                      - - - - - - - - -

                      - Table of Contents - -

                      - -
                      -
                      - $cache - -  : FilesystemAdapter -
                      -
                      Current file cache.
                      - -
                      - $cacheKey - -  : string -
                      -
                      Current cache key name.
                      - -
                      - $context - -  : mixed -
                      -
                      Current context.
                      - -
                      - $data - -  : array<string|int, mixed> -
                      -
                      Context data.
                      - -
                      - $framework - -  : ContaoFrameworkInterface -
                      -
                      - -
                      - __construct() - -  : mixed -
                      -
                      - -
                      - getCachedChoices() - -  : mixed -
                      -
                      - -
                      - getChoices() - -  : mixed -
                      -
                      - -
                      - getContext() - -  : mixed -
                      -
                      - -
                      - setContext() - -  : mixed -
                      -
                      - -
                      - collect() - -  : array<string|int, mixed> -
                      -
                      - -
                      - - - - - - -
                      -

                      - Properties - -

                      -
                      -

                      - $cache - - - -

                      - - -

                      Current file cache.

                      - - - protected - FilesystemAdapter - $cache - = null - - - - - -
                      -
                      -

                      - $cacheKey - - - -

                      - - -

                      Current cache key name.

                      - - - protected - string - $cacheKey - - - - - - -
                      -
                      -

                      - $context - - - -

                      - - -

                      Current context.

                      - - - protected - mixed - $context - - - - - - -
                      -
                      -

                      - $data - - - -

                      - - -

                      Context data.

                      - - - protected - array<string|int, mixed> - $data - = [] - - - - - -
                      -
                      -

                      - $framework - - - -

                      - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
                      -
                      - -
                      -

                      - Methods - -

                      -
                      -

                      - __construct() - -

                      - - - - - public - __construct(ContaoFrameworkInterface $framework) : mixed - -
                      - -
                      Parameters
                      -
                      -
                      - $framework - : ContaoFrameworkInterface -
                      -
                      -
                      - -
                      -
                      - - - -
                      Return values
                      - mixed - — - - -
                      -
                      -

                      - getCachedChoices() - -

                      - - - - - public - getCachedChoices([mixed $context = [] ]) : mixed - -
                      - -
                      Parameters
                      -
                      -
                      - $context - : mixed - = []
                      -
                      -
                      - -
                      -
                      - - - -
                      Return values
                      - mixed - — - - -
                      -
                      -

                      - getChoices() - -

                      - - - - - public - getChoices([mixed $context = [] ]) : mixed - -
                      - -
                      Parameters
                      -
                      -
                      - $context - : mixed - = []
                      -
                      -
                      - -
                      -
                      - - - -
                      Return values
                      - mixed - — - - -
                      -
                      -

                      - getContext() - -

                      - - - - - public - getContext() : mixed - - - - - -
                      Return values
                      - mixed - — - - -
                      -
                      -

                      - setContext() - -

                      - - - - - public - setContext(mixed $context) : mixed - - -
                      Parameters
                      -
                      -
                      - $context - : mixed -
                      -
                      - -
                      -
                      - - - -
                      Return values
                      - mixed - — - - -
                      -
                      -

                      - collect() - -

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

                      Search results

                      - -
                      -
                      -
                        -
                        -
                        -
                        -
                        -
                        - - -
                        - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Choice-ModelInstanceChoice.html b/classes/HeimrichHannot-UtilsBundle-Choice-ModelInstanceChoice.html deleted file mode 100644 index 8e0496bb..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Choice-ModelInstanceChoice.html +++ /dev/null @@ -1,763 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                        -

                        Contao Utils Bundle

                        - - -
                        - -
                        - - -
                        - -
                        -
                        - - - - -
                        - - -
                        -

                        - ModelInstanceChoice - - - extends AbstractChoice - - -
                        - in package - -
                        - - -

                        - - - - -
                        - - - - - - - - -

                        - Table of Contents - -

                        - -
                        -
                        - TITLE_FIELDS - -  = ['name', 'title', 'headline'] -
                        -
                        - -
                        - $cache - -  : FilesystemAdapter -
                        -
                        Current file cache.
                        - -
                        - $cacheKey - -  : string -
                        -
                        Current cache key name.
                        - -
                        - $context - -  : mixed -
                        -
                        Current context.
                        - -
                        - $data - -  : array<string|int, mixed> -
                        -
                        Context data.
                        - -
                        - $framework - -  : ContaoFrameworkInterface -
                        -
                        - -
                        - __construct() - -  : mixed -
                        -
                        - -
                        - getCachedChoices() - -  : mixed -
                        -
                        - -
                        - getChoices() - -  : mixed -
                        -
                        - -
                        - getContext() - -  : mixed -
                        -
                        - -
                        - setContext() - -  : mixed -
                        -
                        - -
                        - collect() - -  : array<string|int, mixed> -
                        -
                        - -
                        - - - - -
                        -

                        - Constants - -

                        -
                        -

                        - TITLE_FIELDS - -

                        - - - - - - public - mixed - TITLE_FIELDS - = ['name', 'title', 'headline'] - - - -
                        - -
                        - - - -
                        -
                        - - -
                        -

                        - Properties - -

                        -
                        -

                        - $cache - - - -

                        - - -

                        Current file cache.

                        - - - protected - FilesystemAdapter - $cache - = null - - - - - -
                        -
                        -

                        - $cacheKey - - - -

                        - - -

                        Current cache key name.

                        - - - protected - string - $cacheKey - - - - - - -
                        -
                        -

                        - $context - - - -

                        - - -

                        Current context.

                        - - - protected - mixed - $context - - - - - - -
                        -
                        -

                        - $data - - - -

                        - - -

                        Context data.

                        - - - protected - array<string|int, mixed> - $data - = [] - - - - - -
                        -
                        -

                        - $framework - - - -

                        - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
                        -
                        - -
                        -

                        - Methods - -

                        -
                        -

                        - __construct() - -

                        - - - - - public - __construct(ContaoFrameworkInterface $framework) : mixed - -
                        - -
                        Parameters
                        -
                        -
                        - $framework - : ContaoFrameworkInterface -
                        -
                        -
                        - -
                        -
                        - - - -
                        Return values
                        - mixed - — - - -
                        -
                        -

                        - getCachedChoices() - -

                        - - - - - public - getCachedChoices([mixed $context = [] ]) : mixed - -
                        - -
                        Parameters
                        -
                        -
                        - $context - : mixed - = []
                        -
                        -
                        - -
                        -
                        - - - -
                        Return values
                        - mixed - — - - -
                        -
                        -

                        - getChoices() - -

                        - - - - - public - getChoices([mixed $context = [] ]) : mixed - -
                        - -
                        Parameters
                        -
                        -
                        - $context - : mixed - = []
                        -
                        -
                        - -
                        -
                        - - - -
                        Return values
                        - mixed - — - - -
                        -
                        -

                        - getContext() - -

                        - - - - - public - getContext() : mixed - - - - - -
                        Return values
                        - mixed - — - - -
                        -
                        -

                        - setContext() - -

                        - - - - - public - setContext(mixed $context) : mixed - - -
                        Parameters
                        -
                        -
                        - $context - : mixed -
                        -
                        - -
                        -
                        - - - -
                        Return values
                        - mixed - — - - -
                        -
                        -

                        - collect() - -

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

                        Search results

                        - -
                        -
                        -
                          -
                          -
                          -
                          -
                          -
                          - - -
                          - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Choice-TwigTemplateChoice.html b/classes/HeimrichHannot-UtilsBundle-Choice-TwigTemplateChoice.html deleted file mode 100644 index 76897321..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Choice-TwigTemplateChoice.html +++ /dev/null @@ -1,721 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                          -

                          Contao Utils Bundle

                          - - -
                          - -
                          - - -
                          - -
                          -
                          - - - - -
                          - - -
                          -

                          - TwigTemplateChoice - - - extends AbstractChoice - - -
                          - in package - -
                          - - -

                          - - - - -
                          - - - - - - - - -

                          - Table of Contents - -

                          - -
                          -
                          - $cache - -  : FilesystemAdapter -
                          -
                          Current file cache.
                          - -
                          - $cacheKey - -  : string -
                          -
                          Current cache key name.
                          - -
                          - $context - -  : mixed -
                          -
                          Current context.
                          - -
                          - $data - -  : array<string|int, mixed> -
                          -
                          Context data.
                          - -
                          - $framework - -  : ContaoFrameworkInterface -
                          -
                          - -
                          - __construct() - -  : mixed -
                          -
                          - -
                          - getCachedChoices() - -  : mixed -
                          -
                          - -
                          - getChoices() - -  : mixed -
                          -
                          - -
                          - getContext() - -  : mixed -
                          -
                          - -
                          - setContext() - -  : mixed -
                          -
                          - -
                          - collect() - -  : array<string|int, mixed> -
                          -
                          - -
                          - - - - - - -
                          -

                          - Properties - -

                          -
                          -

                          - $cache - - - -

                          - - -

                          Current file cache.

                          - - - protected - FilesystemAdapter - $cache - = null - - - - - -
                          -
                          -

                          - $cacheKey - - - -

                          - - -

                          Current cache key name.

                          - - - protected - string - $cacheKey - - - - - - -
                          -
                          -

                          - $context - - - -

                          - - -

                          Current context.

                          - - - protected - mixed - $context - - - - - - -
                          -
                          -

                          - $data - - - -

                          - - -

                          Context data.

                          - - - protected - array<string|int, mixed> - $data - = [] - - - - - -
                          -
                          -

                          - $framework - - - -

                          - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
                          -
                          - -
                          -

                          - Methods - -

                          -
                          -

                          - __construct() - -

                          - - - - - public - __construct(ContaoFrameworkInterface $framework) : mixed - -
                          - -
                          Parameters
                          -
                          -
                          - $framework - : ContaoFrameworkInterface -
                          -
                          -
                          - -
                          -
                          - - - -
                          Return values
                          - mixed - — - - -
                          -
                          -

                          - getCachedChoices() - -

                          - - - - - public - getCachedChoices([mixed $context = [] ]) : mixed - -
                          - -
                          Parameters
                          -
                          -
                          - $context - : mixed - = []
                          -
                          -
                          - -
                          -
                          - - - -
                          Return values
                          - mixed - — - - -
                          -
                          -

                          - getChoices() - -

                          - - - - - public - getChoices([mixed $context = [] ]) : mixed - -
                          - -
                          Parameters
                          -
                          -
                          - $context - : mixed - = []
                          -
                          -
                          - -
                          -
                          - - - -
                          Return values
                          - mixed - — - - -
                          -
                          -

                          - getContext() - -

                          - - - - - public - getContext() : mixed - - - - - -
                          Return values
                          - mixed - — - - -
                          -
                          -

                          - setContext() - -

                          - - - - - public - setContext(mixed $context) : mixed - - -
                          Parameters
                          -
                          -
                          - $context - : mixed -
                          -
                          - -
                          -
                          - - - -
                          Return values
                          - mixed - — - - -
                          -
                          -

                          - collect() - -

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

                          Search results

                          - -
                          -
                          -
                            -
                            -
                            -
                            -
                            -
                            - - -
                            - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Classes-ClassUtil.html b/classes/HeimrichHannot-UtilsBundle-Classes-ClassUtil.html deleted file mode 100644 index aafef9ec..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Classes-ClassUtil.html +++ /dev/null @@ -1,830 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                            -

                            Contao Utils Bundle

                            - - -
                            - -
                            - - -
                            - -
                            -
                            - - - - -
                            - - -
                            -

                            - ClassUtil - - -
                            - in package - -
                            - - -

                            - - - - -
                            - - - - - - - - -

                            - Table of Contents - -

                            - -
                            -
                            - $arrayUtil - -  : ArrayUtil -
                            -
                            - -
                            - $stringUtil - -  : StringUtil -
                            -
                            - -
                            - __construct() - -  : mixed -
                            -
                            ClassUtil constructor.
                            - -
                            - callInaccessibleMethod() - -  : mixed|null -
                            -
                            Calls an object's method which is inaccessible.
                            - -
                            - getChildClasses() - -  : array<string|int, mixed> -
                            -
                            Returns all children of a given class.
                            - -
                            - getClassesInNamespace() - -  : array<string|int, mixed> -
                            -
                            Returns all classes in the given namespace.
                            - -
                            - getConstantsByPrefixes() - -  : array<string|int, mixed> -
                            -
                            Filter class constants by given prefixes and return the extracted constants.
                            - -
                            - getParentClasses() - -  : array<string|int, mixed> -
                            -
                            - -
                            - jsonSerialize() - -  : array<string|int, mixed> -
                            -
                            Serialize a class object to JSON by iterating over all public getters (get(), is(), ...).
                            - -
                            - getMethodNameStartIndex() - -  : int|null -
                            -
                            - -
                            - - - - - - -
                            -

                            - Properties - -

                            -
                            -

                            - $arrayUtil - - - -

                            - - - - - protected - ArrayUtil - $arrayUtil - - - - - - -
                            - -
                            - -
                            -

                            - Methods - -

                            -
                            -

                            - __construct() - -

                            - - -

                            ClassUtil constructor.

                            - - - public - __construct(ArrayUtil $arrayUtil, StringUtil $stringUtil) : mixed - - -
                            Parameters
                            -
                            -
                            - $arrayUtil - : ArrayUtil -
                            -
                            -
                            - -
                            -
                            - $stringUtil - : StringUtil -
                            -
                            -
                            - -
                            -
                            - - - -
                            Return values
                            - mixed - — - - -
                            -
                            -

                            - callInaccessibleMethod() - -

                            - - -

                            Calls an object's method which is inaccessible.

                            - - - public - callInaccessibleMethod( $entity, string $method) : mixed|null - - -
                            Parameters
                            -
                            -
                            - $entity - : -
                            -
                            - -
                            -
                            - $method - : string -
                            -
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ReflectionException - - -
                            -
                            - -
                            Return values
                            - mixed|null - — - - -
                            -
                            -

                            - getChildClasses() - -

                            - - -

                            Returns all children of a given class.

                            - - - public - getChildClasses(string $qualifiedClassName) : array<string|int, mixed> - - -
                            Parameters
                            -
                            -
                            - $qualifiedClassName - : string -
                            -
                            -
                            - -
                            -
                            - - - -
                            Return values
                            - array<string|int, mixed> - — - - -
                            -
                            -

                            - getClassesInNamespace() - -

                            - - -

                            Returns all classes in the given namespace.

                            - - - public - getClassesInNamespace(string $namespace) : array<string|int, mixed> - - -
                            Parameters
                            -
                            -
                            - $namespace - : string -
                            -
                            -
                            - -
                            -
                            - - - -
                            Return values
                            - array<string|int, mixed> - — - - -
                            -
                            -

                            - getConstantsByPrefixes() - -

                            - - -

                            Filter class constants by given prefixes and return the extracted constants.

                            - - - public - getConstantsByPrefixes(string $class[, array<string|int, mixed> $prefixes = [] ][, bool $returnValueAsKey = true ]) : array<string|int, mixed> - - -
                            Parameters
                            -
                            -
                            - $class - : string -
                            -
                            -

                            the class that should be searched for constants in

                            -
                            - -
                            -
                            - $prefixes - : array<string|int, mixed> - = []
                            -
                            -

                            an array of prefixes that should be used to filter the class constants

                            -
                            - -
                            -
                            - $returnValueAsKey - : bool - = true
                            -
                            -

                            boolean Return the extracted array keys from its value, if true

                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ReflectionException - - -
                            -
                            - -
                            Return values
                            - array<string|int, mixed> - — -

                            the extracted constants as array

                            -
                            - - -
                            -
                            -

                            - getParentClasses() - -

                            - - - - - public - getParentClasses(string $class[, array<string|int, mixed> $parents = [] ]) : array<string|int, mixed> - - -
                            Parameters
                            -
                            -
                            - $class - : string -
                            -
                            -
                            - -
                            -
                            - $parents - : array<string|int, mixed> - = []
                            -
                            -
                            - -
                            -
                            - - - -
                            Return values
                            - array<string|int, mixed> - — - - -
                            -
                            -

                            - jsonSerialize() - -

                            - - -

                            Serialize a class object to JSON by iterating over all public getters (get(), is(), ...).

                            - - - public - jsonSerialize( $object[, array<string|int, mixed> $data = [] ][, array<string|int, mixed> $options = [] ]) : array<string|int, mixed> - - -
                            Parameters
                            -
                            -
                            - $object - : -
                            -
                            - -
                            -
                            - $data - : array<string|int, mixed> - = []
                            -
                            - -
                            -
                            - $options - : array<string|int, mixed> - = []
                            -
                            - -
                            -
                            - - -
                            - Tags - -
                            -
                            -
                            - throws -
                            -
                            - ReflectionException - -

                            if the class or method does not exist

                            -
                            - -
                            -
                            - -
                            Return values
                            - array<string|int, mixed> - — - - -
                            -
                            -

                            - getMethodNameStartIndex() - -

                            - - - - - private - static getMethodNameStartIndex( $method, ReflectionClass $rc) : int|null - - -
                            Parameters
                            -
                            -
                            - $method - : -
                            -
                            - -
                            -
                            - $rc - : ReflectionClass -
                            -
                            - -
                            -
                            - - - -
                            Return values
                            - int|null - — - - -
                            -
                            - - - - -
                            -
                            -
                            -
                            -

                            Search results

                            - -
                            -
                            -
                              -
                              -
                              -
                              -
                              -
                              - - -
                              - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Command-CreateImageSizeItemsCommand.html b/classes/HeimrichHannot-UtilsBundle-Command-CreateImageSizeItemsCommand.html deleted file mode 100644 index 4336fc01..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Command-CreateImageSizeItemsCommand.html +++ /dev/null @@ -1,817 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                              -

                              Contao Utils Bundle

                              - - -
                              - -
                              - - -
                              - -
                              -
                              - - - - -
                              - - -
                              -

                              - CreateImageSizeItemsCommand - - - extends Command - - -
                              - in package - -
                              - - -

                              - - - - -
                              - - - - - - - - -

                              - Table of Contents - -

                              - -
                              -
                              - DEFAULT_BREAKPOINTS - -  = [576, 768, 992, 1200, 1400] -
                              -
                              - -
                              - MODE_FIRST - -  = 1 -
                              -
                              - -
                              - MODE_INTERMEDIATE - -  = 2 -
                              -
                              - -
                              - MODE_LAST - -  = 3 -
                              -
                              - -
                              - $defaultName - -  : mixed -
                              -
                              - -
                              - $contaoFramework - -  : ContaoFramework -
                              -
                              - -
                              - $utils - -  : Utils -
                              -
                              - -
                              - __construct() - -  : mixed -
                              -
                              - -
                              - configure() - -  : mixed -
                              -
                              {@inheritdoc}
                              - -
                              - createItem() - -  : mixed -
                              -
                              - -
                              - execute() - -  : mixed -
                              -
                              {@inheritdoc}
                              - -
                              - createImageSizes() - -  : mixed -
                              -
                              - -
                              - - - - -
                              -

                              - Constants - -

                              -
                              -

                              - DEFAULT_BREAKPOINTS - -

                              - - - - - - public - mixed - DEFAULT_BREAKPOINTS - = [576, 768, 992, 1200, 1400] - - - -
                              - -
                              - - - -
                              - - - -
                              - - -
                              -

                              - Properties - -

                              -
                              -

                              - $defaultName - - - -

                              - - - - - protected - static mixed - $defaultName - = 'huh:utils:create-image-size-items' - -
                              - -
                              - - - -
                              - - -
                              - -
                              -

                              - Methods - -

                              -
                              -

                              - __construct() - -

                              - - - - - public - __construct(ContaoFramework $contaoFramework, Utils $utils) : mixed - -
                              - -
                              Parameters
                              -
                              -
                              - $contaoFramework - : ContaoFramework -
                              -
                              -
                              - -
                              -
                              - $utils - : Utils -
                              -
                              -
                              - -
                              -
                              - - - -
                              Return values
                              - mixed - — - - -
                              -
                              -

                              - configure() - -

                              - - -

                              {@inheritdoc}

                              - - - protected - configure() : mixed - - - - - -
                              Return values
                              - mixed - — - - -
                              -
                              -

                              - createItem() - -

                              - - - - - protected - createItem(ImageSizeModel $imageSize, int $index, int $breakpoint, int|null $nextBreakpoint, int $mode) : mixed - - -
                              Parameters
                              -
                              -
                              - $imageSize - : ImageSizeModel -
                              -
                              - -
                              -
                              - $index - : int -
                              -
                              -
                              - -
                              -
                              - $breakpoint - : int -
                              -
                              -
                              - -
                              -
                              - $nextBreakpoint - : int|null -
                              -
                              -
                              - -
                              -
                              - $mode - : int -
                              -
                              -
                              - -
                              -
                              - - - -
                              Return values
                              - mixed - — - - -
                              -
                              -

                              - execute() - -

                              - - -

                              {@inheritdoc}

                              - - - protected - execute(InputInterface $input, OutputInterface $output) : mixed - - -
                              Parameters
                              -
                              -
                              - $input - : InputInterface -
                              -
                              -
                              - -
                              -
                              - $output - : OutputInterface -
                              -
                              -
                              - -
                              -
                              - - - -
                              Return values
                              - mixed - — - - -
                              -
                              -

                              - createImageSizes() - -

                              - - - - - private - createImageSizes(SymfonyStyle $io, array<string|int, mixed> $breakpoints[, array<string|int, mixed> $imageSizeIds = [] ]) : mixed - -
                              - -
                              Parameters
                              -
                              -
                              - $io - : SymfonyStyle -
                              -
                              -
                              - -
                              -
                              - $breakpoints - : array<string|int, mixed> -
                              -
                              -
                              - -
                              -
                              - $imageSizeIds - : array<string|int, mixed> - = []
                              -
                              -
                              - -
                              -
                              - - - -
                              Return values
                              - mixed - — - - -
                              -
                              - - - - -
                              -
                              -
                              -
                              -

                              Search results

                              - -
                              -
                              -
                                -
                                -
                                -
                                -
                                -
                                - - -
                                - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Command-EntityFinderCommand.html b/classes/HeimrichHannot-UtilsBundle-Command-EntityFinderCommand.html index da973c3c..7c2ebc8a 100644 --- a/classes/HeimrichHannot-UtilsBundle-Command-EntityFinderCommand.html +++ b/classes/HeimrichHannot-UtilsBundle-Command-EntityFinderCommand.html @@ -131,6 +131,13 @@

                                + $defaultDescription + +  : mixed +
                                +
                                + +
                                $defaultName  : mixed @@ -175,14 +182,14 @@

                                configure() -  : mixed +  : void
                                execute() -  : mixed +  : int
                                @@ -253,6 +260,40 @@

                                -property -protected -static " +> +

                                + $defaultDescription + + + +

                                + + + + + protected + static mixed + $defaultDescription + = 'A command to find where an entity is included.' + +
                                + +
                                + + + + +

                                $defaultName @@ -297,7 +338,7 @@

                                @@ -308,8 +349,10 @@

                                $connection - - +
                                + +
                                +

                                @@ -329,7 +372,7 @@

                                @@ -340,8 +383,10 @@

                                $contaoFramework - - +
                                + +
                                + @@ -361,7 +406,7 @@

                                @@ -372,8 +417,10 @@

                                $entityFinderHelper - - +
                                + +
                                + @@ -393,7 +440,7 @@

                                @@ -404,8 +451,10 @@

                                $eventDispatcher - - +
                                + +
                                + @@ -429,7 +478,7 @@

                                @@ -497,14 +546,14 @@

                                protected - configure() : mixed + configure() : void
                                @@ -512,7 +561,7 @@

                                Return values
                                - mixed + void — @@ -530,14 +579,14 @@

                                protected - execute(InputInterface $input, OutputInterface $output) : mixed + execute(InputInterface $input, OutputInterface $output) : int
                                @@ -564,7 +613,7 @@

                                Parameters
                                Return values
                                - mixed + int — @@ -582,7 +631,7 @@

                                @@ -634,7 +683,7 @@

                                @@ -702,7 +751,7 @@

                                @@ -754,7 +803,7 @@

                                @@ -798,7 +847,7 @@

                                @@ -850,7 +899,7 @@

                                @@ -918,7 +967,7 @@

                                diff --git a/classes/HeimrichHannot-UtilsBundle-Comparison-CompareUtil.html b/classes/HeimrichHannot-UtilsBundle-Comparison-CompareUtil.html deleted file mode 100644 index 0527f3b9..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Comparison-CompareUtil.html +++ /dev/null @@ -1,960 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                -

                                Contao Utils Bundle

                                - - -
                                - -
                                - - -
                                - -
                                -
                                - - - - -
                                - - -
                                -

                                - CompareUtil - - -
                                - in package - -
                                - - -

                                - - - - -
                                - - - - - - - - -

                                - Table of Contents - -

                                - -
                                -
                                - PHP_OPERATOR_EQUAL - -  = 'equal' -
                                -
                                - -
                                - PHP_OPERATOR_GREATER - -  = 'greater' -
                                -
                                - -
                                - PHP_OPERATOR_GREATER_EQUAL - -  = 'greaterequal' -
                                -
                                - -
                                - PHP_OPERATOR_IN_ARRAY - -  = 'inarray' -
                                -
                                - -
                                - PHP_OPERATOR_IS_NOT_NULL - -  = 'isnotnull' -
                                -
                                - -
                                - PHP_OPERATOR_IS_NULL - -  = 'isnull' -
                                -
                                - -
                                - PHP_OPERATOR_LIKE - -  = 'like' -
                                -
                                - -
                                - PHP_OPERATOR_LOWER - -  = 'lower' -
                                -
                                - -
                                - PHP_OPERATOR_LOWER_EQUAL - -  = 'lowerequal' -
                                -
                                - -
                                - PHP_OPERATOR_NOT_IN_ARRAY - -  = 'notinarray' -
                                -
                                - -
                                - PHP_OPERATOR_UNEQUAL - -  = 'unequal' -
                                -
                                - -
                                - PHP_OPERATOR_UNLIKE - -  = 'unlike' -
                                -
                                - -
                                - PHP_OPERATORS - -  = [self::PHP_OPERATOR_EQUAL, self::PHP_OPERATOR_UNEQUAL, self::PHP_OPERATOR_LIKE, self::PHP_OPERATOR_UNLIKE, self::PHP_OPERATOR_IN_ARRAY, self::PHP_OPERATOR_NOT_IN_ARRAY, self::PHP_OPERATOR_LOWER, self::PHP_OPERATOR_LOWER_EQUAL, self::PHP_OPERATOR_GREATER, self::PHP_OPERATOR_GREATER_EQUAL, self::PHP_OPERATOR_IS_NULL, self::PHP_OPERATOR_IS_NOT_NULL] -
                                -
                                - -
                                - PHP_SINGLE_VALUE_OPERATORS - -  = [self::PHP_OPERATOR_IS_NULL, self::PHP_OPERATOR_IS_NOT_NULL] -
                                -
                                - -
                                - $framework - -  : ContaoFrameworkInterface -
                                -
                                - -
                                - __construct() - -  : mixed -
                                -
                                - -
                                - compareSingleValue() - -  : bool -
                                -
                                - -
                                - compareValue() - -  : bool -
                                -
                                - -
                                - - - - -
                                -

                                - Constants - -

                                -
                                -

                                - PHP_OPERATOR_EQUAL - -

                                - - - - - - public - mixed - PHP_OPERATOR_EQUAL - = 'equal' - - - -
                                - -
                                - - - -
                                -
                                -

                                - PHP_OPERATOR_GREATER - -

                                - - - - - - public - mixed - PHP_OPERATOR_GREATER - = 'greater' - - - -
                                - -
                                - - - -
                                -
                                -

                                - PHP_OPERATOR_GREATER_EQUAL - -

                                - - - - - - public - mixed - PHP_OPERATOR_GREATER_EQUAL - = 'greaterequal' - - - -
                                - -
                                - - - -
                                -
                                -

                                - PHP_OPERATOR_IN_ARRAY - -

                                - - - - - - public - mixed - PHP_OPERATOR_IN_ARRAY - = 'inarray' - - - -
                                - -
                                - - - -
                                -
                                -

                                - PHP_OPERATOR_IS_NOT_NULL - -

                                - - - - - - public - mixed - PHP_OPERATOR_IS_NOT_NULL - = 'isnotnull' - - - -
                                - -
                                - - - -
                                -
                                -

                                - PHP_OPERATOR_IS_NULL - -

                                - - - - - - public - mixed - PHP_OPERATOR_IS_NULL - = 'isnull' - - - -
                                - -
                                - - - -
                                -
                                -

                                - PHP_OPERATOR_LIKE - -

                                - - - - - - public - mixed - PHP_OPERATOR_LIKE - = 'like' - - - -
                                - -
                                - - - -
                                -
                                -

                                - PHP_OPERATOR_LOWER - -

                                - - - - - - public - mixed - PHP_OPERATOR_LOWER - = 'lower' - - - -
                                - -
                                - - - -
                                -
                                -

                                - PHP_OPERATOR_LOWER_EQUAL - -

                                - - - - - - public - mixed - PHP_OPERATOR_LOWER_EQUAL - = 'lowerequal' - - - -
                                - -
                                - - - -
                                -
                                -

                                - PHP_OPERATOR_NOT_IN_ARRAY - -

                                - - - - - - public - mixed - PHP_OPERATOR_NOT_IN_ARRAY - = 'notinarray' - - - -
                                - -
                                - - - -
                                -
                                -

                                - PHP_OPERATOR_UNEQUAL - -

                                - - - - - - public - mixed - PHP_OPERATOR_UNEQUAL - = 'unequal' - - - -
                                - -
                                - - - -
                                -
                                -

                                - PHP_OPERATOR_UNLIKE - -

                                - - - - - - public - mixed - PHP_OPERATOR_UNLIKE - = 'unlike' - - - -
                                - -
                                - - - -
                                -
                                -

                                - PHP_OPERATORS - -

                                - - - - - - public - mixed - PHP_OPERATORS - = [self::PHP_OPERATOR_EQUAL, self::PHP_OPERATOR_UNEQUAL, self::PHP_OPERATOR_LIKE, self::PHP_OPERATOR_UNLIKE, self::PHP_OPERATOR_IN_ARRAY, self::PHP_OPERATOR_NOT_IN_ARRAY, self::PHP_OPERATOR_LOWER, self::PHP_OPERATOR_LOWER_EQUAL, self::PHP_OPERATOR_GREATER, self::PHP_OPERATOR_GREATER_EQUAL, self::PHP_OPERATOR_IS_NULL, self::PHP_OPERATOR_IS_NOT_NULL] - - - -
                                - -
                                - - - -
                                -
                                -

                                - PHP_SINGLE_VALUE_OPERATORS - -

                                - - - - - - public - mixed - PHP_SINGLE_VALUE_OPERATORS - = [self::PHP_OPERATOR_IS_NULL, self::PHP_OPERATOR_IS_NOT_NULL] - - - -
                                - -
                                - - - -
                                -
                                - - -
                                -

                                - Properties - -

                                -
                                -

                                - $framework - - - -

                                - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
                                -
                                - -
                                -

                                - Methods - -

                                -
                                -

                                - __construct() - -

                                - - - - - public - __construct(ContaoFrameworkInterface $framework) : mixed - -
                                - -
                                Parameters
                                -
                                -
                                - $framework - : ContaoFrameworkInterface -
                                -
                                -
                                - -
                                -
                                - - - -
                                Return values
                                - mixed - — - - -
                                -
                                -

                                - compareSingleValue() - -

                                - - - - - public - compareSingleValue( $value, string $operator) : bool - - -
                                Parameters
                                -
                                -
                                - $value - : -
                                -
                                - -
                                -
                                - $operator - : string -
                                -
                                -
                                - -
                                -
                                - - - -
                                Return values
                                - bool - — - - -
                                -
                                -

                                - compareValue() - -

                                - - - - - public - compareValue(string $operator,  $value1[,  $value2 = null ]) : bool - - -
                                Parameters
                                -
                                -
                                - $operator - : string -
                                -
                                -
                                - -
                                -
                                - $value1 - : -
                                -
                                - -
                                -
                                - $value2 - : - = null
                                -
                                - -
                                -
                                - - - -
                                Return values
                                - bool - — - - -
                                -
                                - - - - -
                                -
                                -
                                -
                                -

                                Search results

                                - -
                                -
                                -
                                  -
                                  -
                                  -
                                  -
                                  -
                                  - - -
                                  - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Container-ContainerUtil.html b/classes/HeimrichHannot-UtilsBundle-Container-ContainerUtil.html deleted file mode 100644 index 943282d5..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Container-ContainerUtil.html +++ /dev/null @@ -1,1500 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                  -

                                  Contao Utils Bundle

                                  - - -
                                  - -
                                  - - -
                                  - -
                                  -
                                  - - - - -
                                  - - -
                                  -

                                  - ContainerUtil - - -
                                  - in package - -
                                  - - -

                                  - - - -

                                  Class ContainerUtil.

                                  - - - -
                                  - Tags - -
                                  -
                                  -
                                  - deprecated -
                                  -
                                  - -

                                  use utils service instead

                                  -
                                  - -
                                  -
                                  - - - - - - -

                                  - Table of Contents - -

                                  - -
                                  -
                                  - $container - -  : ContainerInterface -
                                  -
                                  - -
                                  - $utils - -  : Utils -
                                  -
                                  - -
                                  - __construct() - -  : mixed -
                                  -
                                  - -
                                  - getActiveBundles() - -  : array<string|int, mixed> -
                                  -
                                  Returns the active bundles.
                                  - -
                                  - getBundlePath() - -  : bool|string -
                                  -
                                  Returns the path to the bundle in vendor folder -Attention: resolves symlinks!
                                  - -
                                  - getBundleResourcePath() - -  : bool|string|array<string|int, mixed> -
                                  -
                                  Returns the path or paths to a ressource within a bundle -Attention: resolves symlinks!
                                  - -
                                  - getCurrentRequest() - -  : mixed -
                                  -
                                  - -
                                  - getProjectDir() - -  : mixed -
                                  -
                                  Returns the project root path.
                                  - -
                                  - getWebDir() - -  : mixed -
                                  -
                                  Returns the web folder path.
                                  - -
                                  - isBackend() - -  : bool -
                                  -
                                  - -
                                  - isBundleActive() - -  : bool -
                                  -
                                  Checks if some bundle is active. Pass in the class name (e.g. 'HeimrichHannot\FilterBundle\HeimrichHannotContaoFilterBundle' or the legacy Contao 3 name like 'news').
                                  - -
                                  - isDev() - -  : bool -
                                  -
                                  - -
                                  - isFrontend() - -  : bool -
                                  -
                                  - -
                                  - isFrontendCron() - -  : bool -
                                  -
                                  - -
                                  - isInstall() - -  : bool -
                                  -
                                  - -
                                  - isMaintenanceModeActive() - -  : bool -
                                  -
                                  - -
                                  - isPreviewMode() - -  : bool -
                                  -
                                  - -
                                  - log() - -  : mixed -
                                  -
                                  - -
                                  - mergeConfigFile() - -  : array<string|int, mixed> -
                                  -
                                  Recursively merges a config.yml with a $extensionConfigs array in the context of ExtensionPluginInterface::getExtensionConfig().
                                  - -
                                  - - - - - - -
                                  -

                                  - Properties - -

                                  -
                                  -

                                  - $container - - - -

                                  - - - - - protected - ContainerInterface - $container - - - - - - -
                                  - -
                                  - -
                                  -

                                  - Methods - -

                                  -
                                  -

                                  - __construct() - -

                                  - - - - - public - __construct(ContainerInterface $container, Utils $utils) : mixed - -
                                  - -
                                  Parameters
                                  -
                                  -
                                  - $container - : ContainerInterface -
                                  -
                                  -
                                  - -
                                  -
                                  - $utils - : Utils -
                                  -
                                  -
                                  - -
                                  -
                                  - - - -
                                  Return values
                                  - mixed - — - - -
                                  -
                                  -

                                  - getActiveBundles() - -

                                  - - -

                                  Returns the active bundles.

                                  - - - public - getActiveBundles() : array<string|int, mixed> - - - - -
                                  - Tags - -
                                  -
                                  -
                                  - codeCoverageIgnore -
                                  -
                                  - - -
                                  -
                                  - deprecated -
                                  -
                                  - -

                                  Use kernel.bundles parameter or KernelInterface::getBundles()

                                  -
                                  - -
                                  -
                                  - -
                                  Return values
                                  - array<string|int, mixed> - — - - -
                                  -
                                  -

                                  - getBundlePath() - -

                                  - - -

                                  Returns the path to the bundle in vendor folder -Attention: resolves symlinks!

                                  - - - public - getBundlePath(string $bundleClass) : bool|string - - -
                                  Parameters
                                  -
                                  -
                                  - $bundleClass - : string -
                                  -
                                  -

                                  The bundle class class constant (VendorMyBundle::class)

                                  -
                                  - -
                                  -
                                  - - -
                                  - Tags - -
                                  -
                                  -
                                  - codeCoverageIgnore -
                                  -
                                  - - -
                                  -
                                  - deprecated -
                                  -
                                  - -

                                  Use utils service instead

                                  -
                                  - -
                                  -
                                  - -
                                  Return values
                                  - bool|string - — -

                                  False on error

                                  -
                                  - - -
                                  -
                                  -

                                  - getBundleResourcePath() - -

                                  - - -

                                  Returns the path or paths to a ressource within a bundle -Attention: resolves symlinks!

                                  - - - public - getBundleResourcePath(string $bundleClass[, string $ressourcePath = '' ][, bool $first = false ]) : bool|string|array<string|int, mixed> - - -
                                  Parameters
                                  -
                                  -
                                  - $bundleClass - : string -
                                  -
                                  -

                                  The bundle class class constant (VendorMyBundle::class)

                                  -
                                  - -
                                  -
                                  - $ressourcePath - : string - = ''
                                  -
                                  -

                                  a ressource or path to ressource

                                  -
                                  - -
                                  -
                                  - $first - : bool - = false
                                  -
                                  -

                                  Returns only first occurrence if multiple paths found

                                  -
                                  - -
                                  -
                                  - - -
                                  - Tags - -
                                  -
                                  -
                                  - codeCoverageIgnore -
                                  -
                                  - - -
                                  -
                                  - deprecated -
                                  -
                                  - -

                                  Use utils service instead

                                  -
                                  - -
                                  -
                                  - -
                                  Return values
                                  - bool|string|array<string|int, mixed> - — -

                                  False on error

                                  -
                                  - - -
                                  -
                                  -

                                  - getCurrentRequest() - -

                                  - - - - - public - getCurrentRequest() : mixed - - - - -
                                  - Tags - -
                                  -
                                  -
                                  - codeCoverageIgnore -
                                  -
                                  - - -
                                  -
                                  - deprecated -
                                  -
                                  - -

                                  Use RequestStack::getCurrentRequest() instead

                                  -
                                  - -
                                  -
                                  - -
                                  Return values
                                  - mixed - — - - -
                                  -
                                  -

                                  - getProjectDir() - -

                                  - - -

                                  Returns the project root path.

                                  - - - public - getProjectDir() : mixed - - - - -
                                  - Tags - -
                                  -
                                  -
                                  - codeCoverageIgnore -
                                  -
                                  - - -
                                  -
                                  - deprecated -
                                  -
                                  - -

                                  Use KernelInterface::getProjectDir or kernel.project_dir parameter

                                  -
                                  - -
                                  -
                                  - -
                                  Return values
                                  - mixed - — - - -
                                  -
                                  -

                                  - getWebDir() - -

                                  - - -

                                  Returns the web folder path.

                                  - - - public - getWebDir() : mixed - - - - -
                                  - Tags - -
                                  -
                                  -
                                  - codeCoverageIgnore -
                                  -
                                  - - -
                                  -
                                  - deprecated -
                                  -
                                  - -

                                  Use contao.web_dir parameter

                                  -
                                  - -
                                  -
                                  - -
                                  Return values
                                  - mixed - — - - -
                                  -
                                  -

                                  - isBackend() - -

                                  - - - - - public - isBackend() : bool - - - - -
                                  - Tags - -
                                  -
                                  -
                                  - codeCoverageIgnore -
                                  -
                                  - - -
                                  -
                                  - deprecated -
                                  -
                                  - -

                                  Use utils service instead

                                  -
                                  - -
                                  -
                                  - -
                                  Return values
                                  - bool - — - - -
                                  -
                                  -

                                  - isBundleActive() - -

                                  - - -

                                  Checks if some bundle is active. Pass in the class name (e.g. 'HeimrichHannot\FilterBundle\HeimrichHannotContaoFilterBundle' or the legacy Contao 3 name like 'news').

                                  - - - public - isBundleActive(string $bundleName) : bool - - -
                                  Parameters
                                  -
                                  -
                                  - $bundleName - : string -
                                  -
                                  -
                                  - -
                                  -
                                  - - -
                                  - Tags - -
                                  -
                                  -
                                  - codeCoverageIgnore -
                                  -
                                  - - -
                                  -
                                  - deprecated -
                                  -
                                  - -

                                  Use utils service instead

                                  -
                                  - -
                                  -
                                  - -
                                  Return values
                                  - bool - — - - -
                                  -
                                  -

                                  - isDev() - -

                                  - - - - - public - isDev() : bool - - - - -
                                  - Tags - -
                                  -
                                  -
                                  - codeCoverageIgnore -
                                  -
                                  - - -
                                  -
                                  - deprecated -
                                  -
                                  - -

                                  Use utils service instead

                                  -
                                  - -
                                  -
                                  - -
                                  Return values
                                  - bool - — - - -
                                  -
                                  -

                                  - isFrontend() - -

                                  - - - - - public - isFrontend() : bool - - - - -
                                  - Tags - -
                                  -
                                  -
                                  - codeCoverageIgnore -
                                  -
                                  - - -
                                  -
                                  - deprecated -
                                  -
                                  - -

                                  Use utils service instead

                                  -
                                  - -
                                  -
                                  - -
                                  Return values
                                  - bool - — - - -
                                  -
                                  -

                                  - isFrontendCron() - -

                                  - - - - - public - isFrontendCron() : bool - - - - -
                                  - Tags - -
                                  -
                                  -
                                  - codeCoverageIgnore -
                                  -
                                  - - -
                                  -
                                  - deprecated -
                                  -
                                  - -

                                  Use utils service instead

                                  -
                                  - -
                                  -
                                  - -
                                  Return values
                                  - bool - — - - -
                                  -
                                  -

                                  - isInstall() - -

                                  - - - - - public - isInstall() : bool - - - - -
                                  - Tags - -
                                  -
                                  -
                                  - codeCoverageIgnore -
                                  -
                                  - - -
                                  -
                                  - deprecated -
                                  -
                                  - -

                                  Use utils service instead

                                  -
                                  - -
                                  -
                                  - -
                                  Return values
                                  - bool - — - - -
                                  -
                                  -

                                  - isMaintenanceModeActive() - -

                                  - - - - - public - isMaintenanceModeActive() : bool - - - - -
                                  - Tags - -
                                  -
                                  -
                                  - codeCoverageIgnore -
                                  -
                                  - - -
                                  -
                                  - deprecated -
                                  -
                                  - -

                                  Use utils service instead

                                  -
                                  - -
                                  -
                                  - -
                                  Return values
                                  - bool - — - - -
                                  -
                                  -

                                  - isPreviewMode() - -

                                  - - - - - public - isPreviewMode() : bool - - - - -
                                  - Tags - -
                                  -
                                  -
                                  - codeCoverageIgnore -
                                  -
                                  - - -
                                  -
                                  - deprecated -
                                  -
                                  - -

                                  Use utils service instead

                                  -
                                  - -
                                  -
                                  - -
                                  Return values
                                  - bool - — - - -
                                  -
                                  -

                                  - log() - -

                                  - - - - - public - log(string $text, string $function, string $category) : mixed - - -
                                  Parameters
                                  -
                                  -
                                  - $text - : string -
                                  -
                                  -
                                  - -
                                  -
                                  - $function - : string -
                                  -
                                  -
                                  - -
                                  -
                                  - $category - : string -
                                  -
                                  -

                                  Use constants in ContaoContext

                                  -
                                  - -
                                  -
                                  - - -
                                  - Tags - -
                                  -
                                  -
                                  - codeCoverageIgnore -
                                  -
                                  - - -
                                  -
                                  - deprecated -
                                  -
                                  - -

                                  Use utils service instead

                                  -
                                  - -
                                  -
                                  - -
                                  Return values
                                  - mixed - — - - -
                                  -
                                  -

                                  - mergeConfigFile() - -

                                  - - -

                                  Recursively merges a config.yml with a $extensionConfigs array in the context of ExtensionPluginInterface::getExtensionConfig().

                                  - - - public - static mergeConfigFile(string $activeExtensionName, string $extensionName, array<string|int, mixed> $extensionConfigs, string $configFile) : array<string|int, mixed> - -

                                  Must be static, because on Plugin::getExtensionConfig() no contao.framework nor service huh.utils.container is available.

                                  -
                                  - -
                                  Parameters
                                  -
                                  -
                                  - $activeExtensionName - : string -
                                  -
                                  -
                                  - -
                                  -
                                  - $extensionName - : string -
                                  -
                                  -
                                  - -
                                  -
                                  - $extensionConfigs - : array<string|int, mixed> -
                                  -
                                  -
                                  - -
                                  -
                                  - $configFile - : string -
                                  -
                                  -
                                  - -
                                  -
                                  - - -
                                  - Tags - -
                                  -
                                  -
                                  - codeCoverageIgnore -
                                  -
                                  - - -
                                  -
                                  - deprecated -
                                  -
                                  - -

                                  Use ConfigPluginInterface with class_exist instead

                                  -
                                  - -
                                  -
                                  - -
                                  Return values
                                  - array<string|int, mixed> - — - - -
                                  -
                                  - - - - -
                                  -
                                  -
                                  -
                                  -

                                  Search results

                                  - -
                                  -
                                  -
                                    -
                                    -
                                    -
                                    -
                                    -
                                    - - -
                                    - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-ContaoManager-Plugin.html b/classes/HeimrichHannot-UtilsBundle-ContaoManager-Plugin.html index ceae9fdb..ba64c3ae 100644 --- a/classes/HeimrichHannot-UtilsBundle-ContaoManager-Plugin.html +++ b/classes/HeimrichHannot-UtilsBundle-ContaoManager-Plugin.html @@ -110,7 +110,7 @@

                                    @@ -183,7 +183,7 @@

                                    @@ -227,7 +227,7 @@

                                    Plugin.php : - 40 + 36 diff --git a/classes/HeimrichHannot-UtilsBundle-Content-ContentUtil.html b/classes/HeimrichHannot-UtilsBundle-Content-ContentUtil.html deleted file mode 100644 index c94dcd0c..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Content-ContentUtil.html +++ /dev/null @@ -1,427 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                    -

                                    Contao Utils Bundle

                                    - - -
                                    - -
                                    - - -
                                    - -
                                    -
                                    - - - - -
                                    - - -
                                    -

                                    - ContentUtil - - -
                                    - in package - -
                                    - - -

                                    - - - - -
                                    - - - - - - - - -

                                    - Table of Contents - -

                                    - -
                                    -
                                    - $framework - -  : ContaoFrameworkInterface -
                                    -
                                    - -
                                    - $container - -  : ContainerInterface -
                                    -
                                    - -
                                    - __construct() - -  : mixed -
                                    -
                                    - -
                                    - getMultilingualElements() - -  : mixed -
                                    -
                                    - -
                                    - - - - - - -
                                    -

                                    - Properties - -

                                    -
                                    -

                                    - $framework - - - -

                                    - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
                                    -
                                    -

                                    - $container - - - -

                                    - - - - - private - ContainerInterface - $container - - - - - - -
                                    -
                                    - -
                                    -

                                    - Methods - -

                                    -
                                    -

                                    - __construct() - -

                                    - - - - - public - __construct(ContainerInterface $container) : mixed - -
                                    - -
                                    Parameters
                                    -
                                    -
                                    - $container - : ContainerInterface -
                                    -
                                    -
                                    - -
                                    -
                                    - - - -
                                    Return values
                                    - mixed - — - - -
                                    -
                                    -

                                    - getMultilingualElements() - -

                                    - - - - - public - getMultilingualElements(mixed $id, mixed $ptable) : mixed - -
                                    - -
                                    Parameters
                                    -
                                    -
                                    - $id - : mixed -
                                    -
                                    -
                                    - -
                                    -
                                    - $ptable - : mixed -
                                    -
                                    -
                                    - -
                                    -
                                    - - - -
                                    Return values
                                    - mixed - — - - -
                                    -
                                    - - - - -
                                    -
                                    -
                                    -
                                    -

                                    Search results

                                    - -
                                    -
                                    -
                                      -
                                      -
                                      -
                                      -
                                      -
                                      - - -
                                      - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Database-DatabaseUtil.html b/classes/HeimrichHannot-UtilsBundle-Database-DatabaseUtil.html deleted file mode 100644 index 8545f0e7..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Database-DatabaseUtil.html +++ /dev/null @@ -1,2336 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                      -

                                      Contao Utils Bundle

                                      - - -
                                      - -
                                      - - -
                                      - -
                                      -
                                      - - - - -
                                      - - -
                                      -

                                      - DatabaseUtil - - -
                                      - in package - -
                                      - - -

                                      - - - - -
                                      - - - - - - - - -

                                      - Table of Contents - -

                                      - -
                                      -
                                      - NEGATIVE_OPERATORS - -  = [self::OPERATOR_UNLIKE, self::OPERATOR_UNEQUAL, self::OPERATOR_NOT_IN, self::OPERATOR_IS_NULL, self::OPERATOR_IS_EMPTY, self::OPERATOR_NOT_REGEXP] -
                                      -
                                      - -
                                      - ON_DUPLICATE_KEY_IGNORE - -  = 'IGNORE' -
                                      -
                                      - -
                                      - ON_DUPLICATE_KEY_UPDATE - -  = 'UPDATE' -
                                      -
                                      - -
                                      - OPERATOR_EQUAL - -  = 'equal' -
                                      -
                                      - -
                                      - OPERATOR_GREATER - -  = 'greater' -
                                      -
                                      - -
                                      - OPERATOR_GREATER_EQUAL - -  = 'greaterequal' -
                                      -
                                      - -
                                      - OPERATOR_IN - -  = 'in' -
                                      -
                                      - -
                                      - OPERATOR_IS_EMPTY - -  = 'isempty' -
                                      -
                                      - -
                                      - OPERATOR_IS_NOT_EMPTY - -  = 'isnotempty' -
                                      -
                                      - -
                                      - OPERATOR_IS_NOT_NULL - -  = 'isnotnull' -
                                      -
                                      - -
                                      - OPERATOR_IS_NULL - -  = 'isnull' -
                                      -
                                      - -
                                      - OPERATOR_LIKE - -  = 'like' -
                                      -
                                      - -
                                      - OPERATOR_LOWER - -  = 'lower' -
                                      -
                                      - -
                                      - OPERATOR_LOWER_EQUAL - -  = 'lowerequal' -
                                      -
                                      - -
                                      - OPERATOR_MAPPING - -  = [self::OPERATOR_LIKE => 'like', self::OPERATOR_UNLIKE => 'notLike', self::OPERATOR_EQUAL => 'eq', self::OPERATOR_UNEQUAL => 'neq', self::OPERATOR_LOWER => 'lt', self::OPERATOR_LOWER_EQUAL => 'lte', self::OPERATOR_GREATER => 'gt', self::OPERATOR_GREATER_EQUAL => 'gte', self::OPERATOR_IN => 'in', self::OPERATOR_NOT_IN => 'notIn', self::OPERATOR_IS_NULL => 'isNull', self::OPERATOR_IS_NOT_NULL => 'isNotNull'] -
                                      -
                                      Maps operators of this class to its corresponding Doctrine ExpressionBuilder method.
                                      - -
                                      - OPERATOR_NOT_IN - -  = 'notin' -
                                      -
                                      - -
                                      - OPERATOR_NOT_REGEXP - -  = 'notregexp' -
                                      -
                                      - -
                                      - OPERATOR_REGEXP - -  = 'regexp' -
                                      -
                                      - -
                                      - OPERATOR_UNEQUAL - -  = 'unequal' -
                                      -
                                      - -
                                      - OPERATOR_UNLIKE - -  = 'unlike' -
                                      -
                                      - -
                                      - OPERATORS - -  = [self::OPERATOR_LIKE, self::OPERATOR_UNLIKE, self::OPERATOR_EQUAL, self::OPERATOR_UNEQUAL, self::OPERATOR_LOWER, self::OPERATOR_LOWER_EQUAL, self::OPERATOR_GREATER, self::OPERATOR_GREATER_EQUAL, self::OPERATOR_IN, self::OPERATOR_NOT_IN, self::OPERATOR_IS_NULL, self::OPERATOR_IS_NOT_NULL, self::OPERATOR_IS_EMPTY, self::OPERATOR_IS_NOT_EMPTY, self::OPERATOR_REGEXP, self::OPERATOR_NOT_REGEXP] -
                                      -
                                      - -
                                      - SQL_CONDITION_AND - -  = 'AND' -
                                      -
                                      - -
                                      - SQL_CONDITION_OR - -  = 'OR' -
                                      -
                                      - -
                                      - $framework - -  : ContaoFrameworkInterface -
                                      -
                                      - -
                                      - __construct() - -  : mixed -
                                      -
                                      - -
                                      - beginTransaction() - -  : mixed -
                                      -
                                      - -
                                      - commitTransaction() - -  : mixed -
                                      -
                                      - -
                                      - composeWhereForQueryBuilder() - -  : string -
                                      -
                                      - -
                                      - computeCondition() - -  : array<string|int, mixed> -
                                      -
                                      Computes a MySQL condition appropriate for the given operator.
                                      - -
                                      - createWhereForSerializedBlob() - -  : array<string|int, mixed> -
                                      -
                                      Create a where condition for a field that contains a serialized blob.
                                      - -
                                      - delete() - -  : mixed -
                                      -
                                      - -
                                      - doBulkInsert() - -  : mixed -
                                      -
                                      Bulk insert SQL of given data.
                                      - -
                                      - findOneResultBy() - -  : mixed -
                                      -
                                      Return a single database result by table and search criteria.
                                      - -
                                      - findResultByPk() - -  : mixed -
                                      -
                                      Returns a database result for a given table and id(primary key).
                                      - -
                                      - findResultsBy() - -  : mixed -
                                      -
                                      - -
                                      - getChildRecords() - -  : array<string|int, mixed> -
                                      -
                                      - -
                                      - insert() - -  : mixed -
                                      -
                                      - -
                                      - processInPieces() - -  : bool|int -
                                      -
                                      Process a query in pieces, run callback within each cycle.
                                      - -
                                      - transformVerboseOperator() - -  : string|bool -
                                      -
                                      Transforms verbose operators to valid MySQL operators (aka junctors).
                                      - -
                                      - update() - -  : mixed -
                                      -
                                      - -
                                      - createQueryWithoutRelations() - -  : string -
                                      -
                                      Adapted from \Contao\Model\QueryBuilder::find().
                                      - -
                                      - - - - -
                                      -

                                      - Constants - -

                                      -
                                      -

                                      - NEGATIVE_OPERATORS - -

                                      - - - - - - public - mixed - NEGATIVE_OPERATORS - = [self::OPERATOR_UNLIKE, self::OPERATOR_UNEQUAL, self::OPERATOR_NOT_IN, self::OPERATOR_IS_NULL, self::OPERATOR_IS_EMPTY, self::OPERATOR_NOT_REGEXP] - - - -
                                      - -
                                      - - - -
                                      -
                                      -

                                      - ON_DUPLICATE_KEY_IGNORE - -

                                      - - - - - - public - mixed - ON_DUPLICATE_KEY_IGNORE - = 'IGNORE' - - - -
                                      - -
                                      - - - -
                                      -
                                      -

                                      - ON_DUPLICATE_KEY_UPDATE - -

                                      - - - - - - public - mixed - ON_DUPLICATE_KEY_UPDATE - = 'UPDATE' - - - -
                                      - -
                                      - - - -
                                      -
                                      -

                                      - OPERATOR_EQUAL - -

                                      - - - - - - public - mixed - OPERATOR_EQUAL - = 'equal' - - - -
                                      - -
                                      - - - -
                                      -
                                      -

                                      - OPERATOR_GREATER - -

                                      - - - - - - public - mixed - OPERATOR_GREATER - = 'greater' - - - -
                                      - -
                                      - - - -
                                      -
                                      -

                                      - OPERATOR_GREATER_EQUAL - -

                                      - - - - - - public - mixed - OPERATOR_GREATER_EQUAL - = 'greaterequal' - - - -
                                      - -
                                      - - - -
                                      -
                                      -

                                      - OPERATOR_IN - -

                                      - - - - - - public - mixed - OPERATOR_IN - = 'in' - - - -
                                      - -
                                      - - - -
                                      -
                                      -

                                      - OPERATOR_IS_EMPTY - -

                                      - - - - - - public - mixed - OPERATOR_IS_EMPTY - = 'isempty' - - - -
                                      - -
                                      - - - -
                                      -
                                      -

                                      - OPERATOR_IS_NOT_EMPTY - -

                                      - - - - - - public - mixed - OPERATOR_IS_NOT_EMPTY - = 'isnotempty' - - - -
                                      - -
                                      - - - -
                                      -
                                      -

                                      - OPERATOR_IS_NOT_NULL - -

                                      - - - - - - public - mixed - OPERATOR_IS_NOT_NULL - = 'isnotnull' - - - -
                                      - -
                                      - - - -
                                      -
                                      -

                                      - OPERATOR_IS_NULL - -

                                      - - - - - - public - mixed - OPERATOR_IS_NULL - = 'isnull' - - - -
                                      - -
                                      - - - -
                                      -
                                      -

                                      - OPERATOR_LIKE - -

                                      - - - - - - public - mixed - OPERATOR_LIKE - = 'like' - - - -
                                      - -
                                      - - - -
                                      -
                                      -

                                      - OPERATOR_LOWER - -

                                      - - - - - - public - mixed - OPERATOR_LOWER - = 'lower' - - - -
                                      - -
                                      - - - -
                                      -
                                      -

                                      - OPERATOR_LOWER_EQUAL - -

                                      - - - - - - public - mixed - OPERATOR_LOWER_EQUAL - = 'lowerequal' - - - -
                                      - -
                                      - - - -
                                      -
                                      -

                                      - OPERATOR_MAPPING - -

                                      - - - -

                                      Maps operators of this class to its corresponding Doctrine ExpressionBuilder method.

                                      - - - public - mixed - OPERATOR_MAPPING - = [self::OPERATOR_LIKE => 'like', self::OPERATOR_UNLIKE => 'notLike', self::OPERATOR_EQUAL => 'eq', self::OPERATOR_UNEQUAL => 'neq', self::OPERATOR_LOWER => 'lt', self::OPERATOR_LOWER_EQUAL => 'lte', self::OPERATOR_GREATER => 'gt', self::OPERATOR_GREATER_EQUAL => 'gte', self::OPERATOR_IN => 'in', self::OPERATOR_NOT_IN => 'notIn', self::OPERATOR_IS_NULL => 'isNull', self::OPERATOR_IS_NOT_NULL => 'isNotNull'] - - - - -
                                      - - - -
                                      -
                                      -

                                      - OPERATOR_NOT_IN - -

                                      - - - - - - public - mixed - OPERATOR_NOT_IN - = 'notin' - - - -
                                      - -
                                      - - - -
                                      -
                                      -

                                      - OPERATOR_NOT_REGEXP - -

                                      - - - - - - public - mixed - OPERATOR_NOT_REGEXP - = 'notregexp' - - - -
                                      - -
                                      - - - -
                                      -
                                      -

                                      - OPERATOR_REGEXP - -

                                      - - - - - - public - mixed - OPERATOR_REGEXP - = 'regexp' - - - -
                                      - -
                                      - - - -
                                      -
                                      -

                                      - OPERATOR_UNEQUAL - -

                                      - - - - - - public - mixed - OPERATOR_UNEQUAL - = 'unequal' - - - -
                                      - -
                                      - - - -
                                      -
                                      -

                                      - OPERATOR_UNLIKE - -

                                      - - - - - - public - mixed - OPERATOR_UNLIKE - = 'unlike' - - - -
                                      - -
                                      - - - -
                                      -
                                      -

                                      - OPERATORS - -

                                      - - - - - - public - mixed - OPERATORS - = [self::OPERATOR_LIKE, self::OPERATOR_UNLIKE, self::OPERATOR_EQUAL, self::OPERATOR_UNEQUAL, self::OPERATOR_LOWER, self::OPERATOR_LOWER_EQUAL, self::OPERATOR_GREATER, self::OPERATOR_GREATER_EQUAL, self::OPERATOR_IN, self::OPERATOR_NOT_IN, self::OPERATOR_IS_NULL, self::OPERATOR_IS_NOT_NULL, self::OPERATOR_IS_EMPTY, self::OPERATOR_IS_NOT_EMPTY, self::OPERATOR_REGEXP, self::OPERATOR_NOT_REGEXP] - - - -
                                      - -
                                      - - - -
                                      -
                                      -

                                      - SQL_CONDITION_AND - -

                                      - - - - - - public - mixed - SQL_CONDITION_AND - = 'AND' - - - -
                                      - -
                                      - - - -
                                      -
                                      -

                                      - SQL_CONDITION_OR - -

                                      - - - - - - public - mixed - SQL_CONDITION_OR - = 'OR' - - - -
                                      - -
                                      - - - -
                                      -
                                      - - -
                                      -

                                      - Properties - -

                                      -
                                      -

                                      - $framework - - - -

                                      - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
                                      -
                                      - -
                                      -

                                      - Methods - -

                                      -
                                      -

                                      - __construct() - -

                                      - - - - - public - __construct(ContaoFrameworkInterface $framework) : mixed - -
                                      - -
                                      Parameters
                                      -
                                      -
                                      - $framework - : ContaoFrameworkInterface -
                                      -
                                      -
                                      - -
                                      -
                                      - - - -
                                      Return values
                                      - mixed - — - - -
                                      -
                                      -

                                      - beginTransaction() - -

                                      - - - - - public - beginTransaction() : mixed - -
                                      - - - - -
                                      Return values
                                      - mixed - — - - -
                                      -
                                      -

                                      - commitTransaction() - -

                                      - - - - - public - commitTransaction() : mixed - -
                                      - - - - -
                                      Return values
                                      - mixed - — - - -
                                      -
                                      -

                                      - composeWhereForQueryBuilder() - -

                                      - - - - - public - composeWhereForQueryBuilder(QueryBuilder $queryBuilder, string $field, string $operator[, array<string|int, mixed> $dca = null ][, null $value = null ][, array<string|int, mixed> $options = [] ]) : string - - -
                                      Parameters
                                      -
                                      -
                                      - $queryBuilder - : QueryBuilder -
                                      -
                                      -
                                      - -
                                      -
                                      - $field - : string -
                                      -
                                      -
                                      - -
                                      -
                                      - $operator - : string -
                                      -
                                      -
                                      - -
                                      -
                                      - $dca - : array<string|int, mixed> - = null
                                      -
                                      -
                                      - -
                                      -
                                      - $value - : null - = null
                                      -
                                      - -
                                      -
                                      - $options - : array<string|int, mixed> - = []
                                      -
                                      -

                                      {wildcardSuffix: string}

                                      -
                                      - -
                                      -
                                      - - - -
                                      Return values
                                      - string - — - - -
                                      -
                                      -

                                      - computeCondition() - -

                                      - - -

                                      Computes a MySQL condition appropriate for the given operator.

                                      - - - public - computeCondition(string $field, string $operator, mixed $value[, string $table = null ][, bool $skipTablePrefix = false ]) : array<string|int, mixed> - - -
                                      Parameters
                                      -
                                      -
                                      - $field - : string -
                                      -
                                      -
                                      - -
                                      -
                                      - $operator - : string -
                                      -
                                      -
                                      - -
                                      -
                                      - $value - : mixed -
                                      -
                                      - -
                                      -
                                      - $table - : string - = null
                                      -
                                      - -
                                      -
                                      - $skipTablePrefix - : bool - = false
                                      -
                                      -
                                      - -
                                      -
                                      - - - -
                                      Return values
                                      - array<string|int, mixed> - — -

                                      Returns array($strQuery, $arrValues)

                                      -
                                      - - -
                                      -
                                      -

                                      - createWhereForSerializedBlob() - -

                                      - - -

                                      Create a where condition for a field that contains a serialized blob.

                                      - - - public - createWhereForSerializedBlob(string $field, array<string|int, mixed> $values[, string $connective = self::SQL_CONDITION_OR ][, array<string|int, mixed> $options = [] ]) : array<string|int, mixed> - - -
                                      Parameters
                                      -
                                      -
                                      - $field - : string -
                                      -
                                      -

                                      The field the condition should be checked against accordances

                                      -
                                      - -
                                      -
                                      - $values - : array<string|int, mixed> -
                                      -
                                      -

                                      The values array to check the field against

                                      -
                                      - -
                                      -
                                      - $connective - : string - = self::SQL_CONDITION_OR
                                      -
                                      -

                                      SQL_CONDITION_OR | SQL_CONDITION_AND

                                      -
                                      - -
                                      -
                                      - $options - : array<string|int, mixed> - = []
                                      -
                                      -

                                      Pass additional options.

                                      -

                                      Options:

                                      -
                                        -
                                      • inline_values: (bool) Inline the values in the sql part instead of using ? ('REGEXP (':"3"')' instead of 'REGEXP (?)'). Return value not change (still an array with an values index)
                                        • -
                                      -
                                      - -
                                      -
                                      - - -
                                      - Tags - -
                                      -
                                      -
                                      - deprecated -
                                      -
                                      - -

                                      Use Utils service instead

                                      -
                                      - -
                                      -
                                      - -
                                      Return values
                                      - array<string|int, mixed> - — - - -
                                      -
                                      -

                                      - delete() - -

                                      - - - - - public - delete(string $table[, string $where = null ][, array<string|int, mixed> $whereValues = [] ][, array<string|int, mixed> $options = [] ]) : mixed - -
                                      - -
                                      Parameters
                                      -
                                      -
                                      - $table - : string -
                                      -
                                      -
                                      - -
                                      -
                                      - $where - : string - = null
                                      -
                                      -
                                      - -
                                      -
                                      - $whereValues - : array<string|int, mixed> - = []
                                      -
                                      -
                                      - -
                                      -
                                      - $options - : array<string|int, mixed> - = []
                                      -
                                      -
                                      - -
                                      -
                                      - - - -
                                      Return values
                                      - mixed - — - - -
                                      -
                                      -

                                      - doBulkInsert() - -

                                      - - -

                                      Bulk insert SQL of given data.

                                      - - - public - doBulkInsert(string $table[, array<string|int, mixed> $data = [] ][, array<string|int, mixed> $fixedValues = [] ][, mixed $onDuplicateKey = null ][, callable $callback = null ][, callable $itemCallback = null ][, int $bulkSize = 100 ][, string $pk = 'id' ]) : mixed - - -
                                      Parameters
                                      -
                                      -
                                      - $table - : string -
                                      -
                                      -

                                      The database table, where new items should be stored inside

                                      -
                                      - -
                                      -
                                      - $data - : array<string|int, mixed> - = []
                                      -
                                      -

                                      An array of values associated to its field

                                      -
                                      - -
                                      -
                                      - $fixedValues - : array<string|int, mixed> - = []
                                      -
                                      -

                                      A array of fixed values associated to its field that should be set for each row as fixed values

                                      -
                                      - -
                                      -
                                      - $onDuplicateKey - : mixed - = null
                                      -
                                      -

                                      null = Throw error on duplicates, self::ON_DUPLICATE_KEY_IGNORE = ignore error duplicates (skip this entries), -self::ON_DUPLICATE_KEY_UPDATE = update existing entries

                                      -
                                      - -
                                      -
                                      - $callback - : callable - = null
                                      -
                                      -

                                      A callback that should be triggered after each cycle, contains $arrValues of current cycle

                                      -
                                      - -
                                      -
                                      - $itemCallback - : callable - = null
                                      -
                                      -

                                      A callback to change the insert values for each items, contains $arrValues as first argument, $arrFields as -second, $arrOriginal as third, expects an array as return value with same order as $arrFields, if no array is -returned, insert of the row will be skipped item insert

                                      -
                                      - -
                                      -
                                      - $bulkSize - : int - = 100
                                      -
                                      -

                                      The bulk size

                                      -
                                      - -
                                      -
                                      - $pk - : string - = 'id'
                                      -
                                      -

                                      The primary key of the current table (default: id)

                                      -
                                      - -
                                      -
                                      - - - -
                                      Return values
                                      - mixed - — - - -
                                      -
                                      -

                                      - findOneResultBy() - -

                                      - - -

                                      Return a single database result by table and search criteria.

                                      - - - public - findOneResultBy(string $table, array<string|int, mixed>|null $columns, array<string|int, mixed>|null $values[, array<string|int, mixed> $options = [] ]) : mixed - - -
                                      Parameters
                                      -
                                      -
                                      - $table - : string -
                                      -
                                      -
                                      - -
                                      -
                                      - $columns - : array<string|int, mixed>|null -
                                      -
                                      -
                                      - -
                                      -
                                      - $values - : array<string|int, mixed>|null -
                                      -
                                      -
                                      - -
                                      -
                                      - $options - : array<string|int, mixed> - = []
                                      -
                                      -
                                      - -
                                      -
                                      - - - -
                                      Return values
                                      - mixed - — - - -
                                      -
                                      -

                                      - findResultByPk() - -

                                      - - -

                                      Returns a database result for a given table and id(primary key).

                                      - - - public - findResultByPk(string $table, mixed $pk[, array<string|int, mixed> $options = [] ]) : mixed - - -
                                      Parameters
                                      -
                                      -
                                      - $table - : string -
                                      -
                                      -
                                      - -
                                      -
                                      - $pk - : mixed -
                                      -
                                      - -
                                      -
                                      - $options - : array<string|int, mixed> - = []
                                      -
                                      -
                                      - -
                                      -
                                      - - - -
                                      Return values
                                      - mixed - — - - -
                                      -
                                      -

                                      - findResultsBy() - -

                                      - - - - - public - findResultsBy(string $table, array<string|int, mixed>|null $columns, array<string|int, mixed>|null $values[, array<string|int, mixed> $options = [] ]) : mixed - -
                                      - -
                                      Parameters
                                      -
                                      -
                                      - $table - : string -
                                      -
                                      -
                                      - -
                                      -
                                      - $columns - : array<string|int, mixed>|null -
                                      -
                                      -
                                      - -
                                      -
                                      - $values - : array<string|int, mixed>|null -
                                      -
                                      -
                                      - -
                                      -
                                      - $options - : array<string|int, mixed> - = []
                                      -
                                      -
                                      - -
                                      -
                                      - - - -
                                      Return values
                                      - mixed - — - - -
                                      -
                                      -

                                      - getChildRecords() - -

                                      - - - - - public - getChildRecords(array<string|int, mixed> $parentIds, string $table[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed> - -
                                      - -
                                      Parameters
                                      -
                                      -
                                      - $parentIds - : array<string|int, mixed> -
                                      -
                                      -
                                      - -
                                      -
                                      - $table - : string -
                                      -
                                      -
                                      - -
                                      -
                                      - $options - : array<string|int, mixed> - = []
                                      -
                                      -
                                      - -
                                      -
                                      - - - -
                                      Return values
                                      - array<string|int, mixed> - — - - -
                                      -
                                      -

                                      - insert() - -

                                      - - - - - public - insert(string $table, array<string|int, mixed> $set[, array<string|int, mixed> $options = [] ]) : mixed - -
                                      - -
                                      Parameters
                                      -
                                      -
                                      - $table - : string -
                                      -
                                      -
                                      - -
                                      -
                                      - $set - : array<string|int, mixed> -
                                      -
                                      -
                                      - -
                                      -
                                      - $options - : array<string|int, mixed> - = []
                                      -
                                      -
                                      - -
                                      -
                                      - - - -
                                      Return values
                                      - mixed - — - - -
                                      -
                                      -

                                      - processInPieces() - -

                                      - - -

                                      Process a query in pieces, run callback within each cycle.

                                      - - - public - processInPieces(string $countQuery, string $query[, callable $callback = null ][, string $key = null ][, int $bulkSize = 5000 ]) : bool|int - - -
                                      Parameters
                                      -
                                      -
                                      - $countQuery - : string -
                                      -
                                      -

                                      The query that count the total rows, must contain "Select COUNT(*) as total"

                                      -
                                      - -
                                      -
                                      - $query - : string -
                                      -
                                      -

                                      The query, with the rows that should be iterated over

                                      -
                                      - -
                                      -
                                      - $callback - : callable - = null
                                      -
                                      -

                                      A callback that should be triggered after each cycle, contains $arrRows of current cycle

                                      -
                                      - -
                                      -
                                      - $key - : string - = null
                                      -
                                      -

                                      The key of the value that should be set as key identifier for the returned result array entries

                                      -
                                      - -
                                      -
                                      - $bulkSize - : int - = 5000
                                      -
                                      -

                                      The bulk size

                                      -
                                      - -
                                      -
                                      - - - -
                                      Return values
                                      - bool|int - — -

                                      False if nothing to do, otherwise return the total number of processes entities

                                      -
                                      - - -
                                      -
                                      -

                                      - transformVerboseOperator() - -

                                      - - -

                                      Transforms verbose operators to valid MySQL operators (aka junctors).

                                      - - - public - transformVerboseOperator(string $verboseOperator) : string|bool - -

                                      Supports: like, unlike, equal, unequal, lower, greater, lowerequal, greaterequal, in, notin.

                                      -
                                      - -
                                      Parameters
                                      -
                                      -
                                      - $verboseOperator - : string -
                                      -
                                      -
                                      - -
                                      -
                                      - - - -
                                      Return values
                                      - string|bool - — -

                                      The transformed operator or false if not supported

                                      -
                                      - - -
                                      -
                                      -

                                      - update() - -

                                      - - - - - public - update(string $table, array<string|int, mixed> $set[, string $where = null ][, array<string|int, mixed> $whereValues = [] ][, array<string|int, mixed> $options = [] ]) : mixed - -
                                      - -
                                      Parameters
                                      -
                                      -
                                      - $table - : string -
                                      -
                                      -
                                      - -
                                      -
                                      - $set - : array<string|int, mixed> -
                                      -
                                      -
                                      - -
                                      -
                                      - $where - : string - = null
                                      -
                                      -
                                      - -
                                      -
                                      - $whereValues - : array<string|int, mixed> - = []
                                      -
                                      -
                                      - -
                                      -
                                      - $options - : array<string|int, mixed> - = []
                                      -
                                      -
                                      - -
                                      -
                                      - - - -
                                      Return values
                                      - mixed - — - - -
                                      -
                                      -

                                      - createQueryWithoutRelations() - -

                                      - - -

                                      Adapted from \Contao\Model\QueryBuilder::find().

                                      - - - private - createQueryWithoutRelations(array<string|int, mixed> $options) : string - - -
                                      Parameters
                                      -
                                      -
                                      - $options - : array<string|int, mixed> -
                                      -
                                      -
                                      - -
                                      -
                                      - - - -
                                      Return values
                                      - string - — - - -
                                      -
                                      - - - - -
                                      -
                                      -
                                      -
                                      -

                                      Search results

                                      - -
                                      -
                                      -
                                        -
                                        -
                                        -
                                        -
                                        -
                                        - - -
                                        - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Date-DateUtil.html b/classes/HeimrichHannot-UtilsBundle-Date-DateUtil.html deleted file mode 100644 index 0c93fc86..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Date-DateUtil.html +++ /dev/null @@ -1,1262 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                        -

                                        Contao Utils Bundle

                                        - - -
                                        - -
                                        - - -
                                        - -
                                        -
                                        - - - - -
                                        - - -
                                        -

                                        - DateUtil - - -
                                        - in package - -
                                        - - -

                                        - - - - -
                                        - - - - - - - - -

                                        - Table of Contents - -

                                        - -
                                        -
                                        - $container - -  : ContainerInterface -
                                        -
                                        - -
                                        - $framework - -  : ContaoFramework -
                                        -
                                        - -
                                        - __construct() - -  : mixed -
                                        -
                                        - -
                                        - convertSecondsToHumanReadableFormat() - -  : mixed -
                                        -
                                        - -
                                        - getDaysBetween() - -  : float|int -
                                        -
                                        - -
                                        - getFormattedDateTime() - -  : string|null -
                                        -
                                        - -
                                        - getFormattedDateTimeByEvent() - -  : string|null -
                                        -
                                        - -
                                        - getGMTMidnightTstamp() - -  : int -
                                        -
                                        transfer a given timestamp to a gmt timestamp at midnight.
                                        - -
                                        - getMonthTranslationMap() - -  : mixed -
                                        -
                                        - -
                                        - getShortMonthTranslationMap() - -  : mixed -
                                        -
                                        - -
                                        - getTimePeriodInSeconds() - -  : float|int|null -
                                        -
                                        Returns the time in seconds of an given time period.
                                        - -
                                        - getTimeStamp() - -  : int -
                                        -
                                        Get the timestamp based on input date, no matter input is timestamp or string date.
                                        - -
                                        - isDayInDateFormat() - -  : bool -
                                        -
                                        Checks if a form of day is available in the date format.
                                        - -
                                        - isMonthInDateFormat() - -  : bool -
                                        -
                                        Checks if a form of month is available in the date format.
                                        - -
                                        - isYearInDateFormat() - -  : bool -
                                        -
                                        Checks if a form of year is available in the date format.
                                        - -
                                        - transformPhpDateFormatToISO8601() - -  : string -
                                        -
                                        Format a php date formate pattern to an ISO8601 compliant format.
                                        - -
                                        - transformPhpDateFormatToRFC3339() - -  : string -
                                        -
                                        Format a php date formate pattern to an RFC3339 compliant format.
                                        - -
                                        - translateMonths() - -  : mixed|string -
                                        -
                                        Translates available months inside a given string from English to the current language.
                                        - -
                                        - translateMonthsToEnglish() - -  : mixed|string -
                                        -
                                        Translates available months inside a given string into their English representations taking into account the current language.
                                        - -
                                        - - - - - - -
                                        -

                                        - Properties - -

                                        -
                                        -

                                        - $container - - - -

                                        - - - - - protected - ContainerInterface - $container - - - - - - -
                                        -
                                        -

                                        - $framework - - - -

                                        - - - - - protected - ContaoFramework - $framework - - - - - - -
                                        -
                                        - -
                                        -

                                        - Methods - -

                                        -
                                        -

                                        - __construct() - -

                                        - - - - - public - __construct(ContainerInterface $container) : mixed - -
                                        - -
                                        Parameters
                                        -
                                        -
                                        - $container - : ContainerInterface -
                                        -
                                        -
                                        - -
                                        -
                                        - - - -
                                        Return values
                                        - mixed - — - - -
                                        -
                                        -

                                        - convertSecondsToHumanReadableFormat() - -

                                        - - - - - public - convertSecondsToHumanReadableFormat(mixed $seconds) : mixed - -
                                        - -
                                        Parameters
                                        -
                                        -
                                        - $seconds - : mixed -
                                        -
                                        -
                                        - -
                                        -
                                        - - - -
                                        Return values
                                        - mixed - — - - -
                                        -
                                        -

                                        - getDaysBetween() - -

                                        - - - - - public - getDaysBetween(int $smallerTimestamp[, int $largerTimestamp = null ][, bool $returnFullDays = false ]) : float|int - - -
                                        Parameters
                                        -
                                        -
                                        - $smallerTimestamp - : int -
                                        -
                                        -
                                        - -
                                        -
                                        - $largerTimestamp - : int - = null
                                        -
                                        -
                                        - -
                                        -
                                        - $returnFullDays - : bool - = false
                                        -
                                        -

                                        If true, only full days are returned (0.67 -> 0)

                                        -
                                        - -
                                        -
                                        - - - -
                                        Return values
                                        - float|int - — - - -
                                        -
                                        -

                                        - getFormattedDateTime() - -

                                        - - - - - public - getFormattedDateTime(mixed $startDate, mixed $endDate[, mixed $addTime = false ], mixed $startTime, mixed $endTime[, array<string|int, mixed> $options = [] ]) : string|null - -
                                        - -
                                        Parameters
                                        -
                                        -
                                        - $startDate - : mixed -
                                        -
                                        -
                                        - -
                                        -
                                        - $endDate - : mixed -
                                        -
                                        -
                                        - -
                                        -
                                        - $addTime - : mixed - = false
                                        -
                                        -
                                        - -
                                        -
                                        - $startTime - : mixed -
                                        -
                                        -
                                        - -
                                        -
                                        - $endTime - : mixed -
                                        -
                                        -
                                        - -
                                        -
                                        - $options - : array<string|int, mixed> - = []
                                        -
                                        -
                                        - -
                                        -
                                        - - - -
                                        Return values
                                        - string|null - — - - -
                                        -
                                        -

                                        - getFormattedDateTimeByEvent() - -

                                        - - - - - public - getFormattedDateTimeByEvent(Model $event) : string|null - -
                                        - -
                                        Parameters
                                        -
                                        -
                                        - $event - : Model -
                                        -
                                        -
                                        - -
                                        -
                                        - - - -
                                        Return values
                                        - string|null - — - - -
                                        -
                                        -

                                        - getGMTMidnightTstamp() - -

                                        - - -

                                        transfer a given timestamp to a gmt timestamp at midnight.

                                        - - - public - getGMTMidnightTstamp(int $tstamp) : int - - -
                                        Parameters
                                        -
                                        -
                                        - $tstamp - : int -
                                        -
                                        -
                                        - -
                                        -
                                        - - - -
                                        Return values
                                        - int - — - - -
                                        -
                                        -

                                        - getMonthTranslationMap() - -

                                        - - - - - public - getMonthTranslationMap() : mixed - -
                                        - - - - -
                                        Return values
                                        - mixed - — - - -
                                        -
                                        -

                                        - getShortMonthTranslationMap() - -

                                        - - - - - public - getShortMonthTranslationMap() : mixed - -
                                        - - - - -
                                        Return values
                                        - mixed - — - - -
                                        -
                                        -

                                        - getTimePeriodInSeconds() - -

                                        - - -

                                        Returns the time in seconds of an given time period.

                                        - - - public - getTimePeriodInSeconds(string|array<string|int, mixed> $timePeriod) : float|int|null - - -
                                        Parameters
                                        -
                                        -
                                        - $timePeriod - : string|array<string|int, mixed> -
                                        -
                                        -

                                        Array or serialized string containing an value and an unit key

                                        -
                                        - -
                                        -
                                        - - - -
                                        Return values
                                        - float|int|null - — - - -
                                        -
                                        -

                                        - getTimeStamp() - -

                                        - - -

                                        Get the timestamp based on input date, no matter input is timestamp or string date.

                                        - - - public - getTimeStamp([string|int|DateTime|null $date = null ][, bool $replaceInsertTags = true ][, string|null $timezone = null ]) : int - - -
                                        Parameters
                                        -
                                        -
                                        - $date - : string|int|DateTime|null - = null
                                        -
                                        -

                                        The input date/timestamp/insertTag

                                        -
                                        - -
                                        -
                                        - $replaceInsertTags - : bool - = true
                                        -
                                        -

                                        Disable/enable {{date::}} insertTag support

                                        -
                                        - -
                                        -
                                        - $timezone - : string|null - = null
                                        -
                                        -

                                        A valid timezone from DateTimeZone::ALL, if provided the timezone offset will be added to the timestamp

                                        -
                                        - -
                                        -
                                        - - -
                                        - Tags - -
                                        -
                                        -
                                        - throws -
                                        -
                                        - Exception - -

                                        Throws error in case of an error when creating new DateTime instances

                                        -
                                        - -
                                        -
                                        - -
                                        Return values
                                        - int - — -

                                        The integer timestamp presentation of the input date with added timezone offset

                                        -
                                        - - -
                                        -
                                        -

                                        - isDayInDateFormat() - -

                                        - - -

                                        Checks if a form of day is available in the date format.

                                        - - - public - isDayInDateFormat(string $dateFormat) : bool - - -
                                        Parameters
                                        -
                                        -
                                        - $dateFormat - : string -
                                        -
                                        -
                                        - -
                                        -
                                        - - - -
                                        Return values
                                        - bool - — - - -
                                        -
                                        -

                                        - isMonthInDateFormat() - -

                                        - - -

                                        Checks if a form of month is available in the date format.

                                        - - - public - isMonthInDateFormat(string $dateFormat) : bool - - -
                                        Parameters
                                        -
                                        -
                                        - $dateFormat - : string -
                                        -
                                        -
                                        - -
                                        -
                                        - - - -
                                        Return values
                                        - bool - — - - -
                                        -
                                        -

                                        - isYearInDateFormat() - -

                                        - - -

                                        Checks if a form of year is available in the date format.

                                        - - - public - isYearInDateFormat(string $dateFormat) : bool - - -
                                        Parameters
                                        -
                                        -
                                        - $dateFormat - : string -
                                        -
                                        -
                                        - -
                                        -
                                        - - - -
                                        Return values
                                        - bool - — - - -
                                        -
                                        -

                                        - transformPhpDateFormatToISO8601() - -

                                        - - -

                                        Format a php date formate pattern to an ISO8601 compliant format.

                                        - - - public - transformPhpDateFormatToISO8601(string $format) : string - - -
                                        Parameters
                                        -
                                        -
                                        - $format - : string -
                                        -
                                        -

                                        The date format (e.g. "d.m.y H:i")

                                        -
                                        - -
                                        -
                                        - - - -
                                        Return values
                                        - string - — -

                                        The ISO8601 compliant format (see: https://de.wikipedia.org/wiki/ISO_8601)

                                        -
                                        - - -
                                        -
                                        -

                                        - transformPhpDateFormatToRFC3339() - -

                                        - - -

                                        Format a php date formate pattern to an RFC3339 compliant format.

                                        - - - public - transformPhpDateFormatToRFC3339(string $format) : string - - -
                                        Parameters
                                        -
                                        -
                                        - $format - : string -
                                        -
                                        -

                                        The php date format (see: http://php.net/manual/de/function.date.php#refsect1-function.date-parameters)

                                        -
                                        - -
                                        -
                                        - - - -
                                        Return values
                                        - string - — -

                                        The RFC3339 compliant format (see: http://userguide.icu-project.org/formatparse/datetime#TOC-Date-Time-Format-Syntax or http://www.unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table)

                                        -
                                        - - -
                                        -
                                        -

                                        - translateMonths() - -

                                        - - -

                                        Translates available months inside a given string from English to the current language.

                                        - - - public - translateMonths(string $date) : mixed|string - - -
                                        Parameters
                                        -
                                        -
                                        - $date - : string -
                                        -
                                        -
                                        - -
                                        -
                                        - - - -
                                        Return values
                                        - mixed|string - — - - -
                                        -
                                        -

                                        - translateMonthsToEnglish() - -

                                        - - -

                                        Translates available months inside a given string into their English representations taking into account the current language.

                                        - - - public - translateMonthsToEnglish(string $date) : mixed|string - - -
                                        Parameters
                                        -
                                        -
                                        - $date - : string -
                                        -
                                        -
                                        - -
                                        -
                                        - - - -
                                        Return values
                                        - mixed|string - — - - -
                                        -
                                        - - - - -
                                        -
                                        -
                                        -
                                        -

                                        Search results

                                        - -
                                        -
                                        -
                                          -
                                          -
                                          -
                                          -
                                          -
                                          - - -
                                          - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Dca-AuthorField.html b/classes/HeimrichHannot-UtilsBundle-Dca-AuthorField.html index f53b2094..a8488c31 100644 --- a/classes/HeimrichHannot-UtilsBundle-Dca-AuthorField.html +++ b/classes/HeimrichHannot-UtilsBundle-Dca-AuthorField.html @@ -147,7 +147,7 @@

                                          $tables -  : mixed +  : array<string|int, mixed>
                                          @@ -168,7 +168,7 @@

                                          createOptionObject() -  : AuthorFieldConfiguration +  : DcaFieldConfiguration|AuthorFieldConfiguration
                                          @@ -285,7 +285,7 @@

                                          protected - static mixed + static array<string|int, mixed> $tables = [] @@ -392,16 +392,17 @@

                                          protected - static createOptionObject(string $table) : AuthorFieldConfiguration + static createOptionObject(string $table) : DcaFieldConfiguration|AuthorFieldConfiguration + +
                                          -

                                          Parameters
                                          @@ -409,14 +410,15 @@
                                          Parameters
                                          : string
                                          - +
                                          +
                                          Return values
                                          - AuthorFieldConfiguration + DcaFieldConfiguration|AuthorFieldConfiguration — @@ -434,7 +436,7 @@

                                          @@ -467,7 +469,7 @@

                                          diff --git a/classes/HeimrichHannot-UtilsBundle-Dca-AuthorFieldConfiguration.html b/classes/HeimrichHannot-UtilsBundle-Dca-AuthorFieldConfiguration.html index 9de7551e..2ec7d838 100644 --- a/classes/HeimrichHannot-UtilsBundle-Dca-AuthorFieldConfiguration.html +++ b/classes/HeimrichHannot-UtilsBundle-Dca-AuthorFieldConfiguration.html @@ -312,7 +312,7 @@

                                          @@ -323,8 +323,10 @@

                                          $exclude = true - - +
                                          + +
                                          + @@ -344,7 +346,7 @@

                                          @@ -355,8 +357,10 @@

                                          $fieldNamePrefix = '' - - +
                                          + +
                                          + @@ -376,7 +380,7 @@

                                          @@ -387,8 +391,10 @@

                                          $filter = true - - +
                                          + +
                                          + @@ -408,7 +414,7 @@

                                          @@ -419,8 +425,10 @@

                                          $search = true - - +
                                          + +
                                          + @@ -440,7 +448,7 @@

                                          @@ -451,8 +459,10 @@

                                          $type = HeimrichHannotUtilsBundleDcaAuthorField::TYPE_USER - - +
                                          + +
                                          + @@ -472,7 +482,7 @@

                                          @@ -483,8 +493,10 @@

                                          $useDefaultLabel = true - - +
                                          + +
                                          + @@ -504,7 +516,7 @@

                                          @@ -515,8 +527,10 @@

                                          $table - - +
                                          + +
                                          + @@ -540,7 +554,7 @@

                                          @@ -549,7 +563,8 @@

                                          public __construct(string $table) : mixed - +
                                          +

                                          Parameters
                                          @@ -557,7 +572,8 @@
                                          Parameters
                                          : string
                                          - +
                                          +
                                          @@ -582,7 +598,7 @@

                                          @@ -615,7 +631,7 @@

                                          @@ -648,7 +664,7 @@

                                          @@ -681,7 +697,7 @@

                                          @@ -714,7 +730,7 @@

                                          @@ -747,7 +763,7 @@

                                          @@ -780,7 +796,7 @@

                                          @@ -813,7 +829,7 @@

                                          @@ -846,7 +862,7 @@

                                          @@ -890,7 +906,7 @@

                                          @@ -934,7 +950,7 @@

                                          @@ -978,7 +994,7 @@

                                          @@ -1022,7 +1038,7 @@

                                          @@ -1066,7 +1082,7 @@

                                          diff --git a/classes/HeimrichHannot-UtilsBundle-Dca-DateAddedField.html b/classes/HeimrichHannot-UtilsBundle-Dca-DateAddedField.html index 5482c03f..d7b86f78 100644 --- a/classes/HeimrichHannot-UtilsBundle-Dca-DateAddedField.html +++ b/classes/HeimrichHannot-UtilsBundle-Dca-DateAddedField.html @@ -133,7 +133,7 @@

                                          $tables -  : mixed +  : array<string|int, mixed>
                                          @@ -207,7 +207,7 @@

                                          private - static mixed + static array<string|int, mixed> $tables = [] diff --git a/classes/HeimrichHannot-UtilsBundle-Dca-DcaFieldConfiguration.html b/classes/HeimrichHannot-UtilsBundle-Dca-DcaFieldConfiguration.html index f186eeb6..dd286a09 100644 --- a/classes/HeimrichHannot-UtilsBundle-Dca-DcaFieldConfiguration.html +++ b/classes/HeimrichHannot-UtilsBundle-Dca-DcaFieldConfiguration.html @@ -176,7 +176,7 @@

                                          @@ -187,8 +187,10 @@

                                          $table - - +
                                          + +
                                          + @@ -212,7 +214,7 @@

                                          @@ -221,7 +223,8 @@

                                          public __construct(string $table) : mixed - +
                                          +

                                          Parameters
                                          @@ -229,7 +232,8 @@
                                          Parameters
                                          : string
                                          - +
                                          +
                                          @@ -254,7 +258,7 @@

                                          diff --git a/classes/HeimrichHannot-UtilsBundle-Dca-DcaUtil.html b/classes/HeimrichHannot-UtilsBundle-Dca-DcaUtil.html deleted file mode 100644 index 17da1fb6..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Dca-DcaUtil.html +++ /dev/null @@ -1,3570 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                          -

                                          Contao Utils Bundle

                                          - - -
                                          - -
                                          - - -
                                          - -
                                          -
                                          - - - - -
                                          - - -
                                          -

                                          - DcaUtil - - -
                                          - in package - -
                                          - - -

                                          - - - - -
                                          - - - - - - - - -

                                          - Table of Contents - -

                                          - -
                                          -
                                          - AUTHOR_TYPE_MEMBER - -  = 'member' -
                                          -
                                          - -
                                          - AUTHOR_TYPE_NONE - -  = 'none' -
                                          -
                                          - -
                                          - AUTHOR_TYPE_SESSION - -  = 'session' -
                                          -
                                          - -
                                          - AUTHOR_TYPE_USER - -  = 'user' -
                                          -
                                          - -
                                          - PROPERTY_AUTHOR - -  = 'author' -
                                          -
                                          - -
                                          - PROPERTY_AUTHOR_TYPE - -  = 'authorType' -
                                          -
                                          - -
                                          - PROPERTY_SESSION_ID - -  = 'sessionID' -
                                          -
                                          - -
                                          - $container - -  : ContainerInterface -
                                          -
                                          - -
                                          - $framework - -  : ContaoFrameworkInterface -
                                          -
                                          - -
                                          - $connection - -  : Connection -
                                          -
                                          - -
                                          - $routingUtil - -  : RoutingUtil -
                                          -
                                          - -
                                          - __construct() - -  : mixed -
                                          -
                                          - -
                                          - activateNotificationType() - -  : mixed -
                                          -
                                          - -
                                          - addAliasToDca() - -  : mixed -
                                          -
                                          Adds an alias field to the dca and to the desired palettes.
                                          - -
                                          - addAuthorFieldAndCallback() - -  : mixed -
                                          -
                                          - -
                                          - addOverridableFields() - -  : mixed -
                                          -
                                          Adds an override selector to every field in $fields to the dca associated with $destinationTable.
                                          - -
                                          - aliasExist() - -  : bool -
                                          -
                                          Return if the current alias already exist in table.
                                          - -
                                          - doGenerateDcOperationsButtons() - -  : mixed -
                                          -
                                          - -
                                          - flattenPaletteForSubEntities() - -  : mixed -
                                          -
                                          This function transforms an entity's palette (that can also contain sub palettes and concatenated type selectors) to a flatten -palette where every field can be overridden.
                                          - -
                                          - generateAlias() - -  : string -
                                          -
                                          Generate an alias with unique check.
                                          - -
                                          - generateDcOperationsButtons() - -  : mixed -
                                          -
                                          - -
                                          - generateSitemap() - -  : mixed -
                                          -
                                          - -
                                          - getArchiveModalEditLink() - -  : string -
                                          -
                                          Get a contao backend modal archive edit link.
                                          - -
                                          - getAuthorNameByUserId() - -  : mixed -
                                          -
                                          - -
                                          - getAuthorNameLinkByUserId() - -  : mixed -
                                          -
                                          - -
                                          - getConfigByArrayOrCallbackOrFunction() - -  : mixed|null -
                                          -
                                          Retrieves an array from a dca config (in most cases eval) in the following priorities:.
                                          - -
                                          - getCurrentPaletteName() - -  : string|null -
                                          -
                                          Taken from \Contao\DataContainer.
                                          - -
                                          - getDataContainers() - -  : array<string|int, mixed> -
                                          -
                                          Returns (nearly) all registered datacontainers as array.
                                          - -
                                          - getDCTable() - -  : DC_Table_Utils -
                                          -
                                          Mostly used for Form::prepareSpecialValueForOutput().
                                          - -
                                          - getEditLink() - -  : string -
                                          -
                                          Get a contao backend modal edit link.
                                          - -
                                          - getFieldLabel() - -  : mixed -
                                          -
                                          - -
                                          - getFields() - -  : array<string|int, mixed> -
                                          -
                                          Returns a list of fields as an option array for dca fields.
                                          - -
                                          - getLocalizedFieldName() - -  : mixed -
                                          -
                                          - -
                                          - getModalEditLink() - -  : string -
                                          -
                                          Get a contao backend modal edit link.
                                          - -
                                          - getNewNotificationTypeArray() - -  : array<string|int, mixed> -
                                          -
                                          - -
                                          - getNewSortingPosition() - -  : array<string|int, mixed> -
                                          -
                                          Returns the set of pid and sorting to be used in an sql update statement. Also updates the existing records according to the usage.
                                          - -
                                          - getOverridableProperty() - -  : mixed -
                                          -
                                          Retrieves a property of given contao model instances by *ascending* priority, i.e. the last instance of $instances -will have the highest priority.
                                          - -
                                          - getPopupWizardLink() - -  : string -
                                          -
                                          Get a contao backend popup link.
                                          - -
                                          - getRenderedDiff() - -  : mixed -
                                          -
                                          - -
                                          - getSubPaletteFieldSelector() - -  : string -
                                          -
                                          Returns the selector of the sub palette a field is placed in. Currently doesn't support fields in multiple sub palettes.
                                          - -
                                          - getTranslatedModuleNameByTable() - -  : mixed -
                                          -
                                          - -
                                          - isDcMultilingual() - -  : mixed -
                                          -
                                          - -
                                          - isDcMultilingual3() - -  : mixed -
                                          -
                                          - -
                                          - isSubPaletteField() - -  : bool -
                                          -
                                          Returns true if the field is in at least one sub palette.
                                          - -
                                          - loadDc() - -  : mixed -
                                          -
                                          Load a data container in a testable way.
                                          - -
                                          - loadLanguageFile() - -  : mixed -
                                          -
                                          Load a language file in a testable way.
                                          - -
                                          - modifyAuthorPaletteOnLoad() - -  : mixed -
                                          -
                                          - -
                                          - prepareRowEntryForList() - -  : mixed -
                                          -
                                          - -
                                          - setAuthorIDOnCreate() - -  : mixed -
                                          -
                                          - -
                                          - setDateAdded() - -  : mixed -
                                          -
                                          Sets the current date as the date added -> usually used on submit.
                                          - -
                                          - setDateAddedOnCopy() - -  : mixed -
                                          -
                                          Sets the current date as the date added -> usually used on copy.
                                          - -
                                          - setDefaultsFromDca() - -  : mixed -
                                          -
                                          Set initial $varData from dca.
                                          - -
                                          - setFieldsToReadOnly() - -  : mixed -
                                          -
                                          - -
                                          - combiner() - -  : mixed -
                                          -
                                          Taken from \Contao\DataContainer.
                                          - -
                                          - - - - -
                                          -

                                          - Constants - -

                                          -
                                          -

                                          - AUTHOR_TYPE_MEMBER - -

                                          - - - - - - public - mixed - AUTHOR_TYPE_MEMBER - = 'member' - - - -
                                          - -
                                          - - - -
                                          -
                                          -

                                          - AUTHOR_TYPE_NONE - -

                                          - - - - - - public - mixed - AUTHOR_TYPE_NONE - = 'none' - - - -
                                          - -
                                          - - - -
                                          -
                                          -

                                          - AUTHOR_TYPE_SESSION - -

                                          - - - - - - public - mixed - AUTHOR_TYPE_SESSION - = 'session' - - - -
                                          - -
                                          - - - -
                                          -
                                          -

                                          - AUTHOR_TYPE_USER - -

                                          - - - - - - public - mixed - AUTHOR_TYPE_USER - = 'user' - - - -
                                          - -
                                          - - - -
                                          -
                                          -

                                          - PROPERTY_AUTHOR - -

                                          - - - - - - public - mixed - PROPERTY_AUTHOR - = 'author' - - - -
                                          - -
                                          - - - -
                                          -
                                          -

                                          - PROPERTY_AUTHOR_TYPE - -

                                          - - - - - - public - mixed - PROPERTY_AUTHOR_TYPE - = 'authorType' - - - -
                                          - -
                                          - - - -
                                          -
                                          -

                                          - PROPERTY_SESSION_ID - -

                                          - - - - - - public - mixed - PROPERTY_SESSION_ID - = 'sessionID' - - - -
                                          - -
                                          - - - -
                                          -
                                          - - -
                                          -

                                          - Properties - -

                                          -
                                          -

                                          - $container - - - -

                                          - - - - - protected - ContainerInterface - $container - - - - - - -
                                          -
                                          -

                                          - $framework - - - -

                                          - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
                                          -
                                          -

                                          - $connection - - - -

                                          - - - - - private - Connection - $connection - - - - - - -
                                          -
                                          -

                                          - $routingUtil - - - -

                                          - - - - - private - RoutingUtil - $routingUtil - - - - - - -
                                          -
                                          - -
                                          -

                                          - Methods - -

                                          -
                                          -

                                          - __construct() - -

                                          - - - - - public - __construct(ContainerInterface $container, ContaoFrameworkInterface $framework, RoutingUtil $routingUtil, Connection $connection) : mixed - -
                                          - -
                                          Parameters
                                          -
                                          -
                                          - $container - : ContainerInterface -
                                          -
                                          -
                                          - -
                                          -
                                          - $framework - : ContaoFrameworkInterface -
                                          -
                                          -
                                          - -
                                          -
                                          - $routingUtil - : RoutingUtil -
                                          -
                                          -
                                          - -
                                          -
                                          - $connection - : Connection -
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - activateNotificationType() - -

                                          - - - - - public - activateNotificationType(mixed $strGroup, mixed $strType, mixed $arrType) : mixed - -
                                          - -
                                          Parameters
                                          -
                                          -
                                          - $strGroup - : mixed -
                                          -
                                          -
                                          - -
                                          -
                                          - $strType - : mixed -
                                          -
                                          -
                                          - -
                                          -
                                          - $arrType - : mixed -
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - addAliasToDca() - -

                                          - - -

                                          Adds an alias field to the dca and to the desired palettes.

                                          - - - public - addAliasToDca( $dca,  $generateAliasCallback,  $paletteField[, array<string|int, mixed> $palettes = ['default'] ]) : mixed - - -
                                          Parameters
                                          -
                                          -
                                          - $dca - : -
                                          -
                                          - -
                                          -
                                          - $generateAliasCallback - : -
                                          -
                                          -

                                          mixed The callback to call for generating the alias

                                          -
                                          - -
                                          -
                                          - $paletteField - : -
                                          -
                                          -

                                          String The field after which to insert the alias field in the palettes

                                          -
                                          - -
                                          -
                                          - $palettes - : array<string|int, mixed> - = ['default']
                                          -
                                          -

                                          The palettes in which to insert the field

                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - addAuthorFieldAndCallback() - -

                                          - - - - - public - addAuthorFieldAndCallback(string $table[, string $fieldPrefix = '' ]) : mixed - - -
                                          Parameters
                                          -
                                          -
                                          - $table - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - $fieldPrefix - : string - = ''
                                          -
                                          -
                                          - -
                                          -
                                          - - -
                                          - Tags - -
                                          -
                                          -
                                          - deprecated -
                                          -
                                          - -

                                          Use AuthorField::register() instead

                                          -
                                          - -
                                          -
                                          - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - addOverridableFields() - -

                                          - - -

                                          Adds an override selector to every field in $fields to the dca associated with $destinationTable.

                                          - - - public - addOverridableFields(array<string|int, mixed> $fields, string $sourceTable, string $destinationTable[, array<string|int, mixed> $options = [] ]) : mixed - - -
                                          Parameters
                                          -
                                          -
                                          - $fields - : array<string|int, mixed> -
                                          -
                                          -
                                          - -
                                          -
                                          - $sourceTable - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - $destinationTable - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - $options - : array<string|int, mixed> - = []
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - aliasExist() - -

                                          - - -

                                          Return if the current alias already exist in table.

                                          - - - public - aliasExist(string $alias, int $id, string $table[, mixed $options = [] ]) : bool - - -
                                          Parameters
                                          -
                                          -
                                          - $alias - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - $id - : int -
                                          -
                                          -
                                          - -
                                          -
                                          - $table - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - $options - : mixed - = []
                                          -
                                          -
                                          - -
                                          -
                                          - - -
                                          - Tags - -
                                          -
                                          -
                                          - throws -
                                          -
                                          - DBALException - - -
                                          -
                                          - -
                                          Return values
                                          - bool - — - - -
                                          -
                                          -

                                          - doGenerateDcOperationsButtons() - -

                                          - - - - - public - doGenerateDcOperationsButtons(mixed $arrRow, mixed $strTable[, mixed $arrRootIds = [] ][, mixed $blnCircularReference = false ][, mixed $arrChildRecordIds = null ][, mixed $options = [] ]) : mixed - -
                                          - -
                                          Parameters
                                          -
                                          -
                                          - $arrRow - : mixed -
                                          -
                                          -
                                          - -
                                          -
                                          - $strTable - : mixed -
                                          -
                                          -
                                          - -
                                          -
                                          - $arrRootIds - : mixed - = []
                                          -
                                          -
                                          - -
                                          -
                                          - $blnCircularReference - : mixed - = false
                                          -
                                          -
                                          - -
                                          -
                                          - $arrChildRecordIds - : mixed - = null
                                          -
                                          -
                                          - -
                                          -
                                          - $options - : mixed - = []
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - flattenPaletteForSubEntities() - -

                                          - - -

                                          This function transforms an entity's palette (that can also contain sub palettes and concatenated type selectors) to a flatten -palette where every field can be overridden.

                                          - - - public - flattenPaletteForSubEntities(string $table, array<string|int, mixed> $overridableFields) : mixed - -

                                          CAUTION: This function assumes that you have used addOverridableFields() for adding the fields that are overridable. The latter ones -are $overridableFields

                                          -

                                          This function is useful if you want to adjust a palette for sub entities that can override properties of their ancestor(s). -Use $this->getOverridableProperty() for computing the correct value respecting the entity hierarchy.

                                          -
                                          - -
                                          Parameters
                                          -
                                          -
                                          - $table - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - $overridableFields - : array<string|int, mixed> -
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - generateAlias() - -

                                          - - -

                                          Generate an alias with unique check.

                                          - - - public - generateAlias(mixed $alias, int $id, string|null $table, string $title[, bool $keepUmlauts = true ][, mixed $options = [] ]) : string - - -
                                          Parameters
                                          -
                                          -
                                          - $alias - : mixed -
                                          -
                                          -

                                          The current alias (if available)

                                          -
                                          - -
                                          -
                                          - $id - : int -
                                          -
                                          -

                                          The entity's id

                                          -
                                          - -
                                          -
                                          - $table - : string|null -
                                          -
                                          -

                                          The entity's table (pass a comma separated list if the validation should be expanded to multiple tables like tl_news AND tl_member. ATTENTION: the first table needs to be the one we're currently in). Pass null to skip unqiue check.

                                          -
                                          - -
                                          -
                                          - $title - : string -
                                          -
                                          -

                                          The value to use as a base for the alias

                                          -
                                          - -
                                          -
                                          - $keepUmlauts - : bool - = true
                                          -
                                          -

                                          Set to true if German umlauts should be kept

                                          -
                                          - -
                                          -
                                          - $options - : mixed - = []
                                          -
                                          -
                                          - -
                                          -
                                          - - -
                                          - Tags - -
                                          -
                                          -
                                          - throws -
                                          -
                                          - Exception - - -
                                          -
                                          - -
                                          Return values
                                          - string - — - - -
                                          -
                                          -

                                          - generateDcOperationsButtons() - -

                                          - - - - - public - generateDcOperationsButtons(mixed $row, mixed $table[, mixed $rootIds = [] ][, mixed $options = [] ]) : mixed - -
                                          - -
                                          Parameters
                                          -
                                          -
                                          - $row - : mixed -
                                          -
                                          -
                                          - -
                                          -
                                          - $table - : mixed -
                                          -
                                          -
                                          - -
                                          -
                                          - $rootIds - : mixed - = []
                                          -
                                          -
                                          - -
                                          -
                                          - $options - : mixed - = []
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - generateSitemap() - -

                                          - - - - - public - generateSitemap() : mixed - -
                                          - - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - getArchiveModalEditLink() - -

                                          - - -

                                          Get a contao backend modal archive edit link.

                                          - - - public - getArchiveModalEditLink(string $module, int $id, string $table[, string|null $label = null ][, int $width = 1024 ]) : string - - -
                                          Parameters
                                          -
                                          -
                                          - $module - : string -
                                          -
                                          -

                                          Name of the module

                                          -
                                          - -
                                          -
                                          - $id - : int -
                                          -
                                          -

                                          Id of the entity

                                          -
                                          - -
                                          -
                                          - $table - : string -
                                          -
                                          -

                                          The dataContainer table

                                          -
                                          - -
                                          -
                                          - $label - : string|null - = null
                                          -
                                          -

                                          The label text

                                          -
                                          - -
                                          -
                                          - $width - : int - = 1024
                                          -
                                          -

                                          The modal window width

                                          -
                                          - -
                                          -
                                          - - -
                                          - Tags - -
                                          -
                                          -
                                          - deprecated -
                                          -
                                          - -

                                          Use DcaUtil::getPopupWizardLink() instead

                                          -
                                          - -
                                          -
                                          - -
                                          Return values
                                          - string - — -

                                          The modal archive edit link

                                          -
                                          - - -
                                          -
                                          -

                                          - getAuthorNameByUserId() - -

                                          - - - - - public - getAuthorNameByUserId(mixed $id) : mixed - -
                                          - -
                                          Parameters
                                          -
                                          -
                                          - $id - : mixed -
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - getAuthorNameLinkByUserId() - -

                                          - - - - - public - getAuthorNameLinkByUserId(mixed $id) : mixed - -
                                          - -
                                          Parameters
                                          -
                                          -
                                          - $id - : mixed -
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - getConfigByArrayOrCallbackOrFunction() - -

                                          - - -

                                          Retrieves an array from a dca config (in most cases eval) in the following priorities:.

                                          - - - public - getConfigByArrayOrCallbackOrFunction(array<string|int, mixed> $array,  $property[, array<string|int, mixed> $arguments = [] ]) : mixed|null - -
                                            -
                                          1. The value associated to $array[$property]
                                            2. -
                                          2. The value retrieved by $array[$property . '_callback'] which is a callback array like ['Class', 'method'] or ['service.id', 'method']
                                            3. -
                                          3. The value retrieved by $array[$property . '_callback'] which is a function closure array like ['Class', 'method']
                                            4. -
                                          -
                                          - -
                                          Parameters
                                          -
                                          -
                                          - $array - : array<string|int, mixed> -
                                          -
                                          -
                                          - -
                                          -
                                          - $property - : -
                                          -
                                          - -
                                          -
                                          - $arguments - : array<string|int, mixed> - = []
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed|null - — -

                                          The value retrieved in the way mentioned above or null

                                          -
                                          - - -
                                          -
                                          -

                                          - getCurrentPaletteName() - -

                                          - - -

                                          Taken from \Contao\DataContainer.

                                          - - - public - getCurrentPaletteName(string $table, int $id) : string|null - - -
                                          Parameters
                                          -
                                          -
                                          - $table - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - $id - : int -
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - string|null - — - - -
                                          -
                                          -

                                          - getDataContainers() - -

                                          - - -

                                          Returns (nearly) all registered datacontainers as array.

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

                                          Options:

                                          -
                                            -
                                          • bool onlyTableType: Return only table data containers
                                            • -
                                          -
                                          - -
                                          Parameters
                                          -
                                          -
                                          - $options - : array<string|int, mixed> - = []
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - array<string|int, mixed> - — - - -
                                          -
                                          -

                                          - getDCTable() - -

                                          - - -

                                          Mostly used for Form::prepareSpecialValueForOutput().

                                          - - - public - getDCTable(string $table,  $activeRecord) : DC_Table_Utils - - -
                                          Parameters
                                          -
                                          -
                                          - $table - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - $activeRecord - : -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - DC_Table_Utils - — - - -
                                          -
                                          -

                                          - getEditLink() - -

                                          - - -

                                          Get a contao backend modal edit link.

                                          - - - public - getEditLink(string $module, int $id[, string|null $label = null ]) : string - - -
                                          Parameters
                                          -
                                          -
                                          - $module - : string -
                                          -
                                          -

                                          Name of the module

                                          -
                                          - -
                                          -
                                          - $id - : int -
                                          -
                                          -

                                          Id of the entity

                                          -
                                          - -
                                          -
                                          - $label - : string|null - = null
                                          -
                                          -

                                          The label text

                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - string - — -

                                          The edit link

                                          -
                                          - - -
                                          -
                                          -

                                          - getFieldLabel() - -

                                          - - - - - public - getFieldLabel(string $table, string $field) : mixed - -
                                          - -
                                          Parameters
                                          -
                                          -
                                          - $table - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - $field - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - getFields() - -

                                          - - -

                                          Returns a list of fields as an option array for dca fields.

                                          - - - public - getFields(string $table[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed> - -

                                          Possible options:

                                          -
                                            -
                                          • array inputTypes Restrict to certain input types
                                            • -
                                          • array evalConditions restrict to certain dca eval
                                            • -
                                          • bool localizeLabels
                                            • -
                                          • bool skipSorting
                                            • -
                                          -
                                          - -
                                          Parameters
                                          -
                                          -
                                          - $table - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - $options - : array<string|int, mixed> - = []
                                          -
                                          -
                                          - -
                                          -
                                          - - -
                                          - Tags - -
                                          -
                                          -
                                          - deprecated -
                                          -
                                          - -

                                          Use Utils service instead

                                          -
                                          - -
                                          -
                                          - codeCoverageIgnore -
                                          -
                                          - - -
                                          -
                                          - -
                                          Return values
                                          - array<string|int, mixed> - — - - -
                                          -
                                          -

                                          - getLocalizedFieldName() - -

                                          - - - - - public - getLocalizedFieldName( $strField,  $strTable) : mixed - - -
                                          Parameters
                                          -
                                          -
                                          - $strField - : -
                                          -
                                          - -
                                          -
                                          - $strTable - : -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - getModalEditLink() - -

                                          - - -

                                          Get a contao backend modal edit link.

                                          - - - public - getModalEditLink(string $module, int $id[, string|null $label = null ][, string $table = '' ][, int $width = 1024 ]) : string - - -
                                          Parameters
                                          -
                                          -
                                          - $module - : string -
                                          -
                                          -

                                          Name of the module

                                          -
                                          - -
                                          -
                                          - $id - : int -
                                          -
                                          -

                                          Id of the entity

                                          -
                                          - -
                                          -
                                          - $label - : string|null - = null
                                          -
                                          -

                                          The label text

                                          -
                                          - -
                                          -
                                          - $table - : string - = ''
                                          -
                                          -

                                          The dataContainer table

                                          -
                                          - -
                                          -
                                          - $width - : int - = 1024
                                          -
                                          -

                                          The modal window width

                                          -
                                          - -
                                          -
                                          - - -
                                          - Tags - -
                                          -
                                          -
                                          - deprecated -
                                          -
                                          - -

                                          Use DcaUtil::getPopupWizardLink() instead

                                          -
                                          - -
                                          -
                                          - -
                                          Return values
                                          - string - — -

                                          The modal edit link

                                          -
                                          - - -
                                          -
                                          -

                                          - getNewNotificationTypeArray() - -

                                          - - - - - public - getNewNotificationTypeArray([bool $includeNotificationCenterPlusTokens = false ]) : array<string|int, mixed> - - -
                                          Parameters
                                          -
                                          -
                                          - $includeNotificationCenterPlusTokens - : bool - = false
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - array<string|int, mixed> - — - - -
                                          -
                                          -

                                          - getNewSortingPosition() - -

                                          - - -

                                          Returns the set of pid and sorting to be used in an sql update statement. Also updates the existing records according to the usage.

                                          - - - public - getNewSortingPosition(string $table, int $id[, mixed $pid = null ][, mixed $insertAfterId = null ]) : array<string|int, mixed> - -

                                          The method can be used in several ways:

                                          -
                                            -
                                          • Insert in an archive of a certain pid as first item: $pid must be set (0 is also ok), $insertAfterId needs to be null
                                            • -
                                          • Insert after a record of a certain id: $insertAfterId must be set, $pid can be set if necessary
                                            • -
                                          -
                                          - -
                                          Parameters
                                          -
                                          -
                                          - $table - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - $id - : int -
                                          -
                                          -
                                          - -
                                          -
                                          - $pid - : mixed - = null
                                          -
                                          -
                                          - -
                                          -
                                          - $insertAfterId - : mixed - = null
                                          -
                                          -
                                          - -
                                          -
                                          - - -
                                          - Tags - -
                                          -
                                          -
                                          - example -
                                          -
                                          - -

                                          // insert a new record after another one with the ID 82

                                          -

                                          $news = new \Contao\NewsModel(); -$news->pid = 3; -$news->tstamp = time(); -$news->title = 'Something'; -$news->save(); -$set = System::getContainer()->get('huh.utils.dca')->getNewSortingPosition( -'tl_news', $news->id, 3, 82 -);

                                          -

                                          // store the returned set to the news record created above as usual

                                          -

                                          Hint: Mostly taken from DC_Table::getNewPosition(). Removed: handling if only a pid field is present, mode handling (since we don't have it in this context).

                                          -
                                          - -
                                          -
                                          - -
                                          Return values
                                          - array<string|int, mixed> - — - - -
                                          -
                                          -

                                          - getOverridableProperty() - -

                                          - - -

                                          Retrieves a property of given contao model instances by *ascending* priority, i.e. the last instance of $instances -will have the highest priority.

                                          - - - public - getOverridableProperty(string $property, array<string|int, mixed> $instances) : mixed - -

                                          CAUTION: This function assumes that you have used addOverridableFields() in this class!! That means, that a value in a -model instance is only used if it's either the first instance in $arrInstances or "overrideFieldname" is set to true -in the instance.

                                          -
                                          - -
                                          Parameters
                                          -
                                          -
                                          - $property - : string -
                                          -
                                          -

                                          The property name to retrieve

                                          -
                                          - -
                                          -
                                          - $instances - : array<string|int, mixed> -
                                          -
                                          -

                                          An array of instances in ascending priority. Instances can be passed in the following form: -['tl_some_table', $instanceId] or $objInstance

                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - getPopupWizardLink() - -

                                          - - -

                                          Get a contao backend popup link.

                                          - - - public - getPopupWizardLink(array<string|int, mixed> $parameter[, array<string|int, mixed> $options = [] ]) : string - -

                                          Options:

                                          -
                                            -
                                          • attributes: (array) Link attributes as key value pairs. Will override title and style option. href and onclick are not allowed and will be removed from list.
                                            • -
                                          • title: (string) Overrride default link title
                                            • -
                                          • style: (string) Override default css style properties
                                            • -
                                          • onclick: (string) Override default onclick javascript code
                                            • -
                                          • icon: (string) Link icon to show as link text. Overrides default icon.
                                            • -
                                          • linkText: (string) A linkTitle to show as link text. Will be displayed after the link icon. Default empty.
                                            • -
                                          • url-only: (boolean) Return only url instead of a complete link element
                                            • -
                                          -
                                          - -
                                          Parameters
                                          -
                                          -
                                          - $parameter - : array<string|int, mixed> -
                                          -
                                          -

                                          An array of parameter. Using string is deprecated and will be removed in a future version.

                                          -
                                          - -
                                          -
                                          - $options - : array<string|int, mixed> - = []
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - string - — - - -
                                          -
                                          -

                                          - getRenderedDiff() - -

                                          - - - - - public - getRenderedDiff(string $table, array<string|int, mixed> $source, array<string|int, mixed> $target[, array<string|int, mixed> $config = [] ]) : mixed - -
                                          - -
                                          Parameters
                                          -
                                          -
                                          - $table - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - $source - : array<string|int, mixed> -
                                          -
                                          -
                                          - -
                                          -
                                          - $target - : array<string|int, mixed> -
                                          -
                                          -
                                          - -
                                          -
                                          - $config - : array<string|int, mixed> - = []
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - getSubPaletteFieldSelector() - -

                                          - - -

                                          Returns the selector of the sub palette a field is placed in. Currently doesn't support fields in multiple sub palettes.

                                          - - - public - getSubPaletteFieldSelector(string $field, string $table) : string - - -
                                          Parameters
                                          -
                                          -
                                          - $field - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - $table - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - string - — - - -
                                          -
                                          -

                                          - getTranslatedModuleNameByTable() - -

                                          - - - - - public - getTranslatedModuleNameByTable(string $table) : mixed - -
                                          - -
                                          Parameters
                                          -
                                          -
                                          - $table - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - isDcMultilingual() - -

                                          - - - - - public - isDcMultilingual(string $table) : mixed - -
                                          - -
                                          Parameters
                                          -
                                          -
                                          - $table - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - isDcMultilingual3() - -

                                          - - - - - public - isDcMultilingual3() : mixed - -
                                          - - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - isSubPaletteField() - -

                                          - - -

                                          Returns true if the field is in at least one sub palette.

                                          - - - public - isSubPaletteField(string $field, string $table) : bool - - -
                                          Parameters
                                          -
                                          -
                                          - $field - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - $table - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - bool - — - - -
                                          -
                                          -

                                          - loadDc() - -

                                          - - -

                                          Load a data container in a testable way.

                                          - - - public - loadDc(string $table) : mixed - - -
                                          Parameters
                                          -
                                          -
                                          - $table - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - loadLanguageFile() - -

                                          - - -

                                          Load a language file in a testable way.

                                          - - - public - loadLanguageFile(string $table) : mixed - - -
                                          Parameters
                                          -
                                          -
                                          - $table - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - modifyAuthorPaletteOnLoad() - -

                                          - - - - - public - modifyAuthorPaletteOnLoad(DataContainer $dc) : mixed - -
                                          - -
                                          Parameters
                                          -
                                          -
                                          - $dc - : DataContainer -
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - prepareRowEntryForList() - -

                                          - - - - - public - prepareRowEntryForList(mixed $table, string $field, mixed $value) : mixed - -
                                          - -
                                          Parameters
                                          -
                                          -
                                          - $table - : mixed -
                                          -
                                          -
                                          - -
                                          -
                                          - $field - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - $value - : mixed -
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - setAuthorIDOnCreate() - -

                                          - - - - - public - setAuthorIDOnCreate(string $table, int $id, array<string|int, mixed> $row, DataContainer $dc) : mixed - -
                                          - -
                                          Parameters
                                          -
                                          -
                                          - $table - : string -
                                          -
                                          -
                                          - -
                                          -
                                          - $id - : int -
                                          -
                                          -
                                          - -
                                          -
                                          - $row - : array<string|int, mixed> -
                                          -
                                          -
                                          - -
                                          -
                                          - $dc - : DataContainer -
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - setDateAdded() - -

                                          - - -

                                          Sets the current date as the date added -> usually used on submit.

                                          - - - public - setDateAdded(DataContainer $dc) : mixed - - -
                                          Parameters
                                          -
                                          -
                                          - $dc - : DataContainer -
                                          -
                                          -
                                          - -
                                          -
                                          - - -
                                          - Tags - -
                                          -
                                          -
                                          - deprecated -
                                          -
                                          - -

                                          Use DateAddedField instead

                                          -
                                          - -
                                          -
                                          - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - setDateAddedOnCopy() - -

                                          - - -

                                          Sets the current date as the date added -> usually used on copy.

                                          - - - public - setDateAddedOnCopy( $insertId, DataContainer $dc) : mixed - - -
                                          Parameters
                                          -
                                          -
                                          - $insertId - : -
                                          -
                                          - -
                                          -
                                          - $dc - : DataContainer -
                                          -
                                          -
                                          - -
                                          -
                                          - - -
                                          - Tags - -
                                          -
                                          -
                                          - deprecated -
                                          -
                                          - -

                                          Use DateAddedField instead

                                          -
                                          - -
                                          -
                                          - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - setDefaultsFromDca() - -

                                          - - -

                                          Set initial $varData from dca.

                                          - - - public - setDefaultsFromDca(string $strTable[, mixed $varData = null ][, bool $includeSql = false ]) : mixed - - -
                                          Parameters
                                          -
                                          -
                                          - $strTable - : string -
                                          -
                                          -

                                          Dca table name

                                          -
                                          - -
                                          -
                                          - $varData - : mixed - = null
                                          -
                                          -

                                          Object or array

                                          -
                                          - -
                                          -
                                          - $includeSql - : bool - = false
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — -

                                          Object or array with the default values

                                          -
                                          - - -
                                          -
                                          -

                                          - setFieldsToReadOnly() - -

                                          - - - - - public - setFieldsToReadOnly(mixed &$dca[, array<string|int, mixed> $config = [] ]) : mixed - -
                                          - -
                                          Parameters
                                          -
                                          -
                                          - $dca - : mixed -
                                          -
                                          -
                                          - -
                                          -
                                          - $config - : array<string|int, mixed> - = []
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          -

                                          - combiner() - -

                                          - - -

                                          Taken from \Contao\DataContainer.

                                          - - - private - combiner(mixed $names) : mixed - - -
                                          Parameters
                                          -
                                          -
                                          - $names - : mixed -
                                          -
                                          -
                                          - -
                                          -
                                          - - - -
                                          Return values
                                          - mixed - — - - -
                                          -
                                          - - - - -
                                          -
                                          -
                                          -
                                          -

                                          Search results

                                          - -
                                          -
                                          -
                                            -
                                            -
                                            -
                                            -
                                            -
                                            - - -
                                            - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-DependencyInjection-HeimrichHannotUtilsExtension.html b/classes/HeimrichHannot-UtilsBundle-DependencyInjection-HeimrichHannotUtilsExtension.html deleted file mode 100644 index 53ccdd11..00000000 --- a/classes/HeimrichHannot-UtilsBundle-DependencyInjection-HeimrichHannotUtilsExtension.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                            -

                                            Contao Utils Bundle

                                            - - -
                                            - -
                                            - - -
                                            - -
                                            -
                                            - - - - -
                                            - - -
                                            -

                                            - HeimrichHannotUtilsExtension - - - extends Extension - - -
                                            - in package - -
                                            - - -

                                            - - - - -
                                            - - - - - - - - -

                                            - Table of Contents - -

                                            - -
                                            -
                                            - getAlias() - -  : mixed -
                                            -
                                            - -
                                            - load() - -  : mixed -
                                            -
                                            - -
                                            - - - - - - - -
                                            -

                                            - Methods - -

                                            - -
                                            -

                                            - load() - -

                                            - - - - - public - load(array<string|int, mixed> $configs, ContainerBuilder $container) : mixed - -
                                            - -
                                            Parameters
                                            -
                                            -
                                            - $configs - : array<string|int, mixed> -
                                            -
                                            -
                                            - -
                                            -
                                            - $container - : ContainerBuilder -
                                            -
                                            -
                                            - -
                                            -
                                            - - - -
                                            Return values
                                            - mixed - — - - -
                                            -
                                            - - - - -
                                            -
                                            -
                                            -
                                            -

                                            Search results

                                            - -
                                            -
                                            -
                                              -
                                              -
                                              -
                                              -
                                              -
                                              - - -
                                              - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-DependencyInjection-UtilsBundleExtension.html b/classes/HeimrichHannot-UtilsBundle-DependencyInjection-UtilsBundleExtension.html deleted file mode 100644 index 0ac2fc61..00000000 --- a/classes/HeimrichHannot-UtilsBundle-DependencyInjection-UtilsBundleExtension.html +++ /dev/null @@ -1,376 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                              -

                                              Contao Utils Bundle

                                              - - -
                                              - -
                                              - - -
                                              - -
                                              -
                                              - - - - -
                                              - - -
                                              -

                                              - UtilsBundleExtension - - - extends Extension - - -
                                              - in package - -
                                              - - - implements - PrependExtensionInterface - -

                                              - - - - -
                                              - - - - - - -

                                              - Interfaces, Classes and Traits - -

                                              - -
                                              -
                                              PrependExtensionInterface
                                              -
                                              - - -
                                              - - -

                                              - Table of Contents - -

                                              - -
                                              -
                                              - load() - -  : mixed -
                                              -
                                              Loads a specific configuration.
                                              - -
                                              - prepend() - -  : mixed -
                                              -
                                              - -
                                              - - - - - - - -
                                              -

                                              - Methods - -

                                              -
                                              -

                                              - load() - -

                                              - - -

                                              Loads a specific configuration.

                                              - - - public - load(array<string|int, mixed> $configs, ContainerBuilder $container) : mixed - - -
                                              Parameters
                                              -
                                              -
                                              - $configs - : array<string|int, mixed> -
                                              -
                                              -
                                              - -
                                              -
                                              - $container - : ContainerBuilder -
                                              -
                                              -
                                              - -
                                              -
                                              - - -
                                              - Tags - -
                                              -
                                              -
                                              - throws -
                                              -
                                              - InvalidArgumentException - -

                                              When provided tag is not defined in this extension

                                              -
                                              - -
                                              -
                                              - -
                                              Return values
                                              - mixed - — - - -
                                              -
                                              -

                                              - prepend() - -

                                              - - - - - public - prepend(ContainerBuilder $container) : mixed - -
                                              - -
                                              Parameters
                                              -
                                              -
                                              - $container - : ContainerBuilder -
                                              -
                                              -
                                              - -
                                              -
                                              - - - -
                                              Return values
                                              - mixed - — - - -
                                              -
                                              - - - - -
                                              -
                                              -
                                              -
                                              -

                                              Search results

                                              - -
                                              -
                                              -
                                                -
                                                -
                                                -
                                                -
                                                -
                                                - - -
                                                - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Dom-DOMLettersIterator.html b/classes/HeimrichHannot-UtilsBundle-Dom-DOMLettersIterator.html deleted file mode 100644 index 861301b3..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Dom-DOMLettersIterator.html +++ /dev/null @@ -1,964 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                -

                                                Contao Utils Bundle

                                                - - -
                                                - -
                                                - - -
                                                - -
                                                -
                                                - - - - -
                                                - - -
                                                -

                                                - DOMLettersIterator - - -
                                                - in package - -
                                                - - - implements - Iterator - -

                                                - - - -

                                                Iterates individual characters (Unicode codepoints) of DOM text and CDATA nodes -while keeping track of their position in the document.

                                                - -

                                                Example:

                                                -

                                                $doc = new DOMDocument(); -$doc->load('example.xml'); -foreach(new DOMLettersIterator($doc) as $letter) echo $letter;

                                                -

                                                NB: If you only need characters without their position -in the document, use DOMNode->textContent instead.

                                                -
                                                - - -
                                                - Tags - -
                                                -
                                                -
                                                - author -
                                                -
                                                - -

                                                porneL http://pornel.net

                                                -
                                                - -
                                                -
                                                - license -
                                                -
                                                - -

                                                Public Domain

                                                -
                                                - -
                                                -
                                                - - - - -

                                                - Interfaces, Classes and Traits - -

                                                - -
                                                -
                                                Iterator
                                                -
                                                - - -
                                                - - -

                                                - Table of Contents - -

                                                - -
                                                -
                                                - $current - -  : mixed -
                                                -
                                                - -
                                                - $key - -  : mixed -
                                                -
                                                - -
                                                - $letters - -  : mixed -
                                                -
                                                - -
                                                - $offset - -  : mixed -
                                                -
                                                - -
                                                - $queue - -  : SplQueue -
                                                -
                                                - -
                                                - $start - -  : mixed -
                                                -
                                                - -
                                                - __construct() - -  : mixed -
                                                -
                                                expects DOMElement or DOMDocument (see DOMDocument::load and DOMDocument::loadHTML).
                                                - -
                                                - current() - -  : mixed -
                                                -
                                                - -
                                                - currentElement() - -  : DOMElement -
                                                -
                                                Returns DOMElement that is currently being iterated or NULL if iterator has finished.
                                                - -
                                                - currentTextPosition() - -  : array<string|int, DOMElement>|array<string|int, int> -
                                                -
                                                Returns position in text as DOMText node and character offset.
                                                - -
                                                - key() - -  : mixed -
                                                -
                                                - -
                                                - next() - -  : void -
                                                -
                                                - -
                                                - rewind() - -  : mixed -
                                                -
                                                - -
                                                - valid() - -  : mixed -
                                                -
                                                - -
                                                - addToQueue() - -  : void -
                                                -
                                                - -
                                                - isTextNode() - -  : bool -
                                                -
                                                - -
                                                - - - - - - -
                                                -

                                                - Properties - -

                                                -
                                                -

                                                - $current - - - -

                                                - - - - - private - mixed - $current - - -
                                                - -
                                                - - - -
                                                - -
                                                -

                                                - $letters - - - -

                                                - - - - - private - mixed - $letters - - -
                                                - -
                                                - - - -
                                                -
                                                -

                                                - $offset - - - -

                                                - - - - - private - mixed - $offset - - -
                                                - -
                                                - - - -
                                                - -
                                                -

                                                - $start - - - -

                                                - - - - - private - mixed - $start - - -
                                                - -
                                                - - - -
                                                -
                                                - -
                                                -

                                                - Methods - -

                                                -
                                                -

                                                - __construct() - -

                                                - - -

                                                expects DOMElement or DOMDocument (see DOMDocument::load and DOMDocument::loadHTML).

                                                - - - public - __construct(DOMDocument|DOMElement $el) : mixed - - -
                                                Parameters
                                                -
                                                -
                                                - $el - : DOMDocument|DOMElement -
                                                -
                                                - -
                                                -
                                                - - - -
                                                Return values
                                                - mixed - — - - -
                                                -
                                                -

                                                - current() - -

                                                - - - - - public - current() : mixed - -
                                                - - - - -
                                                Return values
                                                - mixed - — - - -
                                                -
                                                -

                                                - currentElement() - -

                                                - - -

                                                Returns DOMElement that is currently being iterated or NULL if iterator has finished.

                                                - - - public - currentElement() : DOMElement - - - - - -
                                                Return values
                                                - DOMElement - — - - -
                                                -
                                                -

                                                - currentTextPosition() - -

                                                - - -

                                                Returns position in text as DOMText node and character offset.

                                                - - - public - currentTextPosition() : array<string|int, DOMElement>|array<string|int, int> - -

                                                (it's NOT a byte offset, you must use mb_substr() or similar to use this offset properly). -node may be NULL if iterator has finished.

                                                -
                                                - - - - -
                                                Return values
                                                - array<string|int, DOMElement>|array<string|int, int> - — - - -
                                                -
                                                -

                                                - key() - -

                                                - - - - - public - key() : mixed - -
                                                - - - - -
                                                Return values
                                                - mixed - — - - -
                                                -
                                                -

                                                - next() - -

                                                - - - - - public - next() : void - -
                                                - - - - -
                                                Return values
                                                - void - — - - -
                                                -
                                                -

                                                - rewind() - -

                                                - - - - - public - rewind() : mixed - -
                                                - - - - -
                                                Return values
                                                - mixed - — - - -
                                                -
                                                -

                                                - valid() - -

                                                - - - - - public - valid() : mixed - -
                                                - - - - -
                                                Return values
                                                - mixed - — - - -
                                                -
                                                -

                                                - addToQueue() - -

                                                - - - - - private - addToQueue(DOMNode $node) : void - -
                                                - -
                                                Parameters
                                                -
                                                -
                                                - $node - : DOMNode -
                                                -
                                                -
                                                - -
                                                -
                                                - - - -
                                                Return values
                                                - void - — - - -
                                                -
                                                -

                                                - isTextNode() - -

                                                - - - - - private - isTextNode(DOMNode $element) : bool - -
                                                - -
                                                Parameters
                                                -
                                                -
                                                - $element - : DOMNode -
                                                -
                                                -
                                                - -
                                                -
                                                - - - -
                                                Return values
                                                - bool - — - - -
                                                -
                                                - - - - -
                                                -
                                                -
                                                -
                                                -

                                                Search results

                                                - -
                                                -
                                                -
                                                  -
                                                  -
                                                  -
                                                  -
                                                  -
                                                  - - -
                                                  - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Driver-DC-Table-Utils.html b/classes/HeimrichHannot-UtilsBundle-Driver-DC-Table-Utils.html deleted file mode 100644 index bba74d5e..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Driver-DC-Table-Utils.html +++ /dev/null @@ -1,410 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                  -

                                                  Contao Utils Bundle

                                                  - - -
                                                  - -
                                                  - - -
                                                  - -
                                                  -
                                                  - - - - -
                                                  - - -
                                                  -

                                                  - DC_Table_Utils - - - extends DC_Table - - -
                                                  - in package - -
                                                  - - -

                                                  - - - - -
                                                  - - - - - - - - -

                                                  - Table of Contents - -

                                                  - -
                                                  -
                                                  - __construct() - -  : mixed -
                                                  -
                                                  Initialize the object.
                                                  - -
                                                  - createFromModel() - -  : static -
                                                  -
                                                  Create a DataContainer instance from a given Model.
                                                  - -
                                                  - createFromModelData() - -  : static -
                                                  -
                                                  Create a DataContainer instance from given model data.
                                                  - -
                                                  - - - - - - - -
                                                  -

                                                  - Methods - -

                                                  -
                                                  -

                                                  - __construct() - -

                                                  - - -

                                                  Initialize the object.

                                                  - - - public - __construct(string $strTable[, array<string|int, mixed> $arrModule = [] ]) : mixed - - -
                                                  Parameters
                                                  -
                                                  -
                                                  - $strTable - : string -
                                                  -
                                                  - -
                                                  -
                                                  - $arrModule - : array<string|int, mixed> - = []
                                                  -
                                                  - -
                                                  -
                                                  - - - -
                                                  Return values
                                                  - mixed - — - - -
                                                  -
                                                  -

                                                  - createFromModel() - -

                                                  - - -

                                                  Create a DataContainer instance from a given Model.

                                                  - - - public - static createFromModel(Model $model) : static - - -
                                                  Parameters
                                                  -
                                                  -
                                                  - $model - : Model -
                                                  -
                                                  -
                                                  - -
                                                  -
                                                  - - - -
                                                  Return values
                                                  - static - — - - -
                                                  -
                                                  -

                                                  - createFromModelData() - -

                                                  - - -

                                                  Create a DataContainer instance from given model data.

                                                  - - - public - static createFromModelData(array<string|int, mixed> $modelData, string $table[, string $field = null ]) : static - - -
                                                  Parameters
                                                  -
                                                  -
                                                  - $modelData - : array<string|int, mixed> -
                                                  -
                                                  -
                                                  - -
                                                  -
                                                  - $table - : string -
                                                  -
                                                  -
                                                  - -
                                                  -
                                                  - $field - : string - = null
                                                  -
                                                  - -
                                                  -
                                                  - - - -
                                                  Return values
                                                  - static - — - - -
                                                  -
                                                  - - - - -
                                                  -
                                                  -
                                                  -
                                                  -

                                                  Search results

                                                  - -
                                                  -
                                                  -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    -
                                                    - - -
                                                    - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-EntityFinder-EntityFinderHelper.html b/classes/HeimrichHannot-UtilsBundle-EntityFinder-EntityFinderHelper.html index 79fef8f2..fc808060 100644 --- a/classes/HeimrichHannot-UtilsBundle-EntityFinder-EntityFinderHelper.html +++ b/classes/HeimrichHannot-UtilsBundle-EntityFinder-EntityFinderHelper.html @@ -107,7 +107,7 @@

                                                    @@ -128,6 +128,13 @@

                                                    + $framework + +  : ContaoFramework +
                                                    +
                                                    + +
                                                    $utils  : Utils @@ -180,6 +187,40 @@

                                                    -property -private " +> +

                                                    + $framework + + + +

                                                    + + + + + private + ContaoFramework + $framework + + +
                                                    + +
                                                    + + + + + @@ -226,14 +269,14 @@

                                                    public - __construct(Utils $utils) : mixed + __construct(Utils $utils, ContaoFramework $framework) : mixed
                                                    @@ -246,6 +289,14 @@

                                                    Parameters
                                                    +
                                                    +
                                                    + $framework + : ContaoFramework +
                                                    +
                                                    +
                                                    +
                                                    @@ -270,7 +321,7 @@

                                                    EntityFinderHelper.php : - 91 + 88 @@ -358,7 +409,7 @@

                                                    @@ -446,7 +497,7 @@

                                                    EntityFinderHelper.php : - 42 + 36 diff --git a/classes/HeimrichHannot-UtilsBundle-Event-AbstractEvent.html b/classes/HeimrichHannot-UtilsBundle-Event-AbstractEvent.html deleted file mode 100644 index a41f81cf..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Event-AbstractEvent.html +++ /dev/null @@ -1,223 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                    -

                                                    Contao Utils Bundle

                                                    - - -
                                                    - -
                                                    - - -
                                                    - -
                                                    -
                                                    - - - - -
                                                    - - -
                                                    -

                                                    - AbstractEvent - - - extends Event - - -
                                                    - in package - -
                                                    - - -

                                                    - - - - -
                                                    - - - - - - - - - - - - - - - - - - - -
                                                    -
                                                    -
                                                    -
                                                    -

                                                    Search results

                                                    - -
                                                    -
                                                    -
                                                      -
                                                      -
                                                      -
                                                      -
                                                      -
                                                      - - -
                                                      - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Event-ExtendEntityFinderEvent.html b/classes/HeimrichHannot-UtilsBundle-Event-ExtendEntityFinderEvent.html index 41562fcb..ec7fa78e 100644 --- a/classes/HeimrichHannot-UtilsBundle-Event-ExtendEntityFinderEvent.html +++ b/classes/HeimrichHannot-UtilsBundle-Event-ExtendEntityFinderEvent.html @@ -94,7 +94,7 @@

                                                      ExtendEntityFinderEvent - extends AbstractEvent + extends Event
                                                      @@ -110,7 +110,7 @@

                                                      @@ -298,7 +298,7 @@

                                                      @@ -309,8 +309,10 @@

                                                      $entityFinderHelper - - +
                                                      + +
                                                      + @@ -330,7 +332,7 @@

                                                      @@ -341,8 +343,10 @@

                                                      $id - - +
                                                      + +
                                                      + @@ -362,7 +366,7 @@

                                                      @@ -373,8 +377,10 @@

                                                      $inserttags - - +
                                                      + +
                                                      + @@ -394,7 +400,7 @@

                                                      @@ -403,10 +409,12 @@

                                                      private bool $onlyText - + = false + +
                                                      + +
                                                      - - @@ -426,7 +434,7 @@

                                                      @@ -437,8 +445,10 @@

                                                      $output = null - - +
                                                      + +
                                                      + @@ -458,7 +468,7 @@

                                                      @@ -469,8 +479,10 @@

                                                      $parents - - +
                                                      + +
                                                      + @@ -490,7 +502,7 @@

                                                      @@ -501,8 +513,10 @@

                                                      $table - - +
                                                      + +
                                                      + @@ -526,14 +540,14 @@

                                                      public - __construct(string $table, mixed $id, array<string|int, mixed> $parents, array<string|int, mixed> $inserttags, EntityFinderHelper $entityFinderHelper[, bool $onlyText = false ]) : mixed + __construct(string $table, int|string $id, array<string|int, mixed> $parents, array<string|int, mixed> $inserttags, EntityFinderHelper $entityFinderHelper[, bool $onlyText = false ]) : mixed
                                                      @@ -549,7 +563,7 @@

                                                      Parameters
                                                      $id - : mixed + : int|string
                                                      @@ -610,7 +624,7 @@

                                                      @@ -654,7 +668,7 @@

                                                      @@ -706,7 +720,7 @@

                                                      @@ -739,7 +753,7 @@

                                                      @@ -771,7 +785,7 @@

                                                      @@ -804,7 +818,7 @@

                                                      @@ -837,7 +851,7 @@

                                                      @@ -870,7 +884,7 @@

                                                      @@ -903,7 +917,7 @@

                                                      @@ -936,7 +950,7 @@

                                                      @@ -980,7 +994,7 @@

                                                      @@ -1024,7 +1038,7 @@

                                                      diff --git a/classes/HeimrichHannot-UtilsBundle-Event-RenderTwigTemplateEvent.html b/classes/HeimrichHannot-UtilsBundle-Event-RenderTwigTemplateEvent.html deleted file mode 100644 index a3a567dc..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Event-RenderTwigTemplateEvent.html +++ /dev/null @@ -1,605 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                      -

                                                      Contao Utils Bundle

                                                      - - -
                                                      - -
                                                      - - -
                                                      - -
                                                      -
                                                      - - - - -
                                                      - - -
                                                      -

                                                      - RenderTwigTemplateEvent - - - extends AbstractEvent - - -
                                                      - in package - -
                                                      - - -

                                                      - - - - -
                                                      - - - - - - - - -

                                                      - Table of Contents - -

                                                      - -
                                                      -
                                                      - NAME - -  = 'huh.utils.template.render' -
                                                      -
                                                      - -
                                                      - $context - -  : array<string|int, mixed> -
                                                      -
                                                      The context template data.
                                                      - -
                                                      - $template - -  : string -
                                                      -
                                                      The name of the twig template.
                                                      - -
                                                      - __construct() - -  : mixed -
                                                      -
                                                      - -
                                                      - getContext() - -  : array<string|int, mixed> -
                                                      -
                                                      - -
                                                      - getTemplate() - -  : string -
                                                      -
                                                      - -
                                                      - setContext() - -  : mixed -
                                                      -
                                                      - -
                                                      - setTemplate() - -  : mixed -
                                                      -
                                                      - -
                                                      - - - - -
                                                      -

                                                      - Constants - -

                                                      -
                                                      -

                                                      - NAME - -

                                                      - - - - - - public - mixed - NAME - = 'huh.utils.template.render' - - - -
                                                      - -
                                                      - - - -
                                                      -
                                                      - - -
                                                      -

                                                      - Properties - -

                                                      -
                                                      -

                                                      - $context - - - -

                                                      - - -

                                                      The context template data.

                                                      - - - protected - array<string|int, mixed> - $context - = [] - - - - - -
                                                      -
                                                      -

                                                      - $template - - - -

                                                      - - -

                                                      The name of the twig template.

                                                      - - - protected - string - $template - - - - - - -
                                                      -
                                                      - -
                                                      -

                                                      - Methods - -

                                                      -
                                                      -

                                                      - __construct() - -

                                                      - - - - - public - __construct(string $template[, array<string|int, mixed> $context = [] ]) : mixed - -
                                                      - -
                                                      Parameters
                                                      -
                                                      -
                                                      - $template - : string -
                                                      -
                                                      -
                                                      - -
                                                      -
                                                      - $context - : array<string|int, mixed> - = []
                                                      -
                                                      -
                                                      - -
                                                      -
                                                      - - - -
                                                      Return values
                                                      - mixed - — - - -
                                                      -
                                                      -

                                                      - getContext() - -

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

                                                      - getTemplate() - -

                                                      - - - - - public - getTemplate() : string - -
                                                      - - - - -
                                                      Return values
                                                      - string - — - - -
                                                      -
                                                      -

                                                      - setContext() - -

                                                      - - - - - public - setContext(array<string|int, mixed> $context) : mixed - -
                                                      - -
                                                      Parameters
                                                      -
                                                      -
                                                      - $context - : array<string|int, mixed> -
                                                      -
                                                      -
                                                      - -
                                                      -
                                                      - - - -
                                                      Return values
                                                      - mixed - — - - -
                                                      -
                                                      -

                                                      - setTemplate() - -

                                                      - - - - - public - setTemplate(string $template) : mixed - -
                                                      - -
                                                      Parameters
                                                      -
                                                      -
                                                      - $template - : string -
                                                      -
                                                      -
                                                      - -
                                                      -
                                                      - - - -
                                                      Return values
                                                      - mixed - — - - -
                                                      -
                                                      - - - - -
                                                      -
                                                      -
                                                      -
                                                      -

                                                      Search results

                                                      - -
                                                      -
                                                      -
                                                        -
                                                        -
                                                        -
                                                        -
                                                        -
                                                        - - -
                                                        - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-EventListener-DcaField-AbstractDcaFieldListener.html b/classes/HeimrichHannot-UtilsBundle-EventListener-DcaField-AbstractDcaFieldListener.html index 7d6c5633..70206a79 100644 --- a/classes/HeimrichHannot-UtilsBundle-EventListener-DcaField-AbstractDcaFieldListener.html +++ b/classes/HeimrichHannot-UtilsBundle-EventListener-DcaField-AbstractDcaFieldListener.html @@ -198,7 +198,7 @@

                                                        @@ -209,8 +209,10 @@

                                                        $container - - +
                                                        + +
                                                        + @@ -234,7 +236,7 @@

                                                        @@ -278,7 +280,7 @@

                                                        @@ -311,7 +313,7 @@

                                                        diff --git a/classes/HeimrichHannot-UtilsBundle-EventListener-DcaField-DateAddedFieldListener.html b/classes/HeimrichHannot-UtilsBundle-EventListener-DcaField-DateAddedFieldListener.html index edb6f9d4..e2c2ddd0 100644 --- a/classes/HeimrichHannot-UtilsBundle-EventListener-DcaField-DateAddedFieldListener.html +++ b/classes/HeimrichHannot-UtilsBundle-EventListener-DcaField-DateAddedFieldListener.html @@ -208,7 +208,7 @@

                                                        @@ -219,8 +219,10 @@

                                                        $container - - +
                                                        + +
                                                        + @@ -244,7 +246,7 @@

                                                        @@ -288,7 +290,7 @@

                                                        @@ -321,7 +323,7 @@

                                                        @@ -373,7 +375,7 @@

                                                        @@ -417,7 +419,7 @@

                                                        @@ -426,7 +428,8 @@

                                                        public onLoadDataContainer(string $table) : void - +
                                                        +

                                                        Parameters
                                                        @@ -440,21 +443,6 @@
                                                        Parameters
                                                        -
                                                        - Tags - -
                                                        -
                                                        -
                                                        - Hook -
                                                        -
                                                        - -

                                                        ("loadDataContainer")

                                                        -
                                                        - -
                                                        -
                                                        Return values
                                                        void @@ -475,7 +463,7 @@

                                                        diff --git a/classes/HeimrichHannot-UtilsBundle-EventListener-DcaField-DcaAuthorListener.html b/classes/HeimrichHannot-UtilsBundle-EventListener-DcaField-DcaAuthorListener.html index 162a22fa..fb86ce10 100644 --- a/classes/HeimrichHannot-UtilsBundle-EventListener-DcaField-DcaAuthorListener.html +++ b/classes/HeimrichHannot-UtilsBundle-EventListener-DcaField-DcaAuthorListener.html @@ -198,7 +198,7 @@

                                                        @@ -209,8 +209,10 @@

                                                        $framework - - +
                                                        + +
                                                        + @@ -230,7 +232,7 @@

                                                        @@ -241,8 +243,10 @@

                                                        $security - - +
                                                        + +
                                                        + @@ -266,7 +270,7 @@

                                                        @@ -318,7 +322,7 @@

                                                        @@ -370,7 +374,7 @@

                                                        @@ -379,7 +383,8 @@

                                                        public onLoadDataContainer(string $table) : void - +
                                                        +

                                                        Parameters
                                                        @@ -393,21 +398,6 @@
                                                        Parameters
                                                        -
                                                        - Tags - -
                                                        -
                                                        -
                                                        - Hook -
                                                        -
                                                        - -

                                                        ("loadDataContainer")

                                                        -
                                                        - -
                                                        -
                                                        Return values
                                                        void @@ -428,7 +418,7 @@

                                                        diff --git a/classes/HeimrichHannot-UtilsBundle-EventListener-InitializeSystemListener.html b/classes/HeimrichHannot-UtilsBundle-EventListener-InitializeSystemListener.html deleted file mode 100644 index 64df280f..00000000 --- a/classes/HeimrichHannot-UtilsBundle-EventListener-InitializeSystemListener.html +++ /dev/null @@ -1,416 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                        -

                                                        Contao Utils Bundle

                                                        - - -
                                                        - -
                                                        - - -
                                                        - -
                                                        -
                                                        - - - - -
                                                        - - -
                                                        -

                                                        - InitializeSystemListener - - -
                                                        - in package - -
                                                        - - -

                                                        - - - -

                                                        Hook("initializeSystem").

                                                        - - - - - - - - - -

                                                        - Table of Contents - -

                                                        - -
                                                        -
                                                        - $bundleConfig - -  : array<string|int, mixed> -
                                                        -
                                                        - -
                                                        - $containerUtil - -  : ContainerUtil -
                                                        -
                                                        - -
                                                        - __construct() - -  : mixed -
                                                        -
                                                        InitializeSystemListener constructor.
                                                        - -
                                                        - __invoke() - -  : void -
                                                        -
                                                        - -
                                                        - - - - - - -
                                                        -

                                                        - Properties - -

                                                        -
                                                        -

                                                        - $bundleConfig - - - -

                                                        - - - - - protected - array<string|int, mixed> - $bundleConfig - - - - - - -
                                                        - -
                                                        - -
                                                        -

                                                        - Methods - -

                                                        -
                                                        -

                                                        - __construct() - -

                                                        - - -

                                                        InitializeSystemListener constructor.

                                                        - - - public - __construct(ContainerUtil $containerUtil, array<string|int, mixed> $bundleConfig) : mixed - - -
                                                        Parameters
                                                        -
                                                        -
                                                        - $containerUtil - : ContainerUtil -
                                                        -
                                                        -
                                                        - -
                                                        -
                                                        - $bundleConfig - : array<string|int, mixed> -
                                                        -
                                                        -
                                                        - -
                                                        -
                                                        - - - -
                                                        Return values
                                                        - mixed - — - - -
                                                        -
                                                        -

                                                        - __invoke() - -

                                                        - - - - - public - __invoke() : void - -
                                                        - - - - -
                                                        Return values
                                                        - void - — - - -
                                                        -
                                                        - - - - -
                                                        -
                                                        -
                                                        -
                                                        -

                                                        Search results

                                                        - -
                                                        -
                                                        -
                                                          -
                                                          -
                                                          -
                                                          -
                                                          -
                                                          - - -
                                                          - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-EventListener-InsertTagsListener.html b/classes/HeimrichHannot-UtilsBundle-EventListener-InsertTagsListener.html deleted file mode 100644 index 4ca0684c..00000000 --- a/classes/HeimrichHannot-UtilsBundle-EventListener-InsertTagsListener.html +++ /dev/null @@ -1,746 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                          -

                                                          Contao Utils Bundle

                                                          - - -
                                                          - -
                                                          - - -
                                                          - -
                                                          -
                                                          - - - - -
                                                          - - -
                                                          -

                                                          - InsertTagsListener - - -
                                                          - in package - -
                                                          - - -

                                                          - - - - -
                                                          - - - - - - - - -

                                                          - Table of Contents - -

                                                          - -
                                                          -
                                                          - $contaoFramework - -  : ContaoFrameworkInterface -
                                                          -
                                                          - -
                                                          - $eventDispatcher - -  : EventDispatcherInterface -
                                                          -
                                                          - -
                                                          - $supportedTags - -  : array<string|int, mixed> -
                                                          -
                                                          - -
                                                          - $templateUtil - -  : TemplateUtil -
                                                          -
                                                          - -
                                                          - $twig - -  : Environment -
                                                          -
                                                          - -
                                                          - __construct() - -  : mixed -
                                                          -
                                                          Constructor.
                                                          - -
                                                          - onReplaceInsertTags() - -  : string|false -
                                                          -
                                                          Replaces calendar insert tags.
                                                          - -
                                                          - replaceSupportedTags() - -  : string -
                                                          -
                                                          Replace supported tags.
                                                          - -
                                                          - replaceTwigTag() - -  : string -
                                                          -
                                                          Replace twig template insert tags {{twig::logo.html.twig::a:1:{s:3:"foo";s:3:"bar";}}}.
                                                          - -
                                                          - - - - - - -
                                                          -

                                                          - Properties - -

                                                          -
                                                          -

                                                          - $contaoFramework - - - -

                                                          - - - - - private - ContaoFrameworkInterface - $contaoFramework - - - - - - -
                                                          -
                                                          -

                                                          - $eventDispatcher - - - -

                                                          - - - - - private - EventDispatcherInterface - $eventDispatcher - - - - - - -
                                                          -
                                                          -

                                                          - $supportedTags - - - -

                                                          - - - - - private - array<string|int, mixed> - $supportedTags - = ['twig'] - - - - - -
                                                          - -
                                                          -

                                                          - $twig - - - -

                                                          - - - - - private - Environment - $twig - - - - - - -
                                                          -
                                                          - -
                                                          -

                                                          - Methods - -

                                                          -
                                                          -

                                                          - __construct() - -

                                                          - - -

                                                          Constructor.

                                                          - - - public - __construct(EventDispatcherInterface $eventDispatcher, Environment $twig, TemplateUtil $templateUtil, ContaoFrameworkInterface $contaoFramework) : mixed - - -
                                                          Parameters
                                                          -
                                                          -
                                                          - $eventDispatcher - : EventDispatcherInterface -
                                                          -
                                                          -
                                                          - -
                                                          -
                                                          - $twig - : Environment -
                                                          -
                                                          -
                                                          - -
                                                          -
                                                          - $templateUtil - : TemplateUtil -
                                                          -
                                                          -
                                                          - -
                                                          -
                                                          - $contaoFramework - : ContaoFrameworkInterface -
                                                          -
                                                          -
                                                          - -
                                                          -
                                                          - - - -
                                                          Return values
                                                          - mixed - — - - -
                                                          -
                                                          -

                                                          - onReplaceInsertTags() - -

                                                          - - -

                                                          Replaces calendar insert tags.

                                                          - - - public - onReplaceInsertTags(string $tag) : string|false - - -
                                                          Parameters
                                                          -
                                                          -
                                                          - $tag - : string -
                                                          -
                                                          -
                                                          - -
                                                          -
                                                          - - - -
                                                          Return values
                                                          - string|false - — - - -
                                                          -
                                                          -

                                                          - replaceSupportedTags() - -

                                                          - - -

                                                          Replace supported tags.

                                                          - - - protected - replaceSupportedTags(string $key[, array<string|int, mixed> $attributes = [] ]) : string - - -
                                                          Parameters
                                                          -
                                                          -
                                                          - $key - : string -
                                                          -
                                                          -
                                                          - -
                                                          -
                                                          - $attributes - : array<string|int, mixed> - = []
                                                          -
                                                          -
                                                          - -
                                                          -
                                                          - - -
                                                          - Tags - -
                                                          -
                                                          -
                                                          - throws -
                                                          -
                                                          - InvalidArgumentException - - -
                                                          -
                                                          - throws -
                                                          -
                                                          - Twig_Error_Loader - - -
                                                          -
                                                          - throws -
                                                          -
                                                          - Twig_Error_Runtime - - -
                                                          -
                                                          - throws -
                                                          -
                                                          - Twig_Error_Syntax - - -
                                                          -
                                                          - -
                                                          Return values
                                                          - string - — - - -
                                                          -
                                                          -

                                                          - replaceTwigTag() - -

                                                          - - -

                                                          Replace twig template insert tags {{twig::logo.html.twig::a:1:{s:3:"foo";s:3:"bar";}}}.

                                                          - - - protected - replaceTwigTag([array<string|int, mixed> $attributes = [] ]) : string - - -
                                                          Parameters
                                                          -
                                                          -
                                                          - $attributes - : array<string|int, mixed> - = []
                                                          -
                                                          -
                                                          - -
                                                          -
                                                          - - -
                                                          - Tags - -
                                                          -
                                                          -
                                                          - throws -
                                                          -
                                                          - InvalidArgumentException - - -
                                                          -
                                                          - throws -
                                                          -
                                                          - Twig_Error_Loader - - -
                                                          -
                                                          - throws -
                                                          -
                                                          - Twig_Error_Runtime - - -
                                                          -
                                                          - throws -
                                                          -
                                                          - Twig_Error_Syntax - - -
                                                          -
                                                          - -
                                                          Return values
                                                          - string - — - - -
                                                          -
                                                          - - - - -
                                                          -
                                                          -
                                                          -
                                                          -

                                                          Search results

                                                          - -
                                                          -
                                                          -
                                                            -
                                                            -
                                                            -
                                                            -
                                                            -
                                                            - - -
                                                            - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-File-FileArchiveUtil.html b/classes/HeimrichHannot-UtilsBundle-File-FileArchiveUtil.html deleted file mode 100644 index 4dd8ab7c..00000000 --- a/classes/HeimrichHannot-UtilsBundle-File-FileArchiveUtil.html +++ /dev/null @@ -1,497 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                            -

                                                            Contao Utils Bundle

                                                            - - -
                                                            - -
                                                            - - -
                                                            - -
                                                            -
                                                            - - - - -
                                                            - - -
                                                            -

                                                            - FileArchiveUtil - - -
                                                            - in package - -
                                                            - - -

                                                            - - - - -
                                                            - - - - - - - - -

                                                            - Table of Contents - -

                                                            - -
                                                            -
                                                            - $folderUtil - -  : FolderUtil -
                                                            -
                                                            - -
                                                            - $projectDir - -  : string -
                                                            -
                                                            - -
                                                            - $utilsConfig - -  : array<string|int, mixed> -
                                                            -
                                                            - -
                                                            - __construct() - -  : mixed -
                                                            -
                                                            FileArchiveUtil constructor.
                                                            - -
                                                            - createFileArchive() - -  : string -
                                                            -
                                                            Create a temporary zip file and return the file path.
                                                            - -
                                                            - - - - - - -
                                                            -

                                                            - Properties - -

                                                            - -
                                                            -

                                                            - $projectDir - - - -

                                                            - - - - - private - string - $projectDir - - - - - - -
                                                            -
                                                            -

                                                            - $utilsConfig - - - -

                                                            - - - - - private - array<string|int, mixed> - $utilsConfig - - - - - - -
                                                            -
                                                            - -
                                                            -

                                                            - Methods - -

                                                            -
                                                            -

                                                            - __construct() - -

                                                            - - -

                                                            FileArchiveUtil constructor.

                                                            - - - public - __construct(string $projectDir, array<string|int, mixed> $utilsConfig, FolderUtil $folderUtil) : mixed - - -
                                                            Parameters
                                                            -
                                                            -
                                                            - $projectDir - : string -
                                                            -
                                                            -
                                                            - -
                                                            -
                                                            - $utilsConfig - : array<string|int, mixed> -
                                                            -
                                                            -
                                                            - -
                                                            -
                                                            - $folderUtil - : FolderUtil -
                                                            -
                                                            -
                                                            - -
                                                            -
                                                            - - - -
                                                            Return values
                                                            - mixed - — - - -
                                                            -
                                                            -

                                                            - createFileArchive() - -

                                                            - - -

                                                            Create a temporary zip file and return the file path.

                                                            - - - public - createFileArchive(array<string|int, FilesModel>|array<string|int, mixed> $items, string $archiveName) : string - - -
                                                            Parameters
                                                            -
                                                            -
                                                            - $items - : array<string|int, FilesModel>|array<string|int, mixed> -
                                                            -
                                                            - -
                                                            -
                                                            - $archiveName - : string -
                                                            -
                                                            -
                                                            - -
                                                            -
                                                            - - -
                                                            - Tags - -
                                                            -
                                                            -
                                                            - throws -
                                                            -
                                                            - Exception - - -
                                                            -
                                                            - -
                                                            Return values
                                                            - string - — -

                                                            the path to the temporary zip file

                                                            -
                                                            - - -
                                                            -
                                                            - - - - -
                                                            -
                                                            -
                                                            -
                                                            -

                                                            Search results

                                                            - -
                                                            -
                                                            -
                                                              -
                                                              -
                                                              -
                                                              -
                                                              -
                                                              - - -
                                                              - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-File-FileStorageUtil.html b/classes/HeimrichHannot-UtilsBundle-File-FileStorageUtil.html deleted file mode 100644 index 4a62b795..00000000 --- a/classes/HeimrichHannot-UtilsBundle-File-FileStorageUtil.html +++ /dev/null @@ -1,392 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                              -

                                                              Contao Utils Bundle

                                                              - - -
                                                              - -
                                                              - - -
                                                              - -
                                                              -
                                                              - - - - -
                                                              - - -
                                                              -

                                                              - FileStorageUtil - - -
                                                              - in package - -
                                                              - - -

                                                              - - - - -
                                                              - - - - - - - - -

                                                              - Table of Contents - -

                                                              - -
                                                              -
                                                              - $projectDir - -  : string -
                                                              -
                                                              - -
                                                              - __construct() - -  : mixed -
                                                              -
                                                              FileStorageUtil constructor.
                                                              - -
                                                              - createFileStorage() - -  : FileStorage -
                                                              -
                                                              Returns a new FileStorage instance.
                                                              - -
                                                              - - - - - - -
                                                              -

                                                              - Properties - -

                                                              -
                                                              -

                                                              - $projectDir - - - -

                                                              - - - - - private - string - $projectDir - - - - - - -
                                                              -
                                                              - -
                                                              -

                                                              - Methods - -

                                                              -
                                                              -

                                                              - __construct() - -

                                                              - - -

                                                              FileStorageUtil constructor.

                                                              - - - public - __construct(string $projectDir) : mixed - - -
                                                              Parameters
                                                              -
                                                              -
                                                              - $projectDir - : string -
                                                              -
                                                              -
                                                              - -
                                                              -
                                                              - - - -
                                                              Return values
                                                              - mixed - — - - -
                                                              -
                                                              -

                                                              - createFileStorage() - -

                                                              - - -

                                                              Returns a new FileStorage instance.

                                                              - - - public - createFileStorage(string $storagePath[, string $fileExtension = '' ]) : FileStorage - -

                                                              See PdfPreview for example usage.

                                                              -
                                                              - -
                                                              Parameters
                                                              -
                                                              -
                                                              - $storagePath - : string -
                                                              -
                                                              -

                                                              The path where to store the files relative to the project dir

                                                              -
                                                              - -
                                                              -
                                                              - $fileExtension - : string - = ''
                                                              -
                                                              -

                                                              The default file extension of the stored files. E.g. jpg, txt, ...

                                                              -
                                                              - -
                                                              -
                                                              - - - -
                                                              Return values
                                                              - FileStorage - — - - -
                                                              -
                                                              - - - - -
                                                              -
                                                              -
                                                              -
                                                              -

                                                              Search results

                                                              - -
                                                              -
                                                              -
                                                                -
                                                                -
                                                                -
                                                                -
                                                                -
                                                                - - -
                                                                - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-File-FileUtil.html b/classes/HeimrichHannot-UtilsBundle-File-FileUtil.html deleted file mode 100644 index f230577b..00000000 --- a/classes/HeimrichHannot-UtilsBundle-File-FileUtil.html +++ /dev/null @@ -1,1760 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                -

                                                                Contao Utils Bundle

                                                                - - -
                                                                - -
                                                                - - -
                                                                - -
                                                                -
                                                                - - - - -
                                                                - - -
                                                                -

                                                                - FileUtil - - -
                                                                - in package - -
                                                                - - -

                                                                - - - - -
                                                                - - - - - - - - -

                                                                - Table of Contents - -

                                                                - -
                                                                -
                                                                - FILE_UTIL_CONVERT_FILE_TYPE - -  = 'png' -
                                                                -
                                                                - -
                                                                - $framework - -  : ContaoFramework -
                                                                -
                                                                - -
                                                                - $container - -  : ContainerInterface -
                                                                -
                                                                - -
                                                                - __construct() - -  : mixed -
                                                                -
                                                                - -
                                                                - addUniqueIdToFilename() - -  : string -
                                                                -
                                                                Add a unique identifier to a file name.
                                                                - -
                                                                - formatSizeUnits() - -  : mixed -
                                                                -
                                                                - -
                                                                - getExtensionByMimeType() - -  : mixed -
                                                                -
                                                                - -
                                                                - getExtensionFromFileContent() - -  : mixed -
                                                                -
                                                                - -
                                                                - getFileContentFromUuid() - -  : mixed -
                                                                -
                                                                - -
                                                                - getFileExtension() - -  : mixed -
                                                                -
                                                                - -
                                                                - getFileFromUuid() - -  : File|null -
                                                                -
                                                                - -
                                                                - getFileIdFromPath() - -  : mixed -
                                                                -
                                                                - -
                                                                - getFileLineCount() - -  : int|string -
                                                                -
                                                                - -
                                                                - getFileList() - -  : array<string|int, mixed> -
                                                                -
                                                                Returns the file list for a given directory.
                                                                - -
                                                                - getFolderContent() - -  : mixed -
                                                                -
                                                                - -
                                                                - getFolderFromDca() - -  : mixed|null -
                                                                -
                                                                Get real folder from datacontainer attribute.
                                                                - -
                                                                - getFolderFromUuid() - -  : bool|Folder -
                                                                -
                                                                - -
                                                                - getParentFoldersByUuid() - -  : mixed -
                                                                -
                                                                - -
                                                                - getPathFromUuid() - -  : string|null -
                                                                -
                                                                - -
                                                                - getPathWithoutFilename() - -  : mixed -
                                                                -
                                                                - -
                                                                - getPreviewFromPdf() - -  : FilesModel -
                                                                -
                                                                convert pdf to png and return a preview file -delete the other png files.
                                                                - -
                                                                - getUniqueFileNameWithinTarget() - -  : string|false -
                                                                -
                                                                Get a unique filename within given target folder, remove uniqid() suffix from file (optional, add $prefix) and append file count by name to -file if file with same name already exists in target folder.
                                                                - -
                                                                - retrieveFileContent() - -  : bool|mixed -
                                                                -
                                                                Tries to get the binary content from a file in various sources and returns it if possible.
                                                                - -
                                                                - sanitizeFileName() - -  : string -
                                                                -
                                                                Sanitize filename and removes "id-" prefix generated by contao standardize method.
                                                                - -
                                                                - sendTextAsFileToBrowser() - -  : mixed -
                                                                -
                                                                - -
                                                                - - - - -
                                                                -

                                                                - Constants - -

                                                                -
                                                                -

                                                                - FILE_UTIL_CONVERT_FILE_TYPE - -

                                                                - - - - - - public - mixed - FILE_UTIL_CONVERT_FILE_TYPE - = 'png' - - - -
                                                                - -
                                                                - - - -
                                                                -
                                                                - - -
                                                                -

                                                                - Properties - -

                                                                -
                                                                -

                                                                - $framework - - - -

                                                                - - - - - protected - ContaoFramework - $framework - - - - - - -
                                                                -
                                                                -

                                                                - $container - - - -

                                                                - - - - - private - ContainerInterface - $container - - - - - - -
                                                                -
                                                                - -
                                                                -

                                                                - Methods - -

                                                                -
                                                                -

                                                                - __construct() - -

                                                                - - - - - public - __construct(ContainerInterface $container) : mixed - -
                                                                - -
                                                                Parameters
                                                                -
                                                                -
                                                                - $container - : ContainerInterface -
                                                                -
                                                                -
                                                                - -
                                                                -
                                                                - - - -
                                                                Return values
                                                                - mixed - — - - -
                                                                -
                                                                -

                                                                - addUniqueIdToFilename() - -

                                                                - - -

                                                                Add a unique identifier to a file name.

                                                                - - - public - addUniqueIdToFilename(string $fileName[, string $prefix = null ][, bool $moreEntropy = true ]) : string - - -
                                                                Parameters
                                                                -
                                                                -
                                                                - $fileName - : string -
                                                                -
                                                                -

                                                                The file name, can be with or without path

                                                                -
                                                                - -
                                                                -
                                                                - $prefix - : string - = null
                                                                -
                                                                -

                                                                add a prefix to the unique identifier, with an empty prefix, the returned string will be 13 characters long

                                                                -
                                                                - -
                                                                -
                                                                - $moreEntropy - : bool - = true
                                                                -
                                                                -

                                                                if set to TRUE, will add additional entropy (using the combined linear congruential generator) at the end of the -return value, which increases the likelihood that the result will be unique

                                                                -
                                                                - -
                                                                -
                                                                - - - -
                                                                Return values
                                                                - string - — -

                                                                Filename with timestamp based unique identifier

                                                                -
                                                                - - -
                                                                -
                                                                -

                                                                - formatSizeUnits() - -

                                                                - - - - - public - formatSizeUnits(int $bytes[, mixed $keepTogether = false ]) : mixed - -
                                                                - -
                                                                Parameters
                                                                -
                                                                -
                                                                - $bytes - : int -
                                                                -
                                                                -
                                                                - -
                                                                -
                                                                - $keepTogether - : mixed - = false
                                                                -
                                                                -
                                                                - -
                                                                -
                                                                - - - -
                                                                Return values
                                                                - mixed - — - - -
                                                                -
                                                                -

                                                                - getExtensionByMimeType() - -

                                                                - - - - - public - getExtensionByMimeType(mixed $mimeType) : mixed - -
                                                                - -
                                                                Parameters
                                                                -
                                                                -
                                                                - $mimeType - : mixed -
                                                                -
                                                                -
                                                                - -
                                                                -
                                                                - - - -
                                                                Return values
                                                                - mixed - — - - -
                                                                -
                                                                -

                                                                - getExtensionFromFileContent() - -

                                                                - - - - - public - getExtensionFromFileContent(mixed $content) : mixed - -
                                                                - -
                                                                Parameters
                                                                -
                                                                -
                                                                - $content - : mixed -
                                                                -
                                                                -
                                                                - -
                                                                -
                                                                - - - -
                                                                Return values
                                                                - mixed - — - - -
                                                                -
                                                                -

                                                                - getFileContentFromUuid() - -

                                                                - - - - - public - getFileContentFromUuid(mixed $uuid) : mixed - -
                                                                - -
                                                                Parameters
                                                                -
                                                                -
                                                                - $uuid - : mixed -
                                                                -
                                                                -
                                                                - -
                                                                -
                                                                - - - -
                                                                Return values
                                                                - mixed - — - - -
                                                                -
                                                                -

                                                                - getFileExtension() - -

                                                                - - - - - public - getFileExtension(mixed $path) : mixed - -
                                                                - -
                                                                Parameters
                                                                -
                                                                -
                                                                - $path - : mixed -
                                                                -
                                                                -
                                                                - -
                                                                -
                                                                - - - -
                                                                Return values
                                                                - mixed - — - - -
                                                                -
                                                                -

                                                                - getFileFromUuid() - -

                                                                - - - - - public - getFileFromUuid( $uuid) : File|null - - -
                                                                Parameters
                                                                -
                                                                -
                                                                - $uuid - : -
                                                                -
                                                                - -
                                                                -
                                                                - - -
                                                                - Tags - -
                                                                -
                                                                -
                                                                - throws -
                                                                -
                                                                - Exception - - -
                                                                -
                                                                - -
                                                                Return values
                                                                - File|null - — -

                                                                Return the file object

                                                                -
                                                                - - -
                                                                -
                                                                -

                                                                - getFileIdFromPath() - -

                                                                - - - - - public - getFileIdFromPath(mixed $path) : mixed - -
                                                                - -
                                                                Parameters
                                                                -
                                                                -
                                                                - $path - : mixed -
                                                                -
                                                                -
                                                                - -
                                                                -
                                                                - - - -
                                                                Return values
                                                                - mixed - — - - -
                                                                -
                                                                -

                                                                - getFileLineCount() - -

                                                                - - - - - public - getFileLineCount( $file) : int|string - - -
                                                                Parameters
                                                                -
                                                                -
                                                                - $file - : -
                                                                -
                                                                - -
                                                                -
                                                                - - - -
                                                                Return values
                                                                - int|string - — - - -
                                                                -
                                                                -

                                                                - getFileList() - -

                                                                - - -

                                                                Returns the file list for a given directory.

                                                                - - - public - getFileList(string $dir, string $baseUrl[, string $protectedBaseUrl = null ]) : array<string|int, mixed> - - -
                                                                Parameters
                                                                -
                                                                -
                                                                - $dir - : string -
                                                                -
                                                                -
                                                                  -
                                                                • the absolute local path to the directory (e.g. /dir/mydir)
                                                                  • -
                                                                -
                                                                - -
                                                                -
                                                                - $baseUrl - : string -
                                                                -
                                                                -
                                                                  -
                                                                • the relative uri (e.g. /tl_files/mydir)
                                                                  • -
                                                                -
                                                                - -
                                                                -
                                                                - $protectedBaseUrl - : string - = null
                                                                -
                                                                -
                                                                  -
                                                                • domain + request uri -> absUrl will be domain + request uri + ?file=$baseUrl/filename.ext
                                                                  • -
                                                                -
                                                                - -
                                                                -
                                                                - - - -
                                                                Return values
                                                                - array<string|int, mixed> - — -

                                                                file list containing file objects

                                                                -
                                                                - - -
                                                                -
                                                                -

                                                                - getFolderContent() - -

                                                                - - - - - public - getFolderContent(mixed $parentIds, mixed $table[, mixed $options = [] ][, mixed $return = [] ]) : mixed - -
                                                                - -
                                                                Parameters
                                                                -
                                                                -
                                                                - $parentIds - : mixed -
                                                                -
                                                                -
                                                                - -
                                                                -
                                                                - $table - : mixed -
                                                                -
                                                                -
                                                                - -
                                                                -
                                                                - $options - : mixed - = []
                                                                -
                                                                -
                                                                - -
                                                                -
                                                                - $return - : mixed - = []
                                                                -
                                                                -
                                                                - -
                                                                -
                                                                - - - -
                                                                Return values
                                                                - mixed - — - - -
                                                                -
                                                                -

                                                                - getFolderFromDca() - -

                                                                - - -

                                                                Get real folder from datacontainer attribute.

                                                                - - - public - getFolderFromDca(mixed $folder[, DataContainer|null $dc = null ]) : mixed|null - - -
                                                                Parameters
                                                                -
                                                                -
                                                                - $folder - : mixed -
                                                                -
                                                                -

                                                                The folder as uuid, function, callback array('CLASS', 'method') or string (files/...)

                                                                -
                                                                - -
                                                                -
                                                                - $dc - : DataContainer|null - = null
                                                                -
                                                                -

                                                                Optional \DataContainer, required for function and callback

                                                                -
                                                                - -
                                                                -
                                                                - - -
                                                                - Tags - -
                                                                -
                                                                -
                                                                - throws -
                                                                -
                                                                - Exception - -

                                                                If ../ is part of the path

                                                                -
                                                                - -
                                                                -
                                                                - -
                                                                Return values
                                                                - mixed|null - — -

                                                                The folder path or null

                                                                -
                                                                - - -
                                                                -
                                                                -

                                                                - getFolderFromUuid() - -

                                                                - - - - - public - getFolderFromUuid( $uuid) : bool|Folder - - -
                                                                Parameters
                                                                -
                                                                -
                                                                - $uuid - : -
                                                                -
                                                                - -
                                                                -
                                                                - - -
                                                                - Tags - -
                                                                -
                                                                -
                                                                - throws -
                                                                -
                                                                - Exception - - -
                                                                -
                                                                - -
                                                                Return values
                                                                - bool|Folder - — -

                                                                Return the folder object

                                                                -
                                                                - - -
                                                                -
                                                                -

                                                                - getParentFoldersByUuid() - -

                                                                - - - - - public - getParentFoldersByUuid(mixed $uuid[, array<string|int, mixed> $config = [] ]) : mixed - -
                                                                - -
                                                                Parameters
                                                                -
                                                                -
                                                                - $uuid - : mixed -
                                                                -
                                                                -
                                                                - -
                                                                -
                                                                - $config - : array<string|int, mixed> - = []
                                                                -
                                                                -
                                                                - -
                                                                -
                                                                - - - -
                                                                Return values
                                                                - mixed - — - - -
                                                                -
                                                                -

                                                                - getPathFromUuid() - -

                                                                - - - - - public - getPathFromUuid( $uuid[, bool $checkIfExists = true ]) : string|null - - -
                                                                Parameters
                                                                -
                                                                -
                                                                - $uuid - : -
                                                                -
                                                                - -
                                                                -
                                                                - $checkIfExists - : bool - = true
                                                                -
                                                                - -
                                                                -
                                                                - - -
                                                                - Tags - -
                                                                -
                                                                -
                                                                - deprecated -
                                                                -
                                                                - -

                                                                Use Utils::file instead

                                                                -
                                                                - -
                                                                -
                                                                - codeCoverageIgnore -
                                                                -
                                                                - - -
                                                                -
                                                                - -
                                                                Return values
                                                                - string|null - — -

                                                                Return the path of the file, or null if not exists

                                                                -
                                                                - - -
                                                                -
                                                                -

                                                                - getPathWithoutFilename() - -

                                                                - - - - - public - getPathWithoutFilename(mixed $pathToFile) : mixed - -
                                                                - -
                                                                Parameters
                                                                -
                                                                -
                                                                - $pathToFile - : mixed -
                                                                -
                                                                -
                                                                - -
                                                                -
                                                                - - - -
                                                                Return values
                                                                - mixed - — - - -
                                                                -
                                                                -

                                                                - getPreviewFromPdf() - -

                                                                - - -

                                                                convert pdf to png and return a preview file -delete the other png files.

                                                                - - - public - getPreviewFromPdf(FilesModel $file, int $page) : FilesModel - - -
                                                                Parameters
                                                                -
                                                                -
                                                                - $file - : FilesModel -
                                                                -
                                                                -
                                                                - -
                                                                -
                                                                - $page - : int -
                                                                -
                                                                -
                                                                - -
                                                                -
                                                                - - -
                                                                - Tags - -
                                                                -
                                                                -
                                                                - deprecated -
                                                                -
                                                                - -

                                                                Dublicate to PdfPreview util

                                                                -
                                                                - -
                                                                -
                                                                - -
                                                                Return values
                                                                - FilesModel - — - - -
                                                                -
                                                                -

                                                                - getUniqueFileNameWithinTarget() - -

                                                                - - -

                                                                Get a unique filename within given target folder, remove uniqid() suffix from file (optional, add $prefix) and append file count by name to -file if file with same name already exists in target folder.

                                                                - - - public - getUniqueFileNameWithinTarget(string $target[, string $prefix = null ],  $i) : string|false - - -
                                                                Parameters
                                                                -
                                                                -
                                                                - $target - : string -
                                                                -
                                                                -

                                                                The target file path

                                                                -
                                                                - -
                                                                -
                                                                - $prefix - : string - = null
                                                                -
                                                                -

                                                                A uniqid prefix from the given target file, that was added to the file before and should be removed again

                                                                -
                                                                - -
                                                                -
                                                                - $i - : -
                                                                -
                                                                -

                                                                integer Internal counter for recursion usage or if you want to add the number to the file

                                                                -
                                                                - -
                                                                -
                                                                - - -
                                                                - Tags - -
                                                                -
                                                                -
                                                                - throws -
                                                                -
                                                                - Exception - - -
                                                                -
                                                                - -
                                                                Return values
                                                                - string|false - — -

                                                                The filename with the target folder and unique id or false if something went wrong (e.g. target does not exist)

                                                                -
                                                                - - -
                                                                -
                                                                -

                                                                - retrieveFileContent() - -

                                                                - - -

                                                                Tries to get the binary content from a file in various sources and returns it if possible.

                                                                - - - public - retrieveFileContent( $source[, mixed $silent = true ]) : bool|mixed - -

                                                                Possible sources:

                                                                -
                                                                  -
                                                                • url
                                                                  • -
                                                                • contao uuid
                                                                  • -
                                                                • string is already a binary file content
                                                                  • -
                                                                -
                                                                - -
                                                                Parameters
                                                                -
                                                                -
                                                                - $source - : -
                                                                -
                                                                - -
                                                                -
                                                                - $silent - : mixed - = true
                                                                -
                                                                -
                                                                - -
                                                                -
                                                                - - - -
                                                                Return values
                                                                - bool|mixed - — -

                                                                Returns false if the file content could not be retrieved

                                                                -
                                                                - - -
                                                                -
                                                                -

                                                                - sanitizeFileName() - -

                                                                - - -

                                                                Sanitize filename and removes "id-" prefix generated by contao standardize method.

                                                                - - - public - sanitizeFileName(string $fileName, int $maxCount[, bool $preserveUppercase = false ]) : string - - -
                                                                Parameters
                                                                -
                                                                -
                                                                - $fileName - : string -
                                                                -
                                                                -

                                                                The file name, can be with or without path

                                                                -
                                                                - -
                                                                -
                                                                - $maxCount - : int -
                                                                -
                                                                -

                                                                Max filename length

                                                                -
                                                                - -
                                                                -
                                                                - $preserveUppercase - : bool - = false
                                                                -
                                                                -

                                                                Set to true if you want to lower case the file name

                                                                -
                                                                - -
                                                                -
                                                                - - - -
                                                                Return values
                                                                - string - — -

                                                                The sanitized filename

                                                                -
                                                                - - -
                                                                -
                                                                -

                                                                - sendTextAsFileToBrowser() - -

                                                                - - - - - public - sendTextAsFileToBrowser(mixed $content, mixed $fileName) : mixed - -
                                                                - -
                                                                Parameters
                                                                -
                                                                -
                                                                - $content - : mixed -
                                                                -
                                                                -
                                                                - -
                                                                -
                                                                - $fileName - : mixed -
                                                                -
                                                                -
                                                                - -
                                                                -
                                                                - - - -
                                                                Return values
                                                                - mixed - — - - -
                                                                -
                                                                - - - - -
                                                                -
                                                                -
                                                                -
                                                                -

                                                                Search results

                                                                - -
                                                                -
                                                                -
                                                                  -
                                                                  -
                                                                  -
                                                                  -
                                                                  -
                                                                  - - -
                                                                  - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-File-FolderUtil.html b/classes/HeimrichHannot-UtilsBundle-File-FolderUtil.html deleted file mode 100644 index ac4ad34f..00000000 --- a/classes/HeimrichHannot-UtilsBundle-File-FolderUtil.html +++ /dev/null @@ -1,488 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                  -

                                                                  Contao Utils Bundle

                                                                  - - -
                                                                  - -
                                                                  - - -
                                                                  - -
                                                                  -
                                                                  - - - - -
                                                                  - - -
                                                                  -

                                                                  - FolderUtil - - -
                                                                  - in package - -
                                                                  - - -

                                                                  - - - - -
                                                                  - - - - - - - - -

                                                                  - Table of Contents - -

                                                                  - -
                                                                  -
                                                                  - $kernel - -  : KernelInterface -
                                                                  -
                                                                  - -
                                                                  - $symlinksCommand - -  : SymlinksCommand -
                                                                  -
                                                                  - -
                                                                  - $webDir - -  : string -
                                                                  -
                                                                  - -
                                                                  - __construct() - -  : mixed -
                                                                  -
                                                                  FolderUtil constructor.
                                                                  - -
                                                                  - createPublicFolder() - -  : void -
                                                                  -
                                                                  Creates an symlink to the given folder in the web director, if not already exist.
                                                                  - -
                                                                  - - - - - - -
                                                                  -

                                                                  - Properties - -

                                                                  -
                                                                  -

                                                                  - $kernel - - - -

                                                                  - - - - - private - KernelInterface - $kernel - - - - - - -
                                                                  -
                                                                  -

                                                                  - $symlinksCommand - - - -

                                                                  - - - - - private - SymlinksCommand - $symlinksCommand - - - - - - -
                                                                  -
                                                                  -

                                                                  - $webDir - - - -

                                                                  - - - - - private - string - $webDir - - - - - - -
                                                                  -
                                                                  - -
                                                                  -

                                                                  - Methods - -

                                                                  -
                                                                  -

                                                                  - __construct() - -

                                                                  - - -

                                                                  FolderUtil constructor.

                                                                  - - - public - __construct(string $webDir, KernelInterface $kernel, SymlinksCommand $symlinksCommand) : mixed - - -
                                                                  Parameters
                                                                  -
                                                                  -
                                                                  - $webDir - : string -
                                                                  -
                                                                  -
                                                                  - -
                                                                  -
                                                                  - $kernel - : KernelInterface -
                                                                  -
                                                                  -
                                                                  - -
                                                                  -
                                                                  - $symlinksCommand - : SymlinksCommand -
                                                                  -
                                                                  -
                                                                  - -
                                                                  -
                                                                  - - - -
                                                                  Return values
                                                                  - mixed - — - - -
                                                                  -
                                                                  -

                                                                  - createPublicFolder() - -

                                                                  - - -

                                                                  Creates an symlink to the given folder in the web director, if not already exist.

                                                                  - - - public - createPublicFolder(string $folderPath) : void - - -
                                                                  Parameters
                                                                  -
                                                                  -
                                                                  - $folderPath - : string -
                                                                  -
                                                                  -
                                                                  - -
                                                                  -
                                                                  - - -
                                                                  - Tags - -
                                                                  -
                                                                  -
                                                                  - throws -
                                                                  -
                                                                  - Exception - - -
                                                                  -
                                                                  - -
                                                                  Return values
                                                                  - void - — - - -
                                                                  -
                                                                  - - - - -
                                                                  -
                                                                  -
                                                                  -
                                                                  -

                                                                  Search results

                                                                  - -
                                                                  -
                                                                  -
                                                                    -
                                                                    -
                                                                    -
                                                                    -
                                                                    -
                                                                    - - -
                                                                    - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Form-FormUtil.html b/classes/HeimrichHannot-UtilsBundle-Form-FormUtil.html deleted file mode 100644 index 3ad0e02c..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Form-FormUtil.html +++ /dev/null @@ -1,865 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                    -

                                                                    Contao Utils Bundle

                                                                    - - -
                                                                    - -
                                                                    - - -
                                                                    - -
                                                                    -
                                                                    - - - - -
                                                                    - - -
                                                                    -

                                                                    - FormUtil - - -
                                                                    - in package - -
                                                                    - - -

                                                                    - - - -

                                                                    Class FormUtil.

                                                                    - - - -
                                                                    - Tags - -
                                                                    -
                                                                    -
                                                                    - see -
                                                                    -
                                                                    - https://heimrichhannot.github.io/contao-utils-bundle/HeimrichHannot/UtilsBundle/Form/FormUtil.html - - -
                                                                    -
                                                                    - - - - - - -

                                                                    - Table of Contents - -

                                                                    - -
                                                                    -
                                                                    - $framework - -  : ContaoFrameworkInterface -
                                                                    -
                                                                    - -
                                                                    - $optionsCache - -  : array<string|int, mixed> -
                                                                    -
                                                                    - -
                                                                    - $container - -  : ContainerInterface -
                                                                    -
                                                                    - -
                                                                    - __construct() - -  : mixed -
                                                                    -
                                                                    - -
                                                                    - escapeAllHtmlEntities() - -  : mixed -
                                                                    -
                                                                    - -
                                                                    - getBackendFormField() - -  : Widget|null -
                                                                    -
                                                                    Get an instance of Widget by passing fieldname and dca data.
                                                                    - -
                                                                    - getModelDataAsNotificationTokens() - -  : mixed -
                                                                    -
                                                                    - -
                                                                    - getWidgetFromAttributes() - -  : Widget|null -
                                                                    -
                                                                    Get a new widget instance based on given attributes from a Data Container array.
                                                                    - -
                                                                    - prepareSpecialValueForOutput() - -  : string -
                                                                    -
                                                                    Prepares a special field's value. If an array is inserted, the function will call itself recursively.
                                                                    - -
                                                                    - - - - - - -
                                                                    -

                                                                    - Properties - -

                                                                    -
                                                                    -

                                                                    - $framework - - - -

                                                                    - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
                                                                    -
                                                                    -

                                                                    - $optionsCache - - - -

                                                                    - - - - - protected - array<string|int, mixed> - $optionsCache - - - - - - -
                                                                    -
                                                                    -

                                                                    - $container - - - -

                                                                    - - - - - private - ContainerInterface - $container - - - - - - -
                                                                    -
                                                                    - -
                                                                    -

                                                                    - Methods - -

                                                                    -
                                                                    -

                                                                    - __construct() - -

                                                                    - - - - - public - __construct(ContainerInterface $container, ContaoFrameworkInterface $framework) : mixed - -
                                                                    - -
                                                                    Parameters
                                                                    -
                                                                    -
                                                                    - $container - : ContainerInterface -
                                                                    -
                                                                    -
                                                                    - -
                                                                    -
                                                                    - $framework - : ContaoFrameworkInterface -
                                                                    -
                                                                    -
                                                                    - -
                                                                    -
                                                                    - - - -
                                                                    Return values
                                                                    - mixed - — - - -
                                                                    -
                                                                    -

                                                                    - escapeAllHtmlEntities() - -

                                                                    - - - - - public - escapeAllHtmlEntities(mixed $table, mixed $field, mixed $value) : mixed - -
                                                                    - -
                                                                    Parameters
                                                                    -
                                                                    -
                                                                    - $table - : mixed -
                                                                    -
                                                                    -
                                                                    - -
                                                                    -
                                                                    - $field - : mixed -
                                                                    -
                                                                    -
                                                                    - -
                                                                    -
                                                                    - $value - : mixed -
                                                                    -
                                                                    -
                                                                    - -
                                                                    -
                                                                    - - - -
                                                                    Return values
                                                                    - mixed - — - - -
                                                                    -
                                                                    -

                                                                    - getBackendFormField() - -

                                                                    - - -

                                                                    Get an instance of Widget by passing fieldname and dca data.

                                                                    - - - public - getBackendFormField(string $fieldName, array<string|int, mixed> $dca[, array<string|int, mixed>|null $value = null ][, string $dbField = '' ][, string $table = '' ][, null $dataContainer = null ]) : Widget|null - - -
                                                                    Parameters
                                                                    -
                                                                    -
                                                                    - $fieldName - : string -
                                                                    -
                                                                    -

                                                                    The field name

                                                                    -
                                                                    - -
                                                                    -
                                                                    - $dca - : array<string|int, mixed> -
                                                                    -
                                                                    -

                                                                    The DCA

                                                                    -
                                                                    - -
                                                                    -
                                                                    - $value - : array<string|int, mixed>|null - = null
                                                                    -
                                                                    - -
                                                                    -
                                                                    - $dbField - : string - = ''
                                                                    -
                                                                    -

                                                                    The database field name

                                                                    -
                                                                    - -
                                                                    -
                                                                    - $table - : string - = ''
                                                                    -
                                                                    -

                                                                    The table

                                                                    -
                                                                    - -
                                                                    -
                                                                    - $dataContainer - : null - = null
                                                                    -
                                                                    -

                                                                    object The data container

                                                                    -
                                                                    - -
                                                                    -
                                                                    - - - -
                                                                    Return values
                                                                    - Widget|null - — - - -
                                                                    -
                                                                    -

                                                                    - getModelDataAsNotificationTokens() - -

                                                                    - - - - - public - getModelDataAsNotificationTokens(array<string|int, mixed> $data, string $prefix, DataContainer $dc[, array<string|int, mixed> $config = [] ]) : mixed - -
                                                                    - -
                                                                    Parameters
                                                                    -
                                                                    -
                                                                    - $data - : array<string|int, mixed> -
                                                                    -
                                                                    -
                                                                    - -
                                                                    -
                                                                    - $prefix - : string -
                                                                    -
                                                                    -
                                                                    - -
                                                                    -
                                                                    - $dc - : DataContainer -
                                                                    -
                                                                    -
                                                                    - -
                                                                    -
                                                                    - $config - : array<string|int, mixed> - = []
                                                                    -
                                                                    -
                                                                    - -
                                                                    -
                                                                    - - - -
                                                                    Return values
                                                                    - mixed - — - - -
                                                                    -
                                                                    -

                                                                    - getWidgetFromAttributes() - -

                                                                    - - -

                                                                    Get a new widget instance based on given attributes from a Data Container array.

                                                                    - - - public - getWidgetFromAttributes(string $name, array<string|int, mixed> $data[, mixed $value = null ][, string $dbName = '' ][, string $table = '' ][, DataContainer|null $dc = null ][, string $mode = '' ]) : Widget|null - - -
                                                                    Parameters
                                                                    -
                                                                    -
                                                                    - $name - : string -
                                                                    -
                                                                    -

                                                                    The field name in the form

                                                                    -
                                                                    - -
                                                                    -
                                                                    - $data - : array<string|int, mixed> -
                                                                    -
                                                                    -

                                                                    The field configuration array

                                                                    -
                                                                    - -
                                                                    -
                                                                    - $value - : mixed - = null
                                                                    -
                                                                    -

                                                                    The field value

                                                                    -
                                                                    - -
                                                                    -
                                                                    - $dbName - : string - = ''
                                                                    -
                                                                    -

                                                                    The field name in the database

                                                                    -
                                                                    - -
                                                                    -
                                                                    - $table - : string - = ''
                                                                    -
                                                                    -

                                                                    The table name in the database

                                                                    -
                                                                    - -
                                                                    -
                                                                    - $dc - : DataContainer|null - = null
                                                                    -
                                                                    -

                                                                    An optional DataContainer object

                                                                    -
                                                                    - -
                                                                    -
                                                                    - $mode - : string - = ''
                                                                    -
                                                                    -

                                                                    The contao mode, use FE or BE to get proper widget/form type

                                                                    -
                                                                    - -
                                                                    -
                                                                    - - - -
                                                                    Return values
                                                                    - Widget|null - — -

                                                                    The new widget based on given attributes

                                                                    -
                                                                    - - -
                                                                    -
                                                                    -

                                                                    - prepareSpecialValueForOutput() - -

                                                                    - - -

                                                                    Prepares a special field's value. If an array is inserted, the function will call itself recursively.

                                                                    - - - public - prepareSpecialValueForOutput(string $field,  $value, DataContainer $dc[, array<string|int, mixed> $config = [] ][, bool $isRecursiveCall = false ]) : string - -

                                                                    Possible config options:

                                                                    -
                                                                      -
                                                                    • preserveEmptyArrayValues -> preserves array values even if they're empty
                                                                      • -
                                                                    • skipLocalization -> skips usage of "reference" array defined in the field's dca
                                                                      • -
                                                                    • skipDcaLoading: boolean -> skip calling Controller::loadDataContainer on $dc->table
                                                                      • -
                                                                    • skipOptionCaching -> skip caching options if $value is an array
                                                                      • -
                                                                    • _dcaOverride: Array Set a custom dca from outside, which will be used instead of global dca value.
                                                                      • -
                                                                    -
                                                                    - -
                                                                    Parameters
                                                                    -
                                                                    -
                                                                    - $field - : string -
                                                                    -
                                                                    -
                                                                    - -
                                                                    -
                                                                    - $value - : -
                                                                    -
                                                                    - -
                                                                    -
                                                                    - $dc - : DataContainer -
                                                                    -
                                                                    -
                                                                    - -
                                                                    -
                                                                    - $config - : array<string|int, mixed> - = []
                                                                    -
                                                                    -
                                                                    - -
                                                                    -
                                                                    - $isRecursiveCall - : bool - = false
                                                                    -
                                                                    -
                                                                    - -
                                                                    -
                                                                    - - - -
                                                                    Return values
                                                                    - string - — - - -
                                                                    -
                                                                    - - - - -
                                                                    -
                                                                    -
                                                                    -
                                                                    -

                                                                    Search results

                                                                    - -
                                                                    -
                                                                    -
                                                                      -
                                                                      -
                                                                      -
                                                                      -
                                                                      -
                                                                      - - -
                                                                      - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-HeimrichHannotContaoUtilsBundle.html b/classes/HeimrichHannot-UtilsBundle-HeimrichHannotContaoUtilsBundle.html deleted file mode 100644 index a61722cb..00000000 --- a/classes/HeimrichHannot-UtilsBundle-HeimrichHannotContaoUtilsBundle.html +++ /dev/null @@ -1,275 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                      -

                                                                      Contao Utils Bundle

                                                                      - - -
                                                                      - -
                                                                      - - -
                                                                      - -
                                                                      -
                                                                      - - - - -
                                                                      - - -
                                                                      -

                                                                      - HeimrichHannotContaoUtilsBundle - - - extends Bundle - - -
                                                                      - in package - -
                                                                      - - -

                                                                      - - - - -
                                                                      - - - - - - - - -

                                                                      - Table of Contents - -

                                                                      - -
                                                                      -
                                                                      - getContainerExtension() - -  : mixed -
                                                                      -
                                                                      - -
                                                                      - - - - - - - -
                                                                      -

                                                                      - Methods - -

                                                                      -
                                                                      -

                                                                      - getContainerExtension() - -

                                                                      - - - - - public - getContainerExtension() : mixed - -
                                                                      - - - - -
                                                                      Return values
                                                                      - mixed - — - - -
                                                                      -
                                                                      - - - - -
                                                                      -
                                                                      -
                                                                      -
                                                                      -

                                                                      Search results

                                                                      - -
                                                                      -
                                                                      -
                                                                        -
                                                                        -
                                                                        -
                                                                        -
                                                                        -
                                                                        - - -
                                                                        - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-HeimrichHannotUtilsBundle.html b/classes/HeimrichHannot-UtilsBundle-HeimrichHannotUtilsBundle.html index dbbe24e0..23d18914 100644 --- a/classes/HeimrichHannot-UtilsBundle-HeimrichHannotUtilsBundle.html +++ b/classes/HeimrichHannot-UtilsBundle-HeimrichHannotUtilsBundle.html @@ -109,7 +109,7 @@

                                                                        @@ -130,9 +130,9 @@

                                                                        - getContainerExtension() + getPath() -  : mixed +  : string
                                                                        @@ -155,21 +155,21 @@

                                                                        -public " > -

                                                                        - getContainerExtension() - +

                                                                        + getPath() +

                                                                        public - getContainerExtension() : mixed + getPath() : string
                                                                        @@ -177,7 +177,7 @@

                                                                        Return values
                                                                        - mixed + string — diff --git a/classes/HeimrichHannot-UtilsBundle-Ics-IcsUtil.html b/classes/HeimrichHannot-UtilsBundle-Ics-IcsUtil.html deleted file mode 100644 index fdca7474..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Ics-IcsUtil.html +++ /dev/null @@ -1,440 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                        -

                                                                        Contao Utils Bundle

                                                                        - - -
                                                                        - -
                                                                        - - -
                                                                        - -
                                                                        -
                                                                        - - - - -
                                                                        - - -
                                                                        -

                                                                        - IcsUtil - - -
                                                                        - in package - -
                                                                        - - -

                                                                        - - - - -
                                                                        - - - - - - - - -

                                                                        - Table of Contents - -

                                                                        - -
                                                                        -
                                                                        - $framework - -  : ContaoFramework -
                                                                        -
                                                                        - -
                                                                        - $container - -  : ContainerInterface -
                                                                        -
                                                                        - -
                                                                        - __construct() - -  : mixed -
                                                                        -
                                                                        - -
                                                                        - generateIcs() - -  : string|null -
                                                                        -
                                                                        - -
                                                                        - - - - - - -
                                                                        -

                                                                        - Properties - -

                                                                        -
                                                                        -

                                                                        - $framework - - - -

                                                                        - - - - - protected - ContaoFramework - $framework - - - - - - -
                                                                        -
                                                                        -

                                                                        - $container - - - -

                                                                        - - - - - private - ContainerInterface - $container - - - - - - -
                                                                        -
                                                                        - -
                                                                        -

                                                                        - Methods - -

                                                                        -
                                                                        -

                                                                        - __construct() - -

                                                                        - - - - - public - __construct(ContainerInterface $container) : mixed - -
                                                                        - -
                                                                        Parameters
                                                                        -
                                                                        -
                                                                        - $container - : ContainerInterface -
                                                                        -
                                                                        -
                                                                        - -
                                                                        -
                                                                        - - - -
                                                                        Return values
                                                                        - mixed - — - - -
                                                                        -
                                                                        -

                                                                        - generateIcs() - -

                                                                        - - - - - public - generateIcs(array<string|int, mixed> $data[, array<string|int, mixed> $options = [] ]) : string|null - - -
                                                                        Parameters
                                                                        -
                                                                        -
                                                                        - $data - : array<string|int, mixed> -
                                                                        -
                                                                        -
                                                                        - -
                                                                        -
                                                                        - $options - : array<string|int, mixed> - = []
                                                                        -
                                                                        -
                                                                        - -
                                                                        -
                                                                        - - -
                                                                        - Tags - -
                                                                        -
                                                                        -
                                                                        - throws -
                                                                        -
                                                                        - Exception - - -
                                                                        -
                                                                        - -
                                                                        Return values
                                                                        - string|null - — - - -
                                                                        -
                                                                        - - - - -
                                                                        -
                                                                        -
                                                                        -
                                                                        -

                                                                        Search results

                                                                        - -
                                                                        -
                                                                        -
                                                                          -
                                                                          -
                                                                          -
                                                                          -
                                                                          -
                                                                          - - -
                                                                          - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Image-ImageUtil.html b/classes/HeimrichHannot-UtilsBundle-Image-ImageUtil.html deleted file mode 100644 index cc2b9260..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Image-ImageUtil.html +++ /dev/null @@ -1,609 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                          -

                                                                          Contao Utils Bundle

                                                                          - - -
                                                                          - -
                                                                          - - -
                                                                          - -
                                                                          -
                                                                          - - - - -
                                                                          - - -
                                                                          -

                                                                          - ImageUtil - - -
                                                                          - in package - -
                                                                          - - -

                                                                          - - - - -
                                                                          - - - - - - - - -

                                                                          - Table of Contents - -

                                                                          - -
                                                                          -
                                                                          - $container - -  : ContainerInterface -
                                                                          -
                                                                          - -
                                                                          - $framework - -  : ContaoFramework -
                                                                          -
                                                                          - -
                                                                          - __construct() - -  : mixed -
                                                                          -
                                                                          - -
                                                                          - addToTemplateData() - -  : mixed -
                                                                          -
                                                                          Add an image to a template.
                                                                          - -
                                                                          - getPixelValue() - -  : int -
                                                                          -
                                                                          Convert sizes like 2em, 10cm or 12pt to pixels.
                                                                          - -
                                                                          - prepareImage() - -  : array<string|int, mixed> -
                                                                          -
                                                                          Prepares one image for a typical Contao template.
                                                                          - -
                                                                          - - - - - - -
                                                                          -

                                                                          - Properties - -

                                                                          -
                                                                          -

                                                                          - $container - - - -

                                                                          - - - - - protected - ContainerInterface - $container - - - - - - -
                                                                          -
                                                                          -

                                                                          - $framework - - - -

                                                                          - - - - - protected - ContaoFramework - $framework - - - - - - -
                                                                          -
                                                                          - -
                                                                          -

                                                                          - Methods - -

                                                                          -
                                                                          -

                                                                          - __construct() - -

                                                                          - - - - - public - __construct(ContainerInterface $container) : mixed - -
                                                                          - -
                                                                          Parameters
                                                                          -
                                                                          -
                                                                          - $container - : ContainerInterface -
                                                                          -
                                                                          -
                                                                          - -
                                                                          -
                                                                          - - - -
                                                                          Return values
                                                                          - mixed - — - - -
                                                                          -
                                                                          -

                                                                          - addToTemplateData() - -

                                                                          - - -

                                                                          Add an image to a template.

                                                                          - - - public - addToTemplateData(string $imageField, string $imageSelectorField, array<string|int, mixed> &$templateData, array<string|int, mixed> $item[, int|null $maxWidth = null ][, string|null $lightboxId = null ][, string|null $lightboxName = null ][, FilesModel|null $model = null ]) : mixed - -

                                                                          Advanced version of Controller::addImageToTemplate -with custom imageField and imageSelectorField and array instead of FrontendTemplate.

                                                                          -
                                                                          - -
                                                                          Parameters
                                                                          -
                                                                          -
                                                                          - $imageField - : string -
                                                                          -
                                                                          -

                                                                          the image field name (typical singleSRC)

                                                                          -
                                                                          - -
                                                                          -
                                                                          - $imageSelectorField - : string -
                                                                          -
                                                                          -

                                                                          the image selector field indicated if an image is added (typical addImage)

                                                                          -
                                                                          - -
                                                                          -
                                                                          - $templateData - : array<string|int, mixed> -
                                                                          -
                                                                          -

                                                                          An array to add the generated data to

                                                                          -
                                                                          - -
                                                                          -
                                                                          - $item - : array<string|int, mixed> -
                                                                          -
                                                                          -

                                                                          The source data containing the imageField and imageSelectorField

                                                                          -
                                                                          - -
                                                                          -
                                                                          - $maxWidth - : int|null - = null
                                                                          -
                                                                          -

                                                                          An optional maximum width of the image

                                                                          -
                                                                          - -
                                                                          -
                                                                          - $lightboxId - : string|null - = null
                                                                          -
                                                                          -

                                                                          An optional lightbox ID

                                                                          -
                                                                          - -
                                                                          -
                                                                          - $lightboxName - : string|null - = null
                                                                          -
                                                                          -

                                                                          An optional lightbox name

                                                                          -
                                                                          - -
                                                                          -
                                                                          - $model - : FilesModel|null - = null
                                                                          -
                                                                          -

                                                                          an optional file model used to read meta data

                                                                          -
                                                                          - -
                                                                          -
                                                                          - - - -
                                                                          Return values
                                                                          - mixed - — - - -
                                                                          -
                                                                          -

                                                                          - getPixelValue() - -

                                                                          - - -

                                                                          Convert sizes like 2em, 10cm or 12pt to pixels.

                                                                          - - - public - getPixelValue(string $size) : int - - -
                                                                          Parameters
                                                                          -
                                                                          -
                                                                          - $size - : string -
                                                                          -
                                                                          -

                                                                          The size string

                                                                          -
                                                                          - -
                                                                          -
                                                                          - - - -
                                                                          Return values
                                                                          - int - — -

                                                                          The pixel value

                                                                          -
                                                                          - - -
                                                                          -
                                                                          -

                                                                          - prepareImage() - -

                                                                          - - -

                                                                          Prepares one image for a typical Contao template.

                                                                          - - - public - prepareImage(array<string|int, mixed> $data[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed> - -

                                                                          Possible option keys:

                                                                          -
                                                                            -
                                                                          • imageField: (string) The name of the field containers the image uuid. Default: singleSRC
                                                                            • -
                                                                          • imageSelectorField: (?string) The name of the field that indicated if an images is added. Set to null to skip check. Default: addImage
                                                                            • -
                                                                          • maxWidth: (int) An optional maximum width of the image. Passed directly to Controller::addImageToTemplate()
                                                                            • -
                                                                          • lightboxId: (string) An optional lightbox ID. Passed directly to Controller::addImageToTemplate()
                                                                            • -
                                                                          -
                                                                          - -
                                                                          Parameters
                                                                          -
                                                                          -
                                                                          - $data - : array<string|int, mixed> -
                                                                          -
                                                                          -

                                                                          the model/module/element data

                                                                          -
                                                                          - -
                                                                          -
                                                                          - $options - : array<string|int, mixed> - = []
                                                                          -
                                                                          -

                                                                          Additional options

                                                                          -
                                                                          - -
                                                                          -
                                                                          - - - -
                                                                          Return values
                                                                          - array<string|int, mixed> - — - - -
                                                                          -
                                                                          - - - - -
                                                                          -
                                                                          -
                                                                          -
                                                                          -

                                                                          Search results

                                                                          - -
                                                                          -
                                                                          -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            -
                                                                            - - -
                                                                            - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Member-MemberUtil.html b/classes/HeimrichHannot-UtilsBundle-Member-MemberUtil.html deleted file mode 100644 index 694d62ed..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Member-MemberUtil.html +++ /dev/null @@ -1,717 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                            -

                                                                            Contao Utils Bundle

                                                                            - - -
                                                                            - -
                                                                            - - -
                                                                            - -
                                                                            -
                                                                            - - - - -
                                                                            - - -
                                                                            -

                                                                            - MemberUtil - - -
                                                                            - in package - -
                                                                            - - - - Uses - PersonTrait -

                                                                            - - - - -
                                                                            - - - - - - - - -

                                                                            - Table of Contents - -

                                                                            - -
                                                                            -
                                                                            - TABLE - -  = 'tl_member' -
                                                                            -
                                                                            - -
                                                                            - $framework - -  : ContaoFrameworkInterface -
                                                                            -
                                                                            - -
                                                                            - $modelUtil - -  : ModelUtil -
                                                                            -
                                                                            - -
                                                                            - __construct() - -  : mixed -
                                                                            -
                                                                            - -
                                                                            - addHomeDir() - -  : bool|string -
                                                                            -
                                                                            Adds a new home dir to a member. Therefore a folder named with the members's id is created in $varRootFolder.
                                                                            - -
                                                                            - findActiveByGroups() - -  : MemberModel|array<string|int, MemberModel>|Collection|null -
                                                                            -
                                                                            Find active members by member group.
                                                                            - -
                                                                            - findOrCreate() - -  : mixed -
                                                                            -
                                                                            - -
                                                                            - getHomeDir() - -  : bool|string -
                                                                            -
                                                                            Returns a member home dir and creates one, if desired.
                                                                            - -
                                                                            - - - - -
                                                                            -

                                                                            - Constants - -

                                                                            -
                                                                            -

                                                                            - TABLE - -

                                                                            - - - - - - public - mixed - TABLE - = 'tl_member' - - - -
                                                                            - -
                                                                            - - - -
                                                                            -
                                                                            - - -
                                                                            -

                                                                            - Properties - -

                                                                            -
                                                                            -

                                                                            - $framework - - - -

                                                                            - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
                                                                            - -
                                                                            - -
                                                                            -

                                                                            - Methods - -

                                                                            -
                                                                            -

                                                                            - __construct() - -

                                                                            - - - - - public - __construct(ContaoFrameworkInterface $framework, ModelUtil $modelUtil) : mixed - -
                                                                            - -
                                                                            Parameters
                                                                            -
                                                                            -
                                                                            - $framework - : ContaoFrameworkInterface -
                                                                            -
                                                                            -
                                                                            - -
                                                                            -
                                                                            - $modelUtil - : ModelUtil -
                                                                            -
                                                                            -
                                                                            - -
                                                                            -
                                                                            - - - -
                                                                            Return values
                                                                            - mixed - — - - -
                                                                            -
                                                                            -

                                                                            - addHomeDir() - -

                                                                            - - -

                                                                            Adds a new home dir to a member. Therefore a folder named with the members's id is created in $varRootFolder.

                                                                            - - - public - static addHomeDir( $member[,  $booleanProperty = 'assignDir' ][,  $propertyName = 'homeDir' ][,  $rootFolder = 'files/members' ][, bool|false $overwrite = false ]) : bool|string - - -
                                                                            Parameters
                                                                            -
                                                                            -
                                                                            - $member - : -
                                                                            -
                                                                            -

                                                                            MemberModel|int The member as object or member id

                                                                            -
                                                                            - -
                                                                            -
                                                                            - $booleanProperty - : - = 'assignDir'
                                                                            -
                                                                            -

                                                                            string The name of the boolean member property (e.g. "assignDir")

                                                                            -
                                                                            - -
                                                                            -
                                                                            - $propertyName - : - = 'homeDir'
                                                                            -
                                                                            -

                                                                            string The name of the member property (e.g. "homeDir")

                                                                            -
                                                                            - -
                                                                            -
                                                                            - $rootFolder - : - = 'files/members'
                                                                            -
                                                                            -

                                                                            string|object The base folder as instance of \FilesModel, path string or uuid

                                                                            -
                                                                            - -
                                                                            -
                                                                            - $overwrite - : bool|false - = false
                                                                            -
                                                                            -

                                                                            bool Determines if an existing folder can be overridden

                                                                            -
                                                                            - -
                                                                            -
                                                                            - - - -
                                                                            Return values
                                                                            - bool|string - — -

                                                                            returns true, if a directory has already been linked with the member, the folders uuid if successfully added and false if -errors occurred

                                                                            -
                                                                            - - -
                                                                            -
                                                                            -

                                                                            - findActiveByGroups() - -

                                                                            - - -

                                                                            Find active members by member group.

                                                                            - - - public - findActiveByGroups(array<string|int, mixed> $groups[, array<string|int, mixed> $options = [] ]) : MemberModel|array<string|int, MemberModel>|Collection|null - -

                                                                            Options (pass via options array):

                                                                            -
                                                                              -
                                                                            • ignoreLogin: (bool) Ignore login field when check for active state. Default: false
                                                                              • -
                                                                            -
                                                                            - -
                                                                            Parameters
                                                                            -
                                                                            -
                                                                            - $groups - : array<string|int, mixed> -
                                                                            -
                                                                            -
                                                                            - -
                                                                            -
                                                                            - $options - : array<string|int, mixed> - = []
                                                                            -
                                                                            -
                                                                            - -
                                                                            -
                                                                            - - - -
                                                                            Return values
                                                                            - MemberModel|array<string|int, MemberModel>|Collection|null - — - - -
                                                                            -
                                                                            -

                                                                            - findOrCreate() - -

                                                                            - - - - - public - findOrCreate(string $email) : mixed - -
                                                                            - -
                                                                            Parameters
                                                                            -
                                                                            -
                                                                            - $email - : string -
                                                                            -
                                                                            -
                                                                            - -
                                                                            -
                                                                            - - - -
                                                                            Return values
                                                                            - mixed - — - - -
                                                                            -
                                                                            -

                                                                            - getHomeDir() - -

                                                                            - - -

                                                                            Returns a member home dir and creates one, if desired.

                                                                            - - - public - static getHomeDir( $member[,  $booleanProperty = 'assignDir' ][,  $propertyName = 'homeDir' ][,  $rootFolder = 'files/members' ][, bool|false $overwrite = false ]) : bool|string - - -
                                                                            Parameters
                                                                            -
                                                                            -
                                                                            - $member - : -
                                                                            -
                                                                            -

                                                                            MemberModel|int The member as object or member id

                                                                            -
                                                                            - -
                                                                            -
                                                                            - $booleanProperty - : - = 'assignDir'
                                                                            -
                                                                            -

                                                                            string The name of the boolean member property (e.g. "assignDir")

                                                                            -
                                                                            - -
                                                                            -
                                                                            - $propertyName - : - = 'homeDir'
                                                                            -
                                                                            -

                                                                            string The name of the member property (e.g. "homeDir")

                                                                            -
                                                                            - -
                                                                            -
                                                                            - $rootFolder - : - = 'files/members'
                                                                            -
                                                                            -

                                                                            string|FilesModel The base folder as instance of FilesModel, path string or uuid

                                                                            -
                                                                            - -
                                                                            -
                                                                            - $overwrite - : bool|false - = false
                                                                            -
                                                                            -

                                                                            bool Determines if an existing folder can be overridden

                                                                            -
                                                                            - -
                                                                            -
                                                                            - - - -
                                                                            Return values
                                                                            - bool|string - — -

                                                                            returns the home dir or false if an error occurred

                                                                            -
                                                                            - - -
                                                                            -
                                                                            - - - - -
                                                                            -
                                                                            -
                                                                            -
                                                                            -

                                                                            Search results

                                                                            - -
                                                                            -
                                                                            -
                                                                              -
                                                                              -
                                                                              -
                                                                              -
                                                                              -
                                                                              - - -
                                                                              - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Model-CfgTagModel.html b/classes/HeimrichHannot-UtilsBundle-Model-CfgTagModel.html deleted file mode 100644 index 3da0fad0..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Model-CfgTagModel.html +++ /dev/null @@ -1,391 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                              -

                                                                              Contao Utils Bundle

                                                                              - - -
                                                                              - -
                                                                              - - -
                                                                              - -
                                                                              -
                                                                              - - - - -
                                                                              - - -
                                                                              -

                                                                              - CfgTagModel - - - extends TagModelBase - - -
                                                                              - in package - -
                                                                              - - -

                                                                              - - - - -
                                                                              - - - - - - - - -

                                                                              - Table of Contents - -

                                                                              - -
                                                                              -
                                                                              - $strTable - -  : mixed -
                                                                              -
                                                                              - -
                                                                              - findAllBySource() - -  : Collection|static|null -
                                                                              -
                                                                              - -
                                                                              - getSourcesAsOptions() - -  : mixed -
                                                                              -
                                                                              - -
                                                                              - - - - - - -
                                                                              -

                                                                              - Properties - -

                                                                              -
                                                                              -

                                                                              - $strTable - - - -

                                                                              - - - - - protected - static mixed - $strTable - = 'tl_cfg_tag' - -
                                                                              - -
                                                                              - - - -
                                                                              -
                                                                              - -
                                                                              -

                                                                              - Methods - -

                                                                              -
                                                                              -

                                                                              - findAllBySource() - -

                                                                              - - - - - public - findAllBySource( $source[, array<string|int, mixed> $arrOptions = [] ]) : Collection|static|null - - -
                                                                              Parameters
                                                                              -
                                                                              -
                                                                              - $source - : -
                                                                              -
                                                                              - -
                                                                              -
                                                                              - $arrOptions - : array<string|int, mixed> - = []
                                                                              -
                                                                              -
                                                                              - -
                                                                              -
                                                                              - - - -
                                                                              Return values
                                                                              - Collection|static|null - — - - -
                                                                              -
                                                                              -

                                                                              - getSourcesAsOptions() - -

                                                                              - - - - - public - static getSourcesAsOptions(DataContainer $dc) : mixed - -
                                                                              - -
                                                                              Parameters
                                                                              -
                                                                              -
                                                                              - $dc - : DataContainer -
                                                                              -
                                                                              -
                                                                              - -
                                                                              -
                                                                              - - - -
                                                                              Return values
                                                                              - mixed - — - - -
                                                                              -
                                                                              - - - - -
                                                                              -
                                                                              -
                                                                              -
                                                                              -

                                                                              Search results

                                                                              - -
                                                                              -
                                                                              -
                                                                                -
                                                                                -
                                                                                -
                                                                                -
                                                                                -
                                                                                - - -
                                                                                - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Model-ModelUtil.html b/classes/HeimrichHannot-UtilsBundle-Model-ModelUtil.html deleted file mode 100644 index e818df1e..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Model-ModelUtil.html +++ /dev/null @@ -1,2108 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                -

                                                                                Contao Utils Bundle

                                                                                - - -
                                                                                - -
                                                                                - - -
                                                                                - -
                                                                                -
                                                                                - - - - -
                                                                                - - -
                                                                                -

                                                                                - ModelUtil - - -
                                                                                - in package - -
                                                                                - - -

                                                                                - - - - -
                                                                                - - - - - - - - -

                                                                                - Table of Contents - -

                                                                                - -
                                                                                -
                                                                                - $dcaUtil - -  : DcaUtil -
                                                                                -
                                                                                - -
                                                                                - $formUtil - -  : FormUtil -
                                                                                -
                                                                                - -
                                                                                - $framework - -  : ContaoFrameworkInterface -
                                                                                -
                                                                                - -
                                                                                - $kernelBundles - -  : array<string|int, mixed> -
                                                                                -
                                                                                - -
                                                                                - $requestStack - -  : RequestStack -
                                                                                -
                                                                                - -
                                                                                - $session - -  : SessionInterface -
                                                                                -
                                                                                - -
                                                                                - __construct() - -  : mixed -
                                                                                -
                                                                                - -
                                                                                - addPublishedCheckToModelArrays() - -  : mixed -
                                                                                -
                                                                                - -
                                                                                - callModelMethod() - -  : mixed -
                                                                                -
                                                                                - -
                                                                                - computeStringPattern() - -  : mixed -
                                                                                -
                                                                                - -
                                                                                - findAllModelInstances() - -  : Collection|null -
                                                                                -
                                                                                Find all model instances for a given table.
                                                                                - -
                                                                                - findModelInstanceByIdOrAlias() - -  : mixed -
                                                                                -
                                                                                Returns multiple model instances by given table and id or alias.
                                                                                - -
                                                                                - findModelInstanceByPk() - -  : mixed -
                                                                                -
                                                                                Returns a model instance if for a given table and id(primary key).
                                                                                - -
                                                                                - findModelInstancesBy() - -  : array<string|int, Model>|Collection|null -
                                                                                -
                                                                                Returns model instances by given table and search criteria.
                                                                                - -
                                                                                - findModulePages() - -  : array<string|int, mixed>|Collection|PageModel|array<string|int, PageModel>|null -
                                                                                -
                                                                                Find module pages.
                                                                                - -
                                                                                - findMultipleModelInstancesByIds() - -  : mixed -
                                                                                -
                                                                                Returns multiple model instances by given table and ids.
                                                                                - -
                                                                                - findOneModelInstanceBy() - -  : mixed -
                                                                                -
                                                                                Return a single model instance by table and search criteria.
                                                                                - -
                                                                                - findParentsRecursively() - -  : array<string|int, mixed> -
                                                                                -
                                                                                Returns an array of a model instance's parents in ascending order, i.e. the root parent comes first.
                                                                                - -
                                                                                - findRootParentRecursively() - -  : Model -
                                                                                -
                                                                                Recursively finds the root parent.
                                                                                - -
                                                                                - fixTablePrefixForDcMultilingual() - -  : array<string|int, mixed>|mixed -
                                                                                -
                                                                                Fixes existing table prefixed already aliased in MultilingualQueryBuilder::buildQueryBuilderForFind().
                                                                                - -
                                                                                - getCurrentDcMultilingualLanguage() - -  : bool|mixed -
                                                                                -
                                                                                Get the current dc_multilingual language even DC_Multilingual::edit() didn't run.
                                                                                - -
                                                                                - getDcMultilingualRootPageLanguages() - -  : array<string|int, mixed> -
                                                                                -
                                                                                Get the list of languages based on root pages.
                                                                                - -
                                                                                - getDcMultilingualTranslatableLanguages() - -  : mixed -
                                                                                -
                                                                                - -
                                                                                - getDcMultilingualTranslationRecord() - -  : mixed -
                                                                                -
                                                                                - -
                                                                                - getModelInstanceFieldValue() - -  : mixed|null -
                                                                                -
                                                                                Get model instance value for given field.
                                                                                - -
                                                                                - getModelInstanceIfId() - -  : Model|mixed -
                                                                                -
                                                                                - -
                                                                                - hasValueChanged() - -  : bool -
                                                                                -
                                                                                Determine if given value is newer than DataContainer value.
                                                                                - -
                                                                                - setDefaultsFromDca() - -  : Model -
                                                                                -
                                                                                Set the entity defaults from dca config (for new model entry).
                                                                                - -
                                                                                - - - - - - -
                                                                                -

                                                                                - Properties - -

                                                                                -
                                                                                -

                                                                                - $dcaUtil - - - -

                                                                                - - - - - protected - DcaUtil - $dcaUtil - - - - - - -
                                                                                -
                                                                                -

                                                                                - $formUtil - - - -

                                                                                - - - - - protected - FormUtil - $formUtil - - - - - - -
                                                                                -
                                                                                -

                                                                                - $framework - - - -

                                                                                - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
                                                                                -
                                                                                -

                                                                                - $kernelBundles - - - -

                                                                                - - - - - protected - array<string|int, mixed> - $kernelBundles - - - - - - -
                                                                                -
                                                                                -

                                                                                - $requestStack - - - -

                                                                                - - - - - protected - RequestStack - $requestStack - - - - - - -
                                                                                -
                                                                                -

                                                                                - $session - - - -

                                                                                - - - - - protected - SessionInterface - $session - - - - - - -
                                                                                -
                                                                                - -
                                                                                -

                                                                                - Methods - -

                                                                                -
                                                                                -

                                                                                - __construct() - -

                                                                                - - - - - public - __construct(DcaUtil $dcaUtil, ContaoFrameworkInterface $contaoFramework, SessionInterface $session, RequestStack $requestStack, FormUtil $formUtil, array<string|int, mixed> $kernelBundles) : mixed - -
                                                                                - -
                                                                                Parameters
                                                                                -
                                                                                -
                                                                                - $dcaUtil - : DcaUtil -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $contaoFramework - : ContaoFrameworkInterface -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $session - : SessionInterface -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $requestStack - : RequestStack -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $formUtil - : FormUtil -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $kernelBundles - : array<string|int, mixed> -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - - - -
                                                                                Return values
                                                                                - mixed - — - - -
                                                                                -
                                                                                -

                                                                                - addPublishedCheckToModelArrays() - -

                                                                                - - - - - public - addPublishedCheckToModelArrays(string $table, string $publishedField, string $startField, string $stopField, array<string|int, mixed> &$columns[, array<string|int, mixed> $options = [] ]) : mixed - - -
                                                                                Parameters
                                                                                -
                                                                                -
                                                                                - $table - : string -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $publishedField - : string -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $startField - : string -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $stopField - : string -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $columns - : array<string|int, mixed> -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $options - : array<string|int, mixed> - = []
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - - -
                                                                                - Tags - -
                                                                                -
                                                                                -
                                                                                - deprecated -
                                                                                -
                                                                                - -

                                                                                Use Utils service instead

                                                                                -
                                                                                - -
                                                                                -
                                                                                - codeCoverageIgnore -
                                                                                -
                                                                                - - -
                                                                                -
                                                                                - -
                                                                                Return values
                                                                                - mixed - — - - -
                                                                                -
                                                                                -

                                                                                - callModelMethod() - -

                                                                                - - - - - public - callModelMethod(string $table, string $method, mixed ...$args) : mixed - -
                                                                                - -
                                                                                Parameters
                                                                                -
                                                                                -
                                                                                - $table - : string -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $method - : string -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $args - : mixed -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - - - -
                                                                                Return values
                                                                                - mixed - — - - -
                                                                                -
                                                                                -

                                                                                - computeStringPattern() - -

                                                                                - - - - - public - computeStringPattern(string $pattern, Model|object $instance, string $table[, array<string|int, mixed> $specialValueConfig = [] ]) : mixed - - -
                                                                                Parameters
                                                                                -
                                                                                -
                                                                                - $pattern - : string -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $instance - : Model|object -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $table - : string -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $specialValueConfig - : array<string|int, mixed> - = []
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - - - -
                                                                                Return values
                                                                                - mixed - — - - -
                                                                                -
                                                                                -

                                                                                - findAllModelInstances() - -

                                                                                - - -

                                                                                Find all model instances for a given table.

                                                                                - - - public - findAllModelInstances(string $table[, array<string|int, mixed> $arrOptions = [] ]) : Collection|null - - -
                                                                                Parameters
                                                                                -
                                                                                -
                                                                                - $table - : string -
                                                                                -
                                                                                -

                                                                                The table name

                                                                                -
                                                                                - -
                                                                                -
                                                                                - $arrOptions - : array<string|int, mixed> - = []
                                                                                -
                                                                                -

                                                                                Additional query options

                                                                                -
                                                                                - -
                                                                                -
                                                                                - - - -
                                                                                Return values
                                                                                - Collection|null - — - - -
                                                                                -
                                                                                -

                                                                                - findModelInstanceByIdOrAlias() - -

                                                                                - - -

                                                                                Returns multiple model instances by given table and id or alias.

                                                                                - - - public - findModelInstanceByIdOrAlias(string $table, mixed $idOrAlias[, array<string|int, mixed> $options = [] ]) : mixed - - -
                                                                                Parameters
                                                                                -
                                                                                -
                                                                                - $table - : string -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $idOrAlias - : mixed -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $options - : array<string|int, mixed> - = []
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - - -
                                                                                - Tags - -
                                                                                -
                                                                                -
                                                                                - deprecated -
                                                                                -
                                                                                - -

                                                                                Use Utils service instead

                                                                                -
                                                                                - -
                                                                                -
                                                                                - codeCoverageIgnore -
                                                                                -
                                                                                - - -
                                                                                -
                                                                                - -
                                                                                Return values
                                                                                - mixed - — - - -
                                                                                -
                                                                                -

                                                                                - findModelInstanceByPk() - -

                                                                                - - -

                                                                                Returns a model instance if for a given table and id(primary key).

                                                                                - - - public - findModelInstanceByPk(string $table, mixed $pk[, array<string|int, mixed> $options = [] ]) : mixed - -

                                                                                Return null, if model type or model instance with given id not exist.

                                                                                -
                                                                                - -
                                                                                Parameters
                                                                                -
                                                                                -
                                                                                - $table - : string -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $pk - : mixed -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $options - : array<string|int, mixed> - = []
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - - -
                                                                                - Tags - -
                                                                                -
                                                                                -
                                                                                - deprecated -
                                                                                -
                                                                                - -

                                                                                Use Utils service instead

                                                                                -
                                                                                - -
                                                                                -
                                                                                - codeCoverageIgnore -
                                                                                -
                                                                                - - -
                                                                                -
                                                                                - -
                                                                                Return values
                                                                                - mixed - — - - -
                                                                                -
                                                                                -

                                                                                - findModelInstancesBy() - -

                                                                                - - -

                                                                                Returns model instances by given table and search criteria.

                                                                                - - - public - findModelInstancesBy(string $table, mixed $columns, mixed $values[, array<string|int, mixed> $options = [] ]) : array<string|int, Model>|Collection|null - - -
                                                                                Parameters
                                                                                -
                                                                                -
                                                                                - $table - : string -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $columns - : mixed -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $values - : mixed -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $options - : array<string|int, mixed> - = []
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - - -
                                                                                - Tags - -
                                                                                -
                                                                                -
                                                                                - deprecated -
                                                                                -
                                                                                - -

                                                                                Use Utils service instead

                                                                                -
                                                                                - -
                                                                                -
                                                                                - codeCoverageIgnore -
                                                                                -
                                                                                - - -
                                                                                -
                                                                                - -
                                                                                Return values
                                                                                - array<string|int, Model>|Collection|null - — - - -
                                                                                -
                                                                                -

                                                                                - findModulePages() - -

                                                                                - - -

                                                                                Find module pages.

                                                                                - - - public - findModulePages(ModuleModel $module[, bool $collection = false ][, bool $useCache = true ]) : array<string|int, mixed>|Collection|PageModel|array<string|int, PageModel>|null - -

                                                                                Returns page ids or models, where a frontend module is integrated

                                                                                -

                                                                                Also search within blocks (heimrichhannot/contao-blocks)

                                                                                -
                                                                                - -
                                                                                Parameters
                                                                                -
                                                                                -
                                                                                - $module - : ModuleModel -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $collection - : bool - = false
                                                                                -
                                                                                -

                                                                                Return PageModel Collection if true. Default: false

                                                                                -
                                                                                - -
                                                                                -
                                                                                - $useCache - : bool - = true
                                                                                -
                                                                                -

                                                                                If true, a filesystem cache will be used to save pages ids. Default: true

                                                                                -
                                                                                - -
                                                                                -
                                                                                - - - -
                                                                                Return values
                                                                                - array<string|int, mixed>|Collection|PageModel|array<string|int, PageModel>|null - — -

                                                                                An array of page Ids (can be empty if no page found!), a PageModel collection or null

                                                                                -
                                                                                - - -
                                                                                -
                                                                                -

                                                                                - findMultipleModelInstancesByIds() - -

                                                                                - - -

                                                                                Returns multiple model instances by given table and ids.

                                                                                - - - public - findMultipleModelInstancesByIds(string $table, array<string|int, mixed> $ids[, array<string|int, mixed> $options = [] ]) : mixed - - -
                                                                                Parameters
                                                                                -
                                                                                -
                                                                                - $table - : string -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $ids - : array<string|int, mixed> -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $options - : array<string|int, mixed> - = []
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - - -
                                                                                - Tags - -
                                                                                -
                                                                                -
                                                                                - deprecated -
                                                                                -
                                                                                - -

                                                                                Use Utils service instead

                                                                                -
                                                                                - -
                                                                                -
                                                                                - codeCoverageIgnore -
                                                                                -
                                                                                - - -
                                                                                -
                                                                                - -
                                                                                Return values
                                                                                - mixed - — - - -
                                                                                -
                                                                                -

                                                                                - findOneModelInstanceBy() - -

                                                                                - - -

                                                                                Return a single model instance by table and search criteria.

                                                                                - - - public - findOneModelInstanceBy(string $table, array<string|int, mixed> $columns, array<string|int, mixed> $values[, array<string|int, mixed> $options = [] ]) : mixed - - -
                                                                                Parameters
                                                                                -
                                                                                -
                                                                                - $table - : string -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $columns - : array<string|int, mixed> -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $values - : array<string|int, mixed> -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $options - : array<string|int, mixed> - = []
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - - -
                                                                                - Tags - -
                                                                                -
                                                                                -
                                                                                - deprecated -
                                                                                -
                                                                                - -

                                                                                Use Utils service instead

                                                                                -
                                                                                - -
                                                                                -
                                                                                - codeCoverageIgnore -
                                                                                -
                                                                                - - -
                                                                                -
                                                                                - -
                                                                                Return values
                                                                                - mixed - — - - -
                                                                                -
                                                                                -

                                                                                - findParentsRecursively() - -

                                                                                - - -

                                                                                Returns an array of a model instance's parents in ascending order, i.e. the root parent comes first.

                                                                                - - - public - findParentsRecursively(string $parentProperty, string $table, Model $instance) : array<string|int, mixed> - - -
                                                                                Parameters
                                                                                -
                                                                                -
                                                                                - $parentProperty - : string -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $table - : string -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $instance - : Model -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - - -
                                                                                - Tags - -
                                                                                -
                                                                                -
                                                                                - deprecated -
                                                                                -
                                                                                - -

                                                                                Use Utils service instead

                                                                                -
                                                                                - -
                                                                                -
                                                                                - -
                                                                                Return values
                                                                                - array<string|int, mixed> - — - - -
                                                                                -
                                                                                -

                                                                                - findRootParentRecursively() - -

                                                                                - - -

                                                                                Recursively finds the root parent.

                                                                                - - - public - findRootParentRecursively(string $parentProperty, string $table, Model $instance[, bool $returnInstanceIfNoParent = true ]) : Model - - -
                                                                                Parameters
                                                                                -
                                                                                -
                                                                                - $parentProperty - : string -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $table - : string -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $instance - : Model -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $returnInstanceIfNoParent - : bool - = true
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - - - -
                                                                                Return values
                                                                                - Model - — - - -
                                                                                -
                                                                                -

                                                                                - fixTablePrefixForDcMultilingual() - -

                                                                                - - -

                                                                                Fixes existing table prefixed already aliased in MultilingualQueryBuilder::buildQueryBuilderForFind().

                                                                                - - - public - fixTablePrefixForDcMultilingual(string $table,  &$columns[, array<string|int, mixed> &$options = [] ]) : array<string|int, mixed>|mixed - - -
                                                                                Parameters
                                                                                -
                                                                                -
                                                                                - $table - : string -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $columns - : -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $options - : array<string|int, mixed> - = []
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - - - -
                                                                                Return values
                                                                                - array<string|int, mixed>|mixed - — - - -
                                                                                -
                                                                                -

                                                                                - getCurrentDcMultilingualLanguage() - -

                                                                                - - -

                                                                                Get the current dc_multilingual language even DC_Multilingual::edit() didn't run.

                                                                                - - - public - getCurrentDcMultilingualLanguage(string $table, int $id) : bool|mixed - -

                                                                                This can be used in onload_callbacks for example since here DC_Multilingual::edit() didn't run, yet.

                                                                                -
                                                                                - -
                                                                                Parameters
                                                                                -
                                                                                -
                                                                                - $table - : string -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $id - : int -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - - - -
                                                                                Return values
                                                                                - bool|mixed - — - - -
                                                                                -
                                                                                -

                                                                                - getDcMultilingualRootPageLanguages() - -

                                                                                - - -

                                                                                Get the list of languages based on root pages.

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

                                                                                - getDcMultilingualTranslatableLanguages() - -

                                                                                - - - - - public - getDcMultilingualTranslatableLanguages(string $table) : mixed - -
                                                                                - -
                                                                                Parameters
                                                                                -
                                                                                -
                                                                                - $table - : string -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - - - -
                                                                                Return values
                                                                                - mixed - — - - -
                                                                                -
                                                                                -

                                                                                - getDcMultilingualTranslationRecord() - -

                                                                                - - - - - public - getDcMultilingualTranslationRecord(mixed $table, mixed $id[, mixed $language = null ]) : mixed - -
                                                                                - -
                                                                                Parameters
                                                                                -
                                                                                -
                                                                                - $table - : mixed -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $id - : mixed -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $language - : mixed - = null
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - - - -
                                                                                Return values
                                                                                - mixed - — - - -
                                                                                -
                                                                                -

                                                                                - getModelInstanceFieldValue() - -

                                                                                - - -

                                                                                Get model instance value for given field.

                                                                                - - - public - getModelInstanceFieldValue(string $field, string $table, int $id) : mixed|null - - -
                                                                                Parameters
                                                                                -
                                                                                -
                                                                                - $field - : string -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $table - : string -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $id - : int -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - - - -
                                                                                Return values
                                                                                - mixed|null - — - - -
                                                                                -
                                                                                -

                                                                                - getModelInstanceIfId() - -

                                                                                - - - - - public - getModelInstanceIfId( $instance,  $table) : Model|mixed - - -
                                                                                Parameters
                                                                                -
                                                                                -
                                                                                - $instance - : -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $table - : -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - - - -
                                                                                Return values
                                                                                - Model|mixed - — - - -
                                                                                -
                                                                                -

                                                                                - hasValueChanged() - -

                                                                                - - -

                                                                                Determine if given value is newer than DataContainer value.

                                                                                - - - public - hasValueChanged(mixed $newValue, DataContainer $dc) : bool - - -
                                                                                Parameters
                                                                                -
                                                                                -
                                                                                - $newValue - : mixed -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - $dc - : DataContainer -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - - - -
                                                                                Return values
                                                                                - bool - — - - -
                                                                                -
                                                                                -

                                                                                - setDefaultsFromDca() - -

                                                                                - - -

                                                                                Set the entity defaults from dca config (for new model entry).

                                                                                - - - public - setDefaultsFromDca(Model $objModel) : Model - - -
                                                                                Parameters
                                                                                -
                                                                                -
                                                                                - $objModel - : Model -
                                                                                -
                                                                                -
                                                                                - -
                                                                                -
                                                                                - - -
                                                                                - Tags - -
                                                                                -
                                                                                -
                                                                                - deprecated -
                                                                                -
                                                                                - -

                                                                                Use DcaUtil::setDefaultsFromDca instead

                                                                                -
                                                                                - -
                                                                                -
                                                                                - codeCoverageIgnore -
                                                                                -
                                                                                - - -
                                                                                -
                                                                                - -
                                                                                Return values
                                                                                - Model - — -

                                                                                The modified model, containing the default values from all dca fields

                                                                                -
                                                                                - - -
                                                                                -
                                                                                - - - - -
                                                                                -
                                                                                -
                                                                                -
                                                                                -

                                                                                Search results

                                                                                - -
                                                                                -
                                                                                -
                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  - - -
                                                                                  - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Model-TagModelBase.html b/classes/HeimrichHannot-UtilsBundle-Model-TagModelBase.html deleted file mode 100644 index 3041a8b4..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Model-TagModelBase.html +++ /dev/null @@ -1,223 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                  -

                                                                                  Contao Utils Bundle

                                                                                  - - -
                                                                                  - -
                                                                                  - - -
                                                                                  - -
                                                                                  -
                                                                                  - - - - -
                                                                                  - - -
                                                                                  -

                                                                                  - TagModelBase - - - extends Model - - -
                                                                                  - in package - -
                                                                                  - - -

                                                                                  - - - - -
                                                                                  - - - - - - - - - - - - - - - - - - - -
                                                                                  -
                                                                                  -
                                                                                  -
                                                                                  -

                                                                                  Search results

                                                                                  - -
                                                                                  -
                                                                                  -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    - - -
                                                                                    - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Module-ModuleUtil.html b/classes/HeimrichHannot-UtilsBundle-Module-ModuleUtil.html deleted file mode 100644 index 05f230b9..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Module-ModuleUtil.html +++ /dev/null @@ -1,562 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                    -

                                                                                    Contao Utils Bundle

                                                                                    - - -
                                                                                    - -
                                                                                    - - -
                                                                                    - -
                                                                                    -
                                                                                    - - - - -
                                                                                    - - -
                                                                                    -

                                                                                    - ModuleUtil - - -
                                                                                    - in package - -
                                                                                    - - -

                                                                                    - - - - -
                                                                                    - - - - - - - - -

                                                                                    - Table of Contents - -

                                                                                    - -
                                                                                    -
                                                                                    - $framework - -  : ContaoFrameworkInterface -
                                                                                    -
                                                                                    - -
                                                                                    - __construct() - -  : mixed -
                                                                                    -
                                                                                    - -
                                                                                    - getClassByModule() - -  : bool -
                                                                                    -
                                                                                    Get the class name of a given module.
                                                                                    - -
                                                                                    - getModuleClass() - -  : string -
                                                                                    -
                                                                                    Get the full qualified class name for a given module.
                                                                                    - -
                                                                                    - getModulesByType() - -  : Collection -
                                                                                    -
                                                                                    - -
                                                                                    - isSubModuleOf() - -  : bool -
                                                                                    -
                                                                                    Check whether a module is a sub module of another.
                                                                                    - -
                                                                                    - - - - - - -
                                                                                    -

                                                                                    - Properties - -

                                                                                    -
                                                                                    -

                                                                                    - $framework - - - -

                                                                                    - - - - - private - ContaoFrameworkInterface - $framework - - - - - - -
                                                                                    -
                                                                                    - -
                                                                                    -

                                                                                    - Methods - -

                                                                                    -
                                                                                    -

                                                                                    - __construct() - -

                                                                                    - - - - - public - __construct(ContaoFrameworkInterface $framework) : mixed - -
                                                                                    - -
                                                                                    Parameters
                                                                                    -
                                                                                    -
                                                                                    - $framework - : ContaoFrameworkInterface -
                                                                                    -
                                                                                    -
                                                                                    - -
                                                                                    -
                                                                                    - - - -
                                                                                    Return values
                                                                                    - mixed - — - - -
                                                                                    -
                                                                                    -

                                                                                    - getClassByModule() - -

                                                                                    - - -

                                                                                    Get the class name of a given module.

                                                                                    - - - public - getClassByModule(mixed $module) : bool - - -
                                                                                    Parameters
                                                                                    -
                                                                                    -
                                                                                    - $module - : mixed -
                                                                                    -
                                                                                    -

                                                                                    Module as module type string, module model object or module object

                                                                                    -
                                                                                    - -
                                                                                    -
                                                                                    - - - -
                                                                                    Return values
                                                                                    - bool - — - - -
                                                                                    -
                                                                                    -

                                                                                    - getModuleClass() - -

                                                                                    - - -

                                                                                    Get the full qualified class name for a given module.

                                                                                    - - - public - getModuleClass(ModuleModel|Module|string $module) : string - - -
                                                                                    Parameters
                                                                                    -
                                                                                    -
                                                                                    - $module - : ModuleModel|Module|string -
                                                                                    -
                                                                                    -

                                                                                    a module object, a module model object, a full qualified model class name or model type

                                                                                    -
                                                                                    - -
                                                                                    -
                                                                                    - - - -
                                                                                    Return values
                                                                                    - string - — - - -
                                                                                    -
                                                                                    -

                                                                                    - getModulesByType() - -

                                                                                    - - - - - public - getModulesByType(string $type[, array<string|int, mixed> $options = [] ]) : Collection - -
                                                                                    - -
                                                                                    Parameters
                                                                                    -
                                                                                    -
                                                                                    - $type - : string -
                                                                                    -
                                                                                    -
                                                                                    - -
                                                                                    -
                                                                                    - $options - : array<string|int, mixed> - = []
                                                                                    -
                                                                                    -
                                                                                    - -
                                                                                    -
                                                                                    - - - -
                                                                                    Return values
                                                                                    - Collection - — - - -
                                                                                    -
                                                                                    -

                                                                                    - isSubModuleOf() - -

                                                                                    - - -

                                                                                    Check whether a module is a sub module of another.

                                                                                    - - - public - isSubModuleOf(mixed $module1, mixed $module2[, bool $trueIfSame = false ]) : bool - - -
                                                                                    Parameters
                                                                                    -
                                                                                    -
                                                                                    - $module1 - : mixed -
                                                                                    -
                                                                                    -

                                                                                    First module as class string, module type string, module model object or module object

                                                                                    -
                                                                                    - -
                                                                                    -
                                                                                    - $module2 - : mixed -
                                                                                    -
                                                                                    -

                                                                                    Second module as class string, module type string, module model object or module object

                                                                                    -
                                                                                    - -
                                                                                    -
                                                                                    - $trueIfSame - : bool - = false
                                                                                    -
                                                                                    -

                                                                                    Return true if $module1 and $module2 are the same

                                                                                    -
                                                                                    - -
                                                                                    -
                                                                                    - - - -
                                                                                    Return values
                                                                                    - bool - — - - -
                                                                                    -
                                                                                    - - - - -
                                                                                    -
                                                                                    -
                                                                                    -
                                                                                    -

                                                                                    Search results

                                                                                    - -
                                                                                    -
                                                                                    -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      - - -
                                                                                      - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Page-PageUtil.html b/classes/HeimrichHannot-UtilsBundle-Page-PageUtil.html deleted file mode 100644 index 86e71b82..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Page-PageUtil.html +++ /dev/null @@ -1,512 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                      -

                                                                                      Contao Utils Bundle

                                                                                      - - -
                                                                                      - -
                                                                                      - - -
                                                                                      - -
                                                                                      -
                                                                                      - - - - -
                                                                                      - - -
                                                                                      -

                                                                                      - PageUtil - - -
                                                                                      - in package - -
                                                                                      - - -

                                                                                      - - - - -
                                                                                      - - - - - - - - -

                                                                                      - Table of Contents - -

                                                                                      - -
                                                                                      -
                                                                                      - PAGE_MODEL_TYPE_ROOT - -  = 'root' -
                                                                                      -
                                                                                      - -
                                                                                      - $framework - -  : ContaoFrameworkInterface -
                                                                                      -
                                                                                      - -
                                                                                      - $container - -  : ContainerInterface -
                                                                                      -
                                                                                      - -
                                                                                      - __construct() - -  : mixed -
                                                                                      -
                                                                                      - -
                                                                                      - retrieveGlobalPageFromCurrentPageId() - -  : PageModel|null -
                                                                                      -
                                                                                      - -
                                                                                      - setParametersFromLayout() - -  : void -
                                                                                      -
                                                                                      - -
                                                                                      - - - - -
                                                                                      -

                                                                                      - Constants - -

                                                                                      -
                                                                                      -

                                                                                      - PAGE_MODEL_TYPE_ROOT - -

                                                                                      - - - - - - public - mixed - PAGE_MODEL_TYPE_ROOT - = 'root' - - - -
                                                                                      - -
                                                                                      - - - -
                                                                                      -
                                                                                      - - -
                                                                                      -

                                                                                      - Properties - -

                                                                                      -
                                                                                      -

                                                                                      - $framework - - - -

                                                                                      - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
                                                                                      -
                                                                                      -

                                                                                      - $container - - - -

                                                                                      - - - - - private - ContainerInterface - $container - - - - - - -
                                                                                      -
                                                                                      - -
                                                                                      -

                                                                                      - Methods - -

                                                                                      -
                                                                                      -

                                                                                      - __construct() - -

                                                                                      - - - - - public - __construct(ContainerInterface $container) : mixed - -
                                                                                      - -
                                                                                      Parameters
                                                                                      -
                                                                                      -
                                                                                      - $container - : ContainerInterface -
                                                                                      -
                                                                                      -
                                                                                      - -
                                                                                      -
                                                                                      - - - -
                                                                                      Return values
                                                                                      - mixed - — - - -
                                                                                      -
                                                                                      -

                                                                                      - retrieveGlobalPageFromCurrentPageId() - -

                                                                                      - - - - - public - retrieveGlobalPageFromCurrentPageId(int $id) : PageModel|null - -
                                                                                      - -
                                                                                      Parameters
                                                                                      -
                                                                                      -
                                                                                      - $id - : int -
                                                                                      -
                                                                                      -
                                                                                      - -
                                                                                      -
                                                                                      - - - -
                                                                                      Return values
                                                                                      - PageModel|null - — - - -
                                                                                      -
                                                                                      -

                                                                                      - setParametersFromLayout() - -

                                                                                      - - - - - protected - setParametersFromLayout(PageModel &$page) : void - -
                                                                                      - -
                                                                                      Parameters
                                                                                      -
                                                                                      -
                                                                                      - $page - : PageModel -
                                                                                      -
                                                                                      -
                                                                                      - -
                                                                                      -
                                                                                      - - - -
                                                                                      Return values
                                                                                      - void - — - - -
                                                                                      -
                                                                                      - - - - -
                                                                                      -
                                                                                      -
                                                                                      -
                                                                                      -

                                                                                      Search results

                                                                                      - -
                                                                                      -
                                                                                      -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        - - -
                                                                                        - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Pagination-TextualPagination.html b/classes/HeimrichHannot-UtilsBundle-Pagination-TextualPagination.html deleted file mode 100644 index ba8c0d89..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Pagination-TextualPagination.html +++ /dev/null @@ -1,476 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                        -

                                                                                        Contao Utils Bundle

                                                                                        - - -
                                                                                        - -
                                                                                        - - -
                                                                                        - -
                                                                                        -
                                                                                        - - - - -
                                                                                        - - -
                                                                                        -

                                                                                        - TextualPagination - - - extends Pagination - - -
                                                                                        - in package - -
                                                                                        - - -

                                                                                        - - - - -
                                                                                        - - - - - - - - -

                                                                                        - Table of Contents - -

                                                                                        - -
                                                                                        -
                                                                                        - $singlePageUrl - -  : string -
                                                                                        -
                                                                                        - -
                                                                                        - $teasers - -  : array<string|int, mixed> -
                                                                                        -
                                                                                        - -
                                                                                        - __construct() - -  : mixed -
                                                                                        -
                                                                                        Set the number of rows, the number of results per pages and the number of links.
                                                                                        - -
                                                                                        - getItemsAsArray() - -  : array<string|int, mixed> -
                                                                                        -
                                                                                        Generate all page links and return them as array.
                                                                                        - -
                                                                                        - - - - - - -
                                                                                        -

                                                                                        - Properties - -

                                                                                        -
                                                                                        -

                                                                                        - $singlePageUrl - - - -

                                                                                        - - - - - protected - string - $singlePageUrl - - - - - - -
                                                                                        -
                                                                                        -

                                                                                        - $teasers - - - -

                                                                                        - - - - - protected - array<string|int, mixed> - $teasers - = [] - - - - - -
                                                                                        -
                                                                                        - -
                                                                                        -

                                                                                        - Methods - -

                                                                                        -
                                                                                        -

                                                                                        - __construct() - -

                                                                                        - - -

                                                                                        Set the number of rows, the number of results per pages and the number of links.

                                                                                        - - - public - __construct(array<string|int, mixed> $teasers, string $singlePageUrl, int $intRows, int $intPerPage[, int $intNumberOfLinks = 7 ][, string $strParameter = 'page' ][, Template $objTemplate = null ][, bool $blnForceParam = false ]) : mixed - - -
                                                                                        Parameters
                                                                                        -
                                                                                        -
                                                                                        - $teasers - : array<string|int, mixed> -
                                                                                        -
                                                                                        -

                                                                                        The teasers for the pagination

                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - $singlePageUrl - : string -
                                                                                        -
                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - $intRows - : int -
                                                                                        -
                                                                                        -

                                                                                        The number of rows

                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - $intPerPage - : int -
                                                                                        -
                                                                                        -

                                                                                        The number of items per page

                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - $intNumberOfLinks - : int - = 7
                                                                                        -
                                                                                        -

                                                                                        The number of links to generate

                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - $strParameter - : string - = 'page'
                                                                                        -
                                                                                        -

                                                                                        The parameter name

                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - $objTemplate - : Template - = null
                                                                                        -
                                                                                        -

                                                                                        The template object

                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - $blnForceParam - : bool - = false
                                                                                        -
                                                                                        -

                                                                                        Force the URL parameter

                                                                                        -
                                                                                        - -
                                                                                        -
                                                                                        - - - -
                                                                                        Return values
                                                                                        - mixed - — - - -
                                                                                        -
                                                                                        -

                                                                                        - getItemsAsArray() - -

                                                                                        - - -

                                                                                        Generate all page links and return them as array.

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

                                                                                        The page links as array

                                                                                        -
                                                                                        - - -
                                                                                        -
                                                                                        - - - - -
                                                                                        -
                                                                                        -
                                                                                        -
                                                                                        -

                                                                                        Search results

                                                                                        - -
                                                                                        -
                                                                                        -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          - - -
                                                                                          - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Pdf-AbstractPdfWriter.html b/classes/HeimrichHannot-UtilsBundle-Pdf-AbstractPdfWriter.html deleted file mode 100644 index f8b52a9c..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Pdf-AbstractPdfWriter.html +++ /dev/null @@ -1,1326 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                          -

                                                                                          Contao Utils Bundle

                                                                                          - - -
                                                                                          - -
                                                                                          - - -
                                                                                          - -
                                                                                          -
                                                                                          - - - - -
                                                                                          - - -
                                                                                          -

                                                                                          - AbstractPdfWriter - - -
                                                                                          - in package - -
                                                                                          - - -

                                                                                          - - - -

                                                                                          Class AbstractPdfWriter.

                                                                                          - - - -
                                                                                          - Tags - -
                                                                                          -
                                                                                          -
                                                                                          - deprecated -
                                                                                          -
                                                                                          - -

                                                                                          Use PdfCreator instead

                                                                                          -
                                                                                          - -
                                                                                          -
                                                                                          - - - - - - -

                                                                                          - Table of Contents - -

                                                                                          - -
                                                                                          -
                                                                                          - OUTPUT_MODE_DOWNLOAD - -  = 'download' -
                                                                                          -
                                                                                          - -
                                                                                          - OUTPUT_MODE_FILE - -  = 'file' -
                                                                                          -
                                                                                          - -
                                                                                          - OUTPUT_MODE_INLINE - -  = 'inline' -
                                                                                          -
                                                                                          - -
                                                                                          - OUTPUT_MODES - -  = [self::OUTPUT_MODE_DOWNLOAD, self::OUTPUT_MODE_FILE, self::OUTPUT_MODE_INLINE] -
                                                                                          -
                                                                                          - -
                                                                                          - $config - -  : array<string|int, mixed> -
                                                                                          -
                                                                                          Pdf configuration.
                                                                                          - -
                                                                                          - $fileName - -  : string -
                                                                                          -
                                                                                          Pdf file name.
                                                                                          - -
                                                                                          - $folder - -  : string -
                                                                                          -
                                                                                          The folder in case of saving to file.
                                                                                          - -
                                                                                          - $html - -  : string -
                                                                                          -
                                                                                          Pdf html content including styles.
                                                                                          - -
                                                                                          - $isPrepared - -  : bool -
                                                                                          -
                                                                                          - -
                                                                                          - $pdf - -  : mixed -
                                                                                          -
                                                                                          - -
                                                                                          - __construct() - -  : mixed -
                                                                                          -
                                                                                          constructor.
                                                                                          - -
                                                                                          - generate() - -  : void -
                                                                                          -
                                                                                          Generate the pdf.
                                                                                          - -
                                                                                          - getConfig() - -  : array<string|int, mixed> -
                                                                                          -
                                                                                          Get the pdf config.
                                                                                          - -
                                                                                          - getFileName() - -  : string -
                                                                                          -
                                                                                          Get the pdf file name.
                                                                                          - -
                                                                                          - getFolder() - -  : string -
                                                                                          -
                                                                                          - -
                                                                                          - getHtml() - -  : string -
                                                                                          -
                                                                                          Get html including styles.
                                                                                          - -
                                                                                          - getPdf() - -  : mixed -
                                                                                          -
                                                                                          Get current pdf object.
                                                                                          - -
                                                                                          - isPrepared() - -  : bool -
                                                                                          -
                                                                                          Check if prepare was already triggered.
                                                                                          - -
                                                                                          - mergeConfig() - -  : PdfWriter -
                                                                                          -
                                                                                          Merge current pdf config with given.
                                                                                          - -
                                                                                          - prepare() - -  : mixed -
                                                                                          -
                                                                                          Prepare the current object.
                                                                                          - -
                                                                                          - setConfig() - -  : PdfWriter -
                                                                                          -
                                                                                          Set pdf config, replace default with custom config.
                                                                                          - -
                                                                                          - setDefaultConfig() - -  : mixed -
                                                                                          -
                                                                                          - -
                                                                                          - setFileName() - -  : PdfWriter -
                                                                                          -
                                                                                          Set the pdf filename.
                                                                                          - -
                                                                                          - setFolder() - -  : void -
                                                                                          -
                                                                                          - -
                                                                                          - setHtml() - -  : PdfWriter -
                                                                                          -
                                                                                          Set html including styles.
                                                                                          - -
                                                                                          - - - - -
                                                                                          -

                                                                                          - Constants - -

                                                                                          -
                                                                                          -

                                                                                          - OUTPUT_MODE_DOWNLOAD - -

                                                                                          - - - - - - public - mixed - OUTPUT_MODE_DOWNLOAD - = 'download' - - - -
                                                                                          - -
                                                                                          - - - -
                                                                                          -
                                                                                          -

                                                                                          - OUTPUT_MODE_FILE - -

                                                                                          - - - - - - public - mixed - OUTPUT_MODE_FILE - = 'file' - - - -
                                                                                          - -
                                                                                          - - - -
                                                                                          -
                                                                                          -

                                                                                          - OUTPUT_MODE_INLINE - -

                                                                                          - - - - - - public - mixed - OUTPUT_MODE_INLINE - = 'inline' - - - -
                                                                                          - -
                                                                                          - - - -
                                                                                          -
                                                                                          -

                                                                                          - OUTPUT_MODES - -

                                                                                          - - - - - - public - mixed - OUTPUT_MODES - = [self::OUTPUT_MODE_DOWNLOAD, self::OUTPUT_MODE_FILE, self::OUTPUT_MODE_INLINE] - - - -
                                                                                          - -
                                                                                          - - - -
                                                                                          -
                                                                                          - - -
                                                                                          -

                                                                                          - Properties - -

                                                                                          -
                                                                                          -

                                                                                          - $config - - - -

                                                                                          - - -

                                                                                          Pdf configuration.

                                                                                          - - - protected - array<string|int, mixed> - $config - = [] - - - - - -
                                                                                          -
                                                                                          -

                                                                                          - $fileName - - - -

                                                                                          - - -

                                                                                          Pdf file name.

                                                                                          - - - protected - string - $fileName - - - - - - -
                                                                                          -
                                                                                          -

                                                                                          - $folder - - - -

                                                                                          - - -

                                                                                          The folder in case of saving to file.

                                                                                          - - - protected - string - $folder - - - - - - -
                                                                                          -
                                                                                          -

                                                                                          - $html - - - -

                                                                                          - - -

                                                                                          Pdf html content including styles.

                                                                                          - - - protected - string - $html - - - - - - -
                                                                                          -
                                                                                          -

                                                                                          - $isPrepared - - - -

                                                                                          - - - - - protected - bool - $isPrepared - = false - - - - - -
                                                                                          -
                                                                                          -

                                                                                          - $pdf - - - -

                                                                                          - - - - - protected - mixed - $pdf - - - -

                                                                                          The pdf object

                                                                                          -
                                                                                          - - - -
                                                                                          -
                                                                                          - -
                                                                                          -

                                                                                          - Methods - -

                                                                                          -
                                                                                          -

                                                                                          - __construct() - -

                                                                                          - - -

                                                                                          constructor.

                                                                                          - - - public - __construct() : mixed - - - - - -
                                                                                          Return values
                                                                                          - mixed - — - - -
                                                                                          -
                                                                                          -

                                                                                          - generate() - -

                                                                                          - - -

                                                                                          Generate the pdf.

                                                                                          - - - public - abstract generate([string $mode = self::OUTPUT_MODE_DOWNLOAD ]) : void - - -
                                                                                          Parameters
                                                                                          -
                                                                                          -
                                                                                          - $mode - : string - = self::OUTPUT_MODE_DOWNLOAD
                                                                                          -
                                                                                          - -
                                                                                          -
                                                                                          - - - -
                                                                                          Return values
                                                                                          - void - — - - -
                                                                                          -
                                                                                          -

                                                                                          - getConfig() - -

                                                                                          - - -

                                                                                          Get the pdf config.

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

                                                                                          - getFileName() - -

                                                                                          - - -

                                                                                          Get the pdf file name.

                                                                                          - - - public - getFileName() : string - - - - - -
                                                                                          Return values
                                                                                          - string - — - - -
                                                                                          -
                                                                                          -

                                                                                          - getFolder() - -

                                                                                          - - - - - public - getFolder() : string - - - - - -
                                                                                          Return values
                                                                                          - string - — - - -
                                                                                          -
                                                                                          -

                                                                                          - getHtml() - -

                                                                                          - - -

                                                                                          Get html including styles.

                                                                                          - - - public - getHtml() : string - - - - - -
                                                                                          Return values
                                                                                          - string - — - - -
                                                                                          -
                                                                                          -

                                                                                          - getPdf() - -

                                                                                          - - -

                                                                                          Get current pdf object.

                                                                                          - - - public - abstract getPdf([bool $init = false ]) : mixed - - -
                                                                                          Parameters
                                                                                          -
                                                                                          -
                                                                                          - $init - : bool - = false
                                                                                          -
                                                                                          -

                                                                                          Set true if you want to create a new pdf regardless there is always an existing pdf

                                                                                          -
                                                                                          - -
                                                                                          -
                                                                                          - - - -
                                                                                          Return values
                                                                                          - mixed - — - - -
                                                                                          -
                                                                                          -

                                                                                          - isPrepared() - -

                                                                                          - - -

                                                                                          Check if prepare was already triggered.

                                                                                          - - - public - isPrepared() : bool - - - - - -
                                                                                          Return values
                                                                                          - bool - — - - -
                                                                                          -
                                                                                          -

                                                                                          - mergeConfig() - -

                                                                                          - - -

                                                                                          Merge current pdf config with given.

                                                                                          - - - public - mergeConfig(array<string|int, mixed> $config) : PdfWriter - - -
                                                                                          Parameters
                                                                                          -
                                                                                          -
                                                                                          - $config - : array<string|int, mixed> -
                                                                                          -
                                                                                          -
                                                                                          - -
                                                                                          -
                                                                                          - - - -
                                                                                          Return values
                                                                                          - PdfWriter - — -

                                                                                          Current pdf writer instance

                                                                                          -
                                                                                          - - -
                                                                                          -
                                                                                          -

                                                                                          - prepare() - -

                                                                                          - - -

                                                                                          Prepare the current object.

                                                                                          - - - public - prepare() : mixed - - - - - -
                                                                                          Return values
                                                                                          - mixed - — - - -
                                                                                          -
                                                                                          -

                                                                                          - setConfig() - -

                                                                                          - - -

                                                                                          Set pdf config, replace default with custom config.

                                                                                          - - - public - setConfig(array<string|int, mixed> $config) : PdfWriter - - -
                                                                                          Parameters
                                                                                          -
                                                                                          -
                                                                                          - $config - : array<string|int, mixed> -
                                                                                          -
                                                                                          -
                                                                                          - -
                                                                                          -
                                                                                          - - - -
                                                                                          Return values
                                                                                          - PdfWriter - — -

                                                                                          Current pdf writer instance

                                                                                          -
                                                                                          - - -
                                                                                          -
                                                                                          -

                                                                                          - setDefaultConfig() - -

                                                                                          - - - - - public - abstract setDefaultConfig() : mixed - -
                                                                                          - - - - -
                                                                                          Return values
                                                                                          - mixed - — - - -
                                                                                          -
                                                                                          -

                                                                                          - setFileName() - -

                                                                                          - - -

                                                                                          Set the pdf filename.

                                                                                          - - - public - setFileName(string $fileName) : PdfWriter - - -
                                                                                          Parameters
                                                                                          -
                                                                                          -
                                                                                          - $fileName - : string -
                                                                                          -
                                                                                          -
                                                                                          - -
                                                                                          -
                                                                                          - - - -
                                                                                          Return values
                                                                                          - PdfWriter - — -

                                                                                          Current pdf writer instance

                                                                                          -
                                                                                          - - -
                                                                                          -
                                                                                          -

                                                                                          - setFolder() - -

                                                                                          - - - - - public - setFolder(string $folder) : void - -
                                                                                          - -
                                                                                          Parameters
                                                                                          -
                                                                                          -
                                                                                          - $folder - : string -
                                                                                          -
                                                                                          -
                                                                                          - -
                                                                                          -
                                                                                          - - - -
                                                                                          Return values
                                                                                          - void - — - - -
                                                                                          -
                                                                                          -

                                                                                          - setHtml() - -

                                                                                          - - -

                                                                                          Set html including styles.

                                                                                          - - - public - setHtml(string $html) : PdfWriter - - -
                                                                                          Parameters
                                                                                          -
                                                                                          -
                                                                                          - $html - : string -
                                                                                          -
                                                                                          -
                                                                                          - -
                                                                                          -
                                                                                          - - - -
                                                                                          Return values
                                                                                          - PdfWriter - — - - -
                                                                                          -
                                                                                          - - - - -
                                                                                          -
                                                                                          -
                                                                                          -
                                                                                          -

                                                                                          Search results

                                                                                          - -
                                                                                          -
                                                                                          -
                                                                                            -
                                                                                            -
                                                                                            -
                                                                                            -
                                                                                            -
                                                                                            - - -
                                                                                            - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Pdf-FPDIWriter.html b/classes/HeimrichHannot-UtilsBundle-Pdf-FPDIWriter.html deleted file mode 100644 index ef0f990f..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Pdf-FPDIWriter.html +++ /dev/null @@ -1,1511 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                            -

                                                                                            Contao Utils Bundle

                                                                                            - - -
                                                                                            - -
                                                                                            - - -
                                                                                            - -
                                                                                            -
                                                                                            - - - - -
                                                                                            - - -
                                                                                            -

                                                                                            - FPDIWriter - - - extends AbstractPdfWriter - - -
                                                                                            - in package - -
                                                                                            - - -

                                                                                            - - - -

                                                                                            Class AbstractPdfWriter.

                                                                                            - - - - - - - - - -

                                                                                            - Table of Contents - -

                                                                                            - -
                                                                                            -
                                                                                            - OUTPUT_MODE_DOWNLOAD - -  = 'download' -
                                                                                            -
                                                                                            - -
                                                                                            - OUTPUT_MODE_FILE - -  = 'file' -
                                                                                            -
                                                                                            - -
                                                                                            - OUTPUT_MODE_INLINE - -  = 'inline' -
                                                                                            -
                                                                                            - -
                                                                                            - OUTPUT_MODES - -  = [self::OUTPUT_MODE_DOWNLOAD, self::OUTPUT_MODE_FILE, self::OUTPUT_MODE_INLINE] -
                                                                                            -
                                                                                            - -
                                                                                            - $config - -  : array<string|int, mixed> -
                                                                                            -
                                                                                            Pdf configuration.
                                                                                            - -
                                                                                            - $fileName - -  : string -
                                                                                            -
                                                                                            Pdf file name.
                                                                                            - -
                                                                                            - $folder - -  : string -
                                                                                            -
                                                                                            The folder in case of saving to file.
                                                                                            - -
                                                                                            - $html - -  : string -
                                                                                            -
                                                                                            Pdf html content including styles.
                                                                                            - -
                                                                                            - $isPrepared - -  : bool -
                                                                                            -
                                                                                            - -
                                                                                            - $pdf - -  : Fpdi -
                                                                                            -
                                                                                            Current fpdi instance.
                                                                                            - -
                                                                                            - $template - -  : string -
                                                                                            -
                                                                                            Master pdf template.
                                                                                            - -
                                                                                            - __construct() - -  : mixed -
                                                                                            -
                                                                                            TCPDFWriter constructor.
                                                                                            - -
                                                                                            - addFont() - -  : mixed -
                                                                                            -
                                                                                            - -
                                                                                            - generate() - -  : void -
                                                                                            -
                                                                                            Generate the pdf.
                                                                                            - -
                                                                                            - getConfig() - -  : array<string|int, mixed> -
                                                                                            -
                                                                                            Get the pdf config.
                                                                                            - -
                                                                                            - getFileName() - -  : string -
                                                                                            -
                                                                                            Get the pdf file name.
                                                                                            - -
                                                                                            - getFolder() - -  : string -
                                                                                            -
                                                                                            - -
                                                                                            - getHtml() - -  : string -
                                                                                            -
                                                                                            Get html including styles.
                                                                                            - -
                                                                                            - getPdf() - -  : Fpdi -
                                                                                            -
                                                                                            Get current pdf object.
                                                                                            - -
                                                                                            - getTemplate() - -  : string -
                                                                                            -
                                                                                            Get the master template path.
                                                                                            - -
                                                                                            - isPrepared() - -  : bool -
                                                                                            -
                                                                                            Check if prepare was already triggered.
                                                                                            - -
                                                                                            - mergeConfig() - -  : PdfWriter -
                                                                                            -
                                                                                            Merge current pdf config with given.
                                                                                            - -
                                                                                            - prepare() - -  : Fpdi -
                                                                                            -
                                                                                            Prepare the current fpdi object.
                                                                                            - -
                                                                                            - setConfig() - -  : PdfWriter -
                                                                                            -
                                                                                            Set pdf config, replace default with custom config.
                                                                                            - -
                                                                                            - setDefaultConfig() - -  : mixed -
                                                                                            -
                                                                                            - -
                                                                                            - setFileName() - -  : PdfWriter -
                                                                                            -
                                                                                            Set the pdf filename.
                                                                                            - -
                                                                                            - setFolder() - -  : void -
                                                                                            -
                                                                                            - -
                                                                                            - setHtml() - -  : PdfWriter -
                                                                                            -
                                                                                            Set html including styles.
                                                                                            - -
                                                                                            - setTemplate() - -  : PdfWriter -
                                                                                            -
                                                                                            Set the master template path.
                                                                                            - -
                                                                                            - - - - -
                                                                                            -

                                                                                            - Constants - -

                                                                                            -
                                                                                            -

                                                                                            - OUTPUT_MODE_DOWNLOAD - -

                                                                                            - - - - - - public - mixed - OUTPUT_MODE_DOWNLOAD - = 'download' - - - -
                                                                                            - -
                                                                                            - - - -
                                                                                            -
                                                                                            -

                                                                                            - OUTPUT_MODE_FILE - -

                                                                                            - - - - - - public - mixed - OUTPUT_MODE_FILE - = 'file' - - - -
                                                                                            - -
                                                                                            - - - -
                                                                                            -
                                                                                            -

                                                                                            - OUTPUT_MODE_INLINE - -

                                                                                            - - - - - - public - mixed - OUTPUT_MODE_INLINE - = 'inline' - - - -
                                                                                            - -
                                                                                            - - - -
                                                                                            -
                                                                                            -

                                                                                            - OUTPUT_MODES - -

                                                                                            - - - - - - public - mixed - OUTPUT_MODES - = [self::OUTPUT_MODE_DOWNLOAD, self::OUTPUT_MODE_FILE, self::OUTPUT_MODE_INLINE] - - - -
                                                                                            - -
                                                                                            - - - -
                                                                                            -
                                                                                            - - -
                                                                                            -

                                                                                            - Properties - -

                                                                                            -
                                                                                            -

                                                                                            - $config - - - -

                                                                                            - - -

                                                                                            Pdf configuration.

                                                                                            - - - protected - array<string|int, mixed> - $config - = [] - - - - - -
                                                                                            -
                                                                                            -

                                                                                            - $fileName - - - -

                                                                                            - - -

                                                                                            Pdf file name.

                                                                                            - - - protected - string - $fileName - - - - - - -
                                                                                            -
                                                                                            -

                                                                                            - $folder - - - -

                                                                                            - - -

                                                                                            The folder in case of saving to file.

                                                                                            - - - protected - string - $folder - - - - - - -
                                                                                            -
                                                                                            -

                                                                                            - $html - - - -

                                                                                            - - -

                                                                                            Pdf html content including styles.

                                                                                            - - - protected - string - $html - - - - - - -
                                                                                            -
                                                                                            -

                                                                                            - $isPrepared - - - -

                                                                                            - - - - - protected - bool - $isPrepared - = false - - - - - -
                                                                                            -
                                                                                            -

                                                                                            - $pdf - - - -

                                                                                            - - -

                                                                                            Current fpdi instance.

                                                                                            - - - protected - Fpdi - $pdf - - - - - - -
                                                                                            -
                                                                                            -

                                                                                            - $template - - - -

                                                                                            - - -

                                                                                            Master pdf template.

                                                                                            - - - protected - string - $template - - - - - - -
                                                                                            -
                                                                                            - -
                                                                                            -

                                                                                            - Methods - -

                                                                                            -
                                                                                            -

                                                                                            - __construct() - -

                                                                                            - - -

                                                                                            TCPDFWriter constructor.

                                                                                            - - - public - __construct() : mixed - - - - - -
                                                                                            Return values
                                                                                            - mixed - — - - -
                                                                                            -
                                                                                            -

                                                                                            - addFont() - -

                                                                                            - - - - - public - addFont( $family,  $weight,  $filename) : mixed - - -
                                                                                            Parameters
                                                                                            -
                                                                                            -
                                                                                            - $family - : -
                                                                                            -
                                                                                            - -
                                                                                            -
                                                                                            - $weight - : -
                                                                                            -
                                                                                            - -
                                                                                            -
                                                                                            - $filename - : -
                                                                                            -
                                                                                            -

                                                                                            string The absolute filename including path

                                                                                            -
                                                                                            - -
                                                                                            -
                                                                                            - - - -
                                                                                            Return values
                                                                                            - mixed - — - - -
                                                                                            -
                                                                                            -

                                                                                            - generate() - -

                                                                                            - - -

                                                                                            Generate the pdf.

                                                                                            - - - public - generate([string $mode = self::OUTPUT_MODE_DOWNLOAD ]) : void - - -
                                                                                            Parameters
                                                                                            -
                                                                                            -
                                                                                            - $mode - : string - = self::OUTPUT_MODE_DOWNLOAD
                                                                                            -
                                                                                            - -
                                                                                            -
                                                                                            - - - -
                                                                                            Return values
                                                                                            - void - — - - -
                                                                                            -
                                                                                            -

                                                                                            - getConfig() - -

                                                                                            - - -

                                                                                            Get the pdf config.

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

                                                                                            - getFileName() - -

                                                                                            - - -

                                                                                            Get the pdf file name.

                                                                                            - - - public - getFileName() : string - - - - - -
                                                                                            Return values
                                                                                            - string - — - - -
                                                                                            -
                                                                                            -

                                                                                            - getFolder() - -

                                                                                            - - - - - public - getFolder() : string - - - - - -
                                                                                            Return values
                                                                                            - string - — - - -
                                                                                            -
                                                                                            -

                                                                                            - getHtml() - -

                                                                                            - - -

                                                                                            Get html including styles.

                                                                                            - - - public - getHtml() : string - - - - - -
                                                                                            Return values
                                                                                            - string - — - - -
                                                                                            -
                                                                                            -

                                                                                            - getPdf() - -

                                                                                            - - -

                                                                                            Get current pdf object.

                                                                                            - - - public - getPdf([bool $init = false ]) : Fpdi - - -
                                                                                            Parameters
                                                                                            -
                                                                                            -
                                                                                            - $init - : bool - = false
                                                                                            -
                                                                                            -

                                                                                            Set true if you want to create a new pdf regardless there is always an existing pdf

                                                                                            -
                                                                                            - -
                                                                                            -
                                                                                            - - - -
                                                                                            Return values
                                                                                            - Fpdi - — - - -
                                                                                            -
                                                                                            -

                                                                                            - getTemplate() - -

                                                                                            - - -

                                                                                            Get the master template path.

                                                                                            - - - public - getTemplate() : string - - - - - -
                                                                                            Return values
                                                                                            - string - — - - -
                                                                                            -
                                                                                            -

                                                                                            - isPrepared() - -

                                                                                            - - -

                                                                                            Check if prepare was already triggered.

                                                                                            - - - public - isPrepared() : bool - - - - - -
                                                                                            Return values
                                                                                            - bool - — - - -
                                                                                            -
                                                                                            -

                                                                                            - mergeConfig() - -

                                                                                            - - -

                                                                                            Merge current pdf config with given.

                                                                                            - - - public - mergeConfig(array<string|int, mixed> $config) : PdfWriter - - -
                                                                                            Parameters
                                                                                            -
                                                                                            -
                                                                                            - $config - : array<string|int, mixed> -
                                                                                            -
                                                                                            -
                                                                                            - -
                                                                                            -
                                                                                            - - - -
                                                                                            Return values
                                                                                            - PdfWriter - — -

                                                                                            Current pdf writer instance

                                                                                            -
                                                                                            - - -
                                                                                            -
                                                                                            -

                                                                                            - prepare() - -

                                                                                            - - -

                                                                                            Prepare the current fpdi object.

                                                                                            - - - public - prepare() : Fpdi - - - - - -
                                                                                            Return values
                                                                                            - Fpdi - — - - -
                                                                                            -
                                                                                            -

                                                                                            - setConfig() - -

                                                                                            - - -

                                                                                            Set pdf config, replace default with custom config.

                                                                                            - - - public - setConfig(array<string|int, mixed> $config) : PdfWriter - - -
                                                                                            Parameters
                                                                                            -
                                                                                            -
                                                                                            - $config - : array<string|int, mixed> -
                                                                                            -
                                                                                            -
                                                                                            - -
                                                                                            -
                                                                                            - - - -
                                                                                            Return values
                                                                                            - PdfWriter - — -

                                                                                            Current pdf writer instance

                                                                                            -
                                                                                            - - -
                                                                                            -
                                                                                            -

                                                                                            - setDefaultConfig() - -

                                                                                            - - - - - public - setDefaultConfig() : mixed - -
                                                                                            - - - - -
                                                                                            Return values
                                                                                            - mixed - — - - -
                                                                                            -
                                                                                            -

                                                                                            - setFileName() - -

                                                                                            - - -

                                                                                            Set the pdf filename.

                                                                                            - - - public - setFileName(string $fileName) : PdfWriter - - -
                                                                                            Parameters
                                                                                            -
                                                                                            -
                                                                                            - $fileName - : string -
                                                                                            -
                                                                                            -
                                                                                            - -
                                                                                            -
                                                                                            - - - -
                                                                                            Return values
                                                                                            - PdfWriter - — -

                                                                                            Current pdf writer instance

                                                                                            -
                                                                                            - - -
                                                                                            -
                                                                                            -

                                                                                            - setFolder() - -

                                                                                            - - - - - public - setFolder(string $folder) : void - -
                                                                                            - -
                                                                                            Parameters
                                                                                            -
                                                                                            -
                                                                                            - $folder - : string -
                                                                                            -
                                                                                            -
                                                                                            - -
                                                                                            -
                                                                                            - - - -
                                                                                            Return values
                                                                                            - void - — - - -
                                                                                            -
                                                                                            -

                                                                                            - setHtml() - -

                                                                                            - - -

                                                                                            Set html including styles.

                                                                                            - - - public - setHtml(string $html) : PdfWriter - - -
                                                                                            Parameters
                                                                                            -
                                                                                            -
                                                                                            - $html - : string -
                                                                                            -
                                                                                            -
                                                                                            - -
                                                                                            -
                                                                                            - - - -
                                                                                            Return values
                                                                                            - PdfWriter - — - - -
                                                                                            -
                                                                                            -

                                                                                            - setTemplate() - -

                                                                                            - - -

                                                                                            Set the master template path.

                                                                                            - - - public - setTemplate(string $template) : PdfWriter - - -
                                                                                            Parameters
                                                                                            -
                                                                                            -
                                                                                            - $template - : string -
                                                                                            -
                                                                                            -
                                                                                            - -
                                                                                            -
                                                                                            - - - -
                                                                                            Return values
                                                                                            - PdfWriter - — -

                                                                                            Current pdf writer instance

                                                                                            -
                                                                                            - - -
                                                                                            -
                                                                                            - - - - -
                                                                                            -
                                                                                            -
                                                                                            -
                                                                                            -

                                                                                            Search results

                                                                                            - -
                                                                                            -
                                                                                            -
                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              - - -
                                                                                              - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Pdf-PdfPreview.html b/classes/HeimrichHannot-UtilsBundle-Pdf-PdfPreview.html deleted file mode 100644 index 3f3a7af8..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Pdf-PdfPreview.html +++ /dev/null @@ -1,808 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                              -

                                                                                              Contao Utils Bundle

                                                                                              - - -
                                                                                              - -
                                                                                              - - -
                                                                                              - -
                                                                                              -
                                                                                              - - - - -
                                                                                              - - -
                                                                                              -

                                                                                              - PdfPreview - - -
                                                                                              - in package - -
                                                                                              - - -

                                                                                              - - - - -
                                                                                              - - - - - - - - -

                                                                                              - Table of Contents - -

                                                                                              - -
                                                                                              -
                                                                                              - $containerUtil - -  : ContainerUtil -
                                                                                              -
                                                                                              - -
                                                                                              - $fileStorageUtil - -  : FileStorageUtil -
                                                                                              -
                                                                                              - -
                                                                                              - $projectDir - -  : string -
                                                                                              -
                                                                                              - -
                                                                                              - $utilsConfig - -  : array<string|int, mixed> -
                                                                                              -
                                                                                              - -
                                                                                              - __construct() - -  : mixed -
                                                                                              -
                                                                                              - -
                                                                                              - generatePdfPreview() - -  : bool -
                                                                                              -
                                                                                              Generate a image preview of the given pdf.
                                                                                              - -
                                                                                              - getCachedPdfPreview() - -  : string -
                                                                                              -
                                                                                              - -
                                                                                              - alchemyPdf() - -  : bool -
                                                                                              -
                                                                                              - -
                                                                                              - spatiePdf() - -  : bool -
                                                                                              -
                                                                                              - -
                                                                                              - - - - - - -
                                                                                              -

                                                                                              - Properties - -

                                                                                              - - -
                                                                                              -

                                                                                              - $projectDir - - - -

                                                                                              - - - - - private - string - $projectDir - - - - - - -
                                                                                              -
                                                                                              -

                                                                                              - $utilsConfig - - - -

                                                                                              - - - - - private - array<string|int, mixed> - $utilsConfig - - - - - - -
                                                                                              -
                                                                                              - -
                                                                                              -

                                                                                              - Methods - -

                                                                                              -
                                                                                              -

                                                                                              - __construct() - -

                                                                                              - - - - - public - __construct(array<string|int, mixed> $utilsConfig, FileStorageUtil $fileStorageUtil, ContainerUtil $containerUtil, string $projectDir) : mixed - -
                                                                                              - -
                                                                                              Parameters
                                                                                              -
                                                                                              -
                                                                                              - $utilsConfig - : array<string|int, mixed> -
                                                                                              -
                                                                                              -
                                                                                              - -
                                                                                              -
                                                                                              - $fileStorageUtil - : FileStorageUtil -
                                                                                              -
                                                                                              -
                                                                                              - -
                                                                                              -
                                                                                              - $containerUtil - : ContainerUtil -
                                                                                              -
                                                                                              -
                                                                                              - -
                                                                                              -
                                                                                              - $projectDir - : string -
                                                                                              -
                                                                                              -
                                                                                              - -
                                                                                              -
                                                                                              - - - -
                                                                                              Return values
                                                                                              - mixed - — - - -
                                                                                              -
                                                                                              -

                                                                                              - generatePdfPreview() - -

                                                                                              - - -

                                                                                              Generate a image preview of the given pdf.

                                                                                              - - - public - generatePdfPreview(string $pdfPath, string $imagePath[, array<string|int, mixed> $options = [] ]) : bool - -

                                                                                              Possible PdfTranscoder: spatie (spatie/pdf-to-image), alchemy (alchemy/ghostscript)

                                                                                              -

                                                                                              Possible file extensions: jpg, jpeg, png

                                                                                              -

                                                                                              Additional options:

                                                                                              -
                                                                                                -
                                                                                              • string pdfTranscoder The pdf transcoder to use (default: spatie)
                                                                                                • -
                                                                                              • int page The page to render (default: 1)
                                                                                                • -
                                                                                              • int compressionQuality Pdf compression quality (default: null) (spatie only)
                                                                                                • -
                                                                                              • int resolution Raster resolution (default: 144)(spatie only)
                                                                                                • -
                                                                                              • bool absolutePdfPath Set true if pdf path is absolute (default: false)
                                                                                                • -
                                                                                              • bool absoluteImagePath Set true if image path is absolute (default: false)
                                                                                                • -
                                                                                              -
                                                                                              - -
                                                                                              Parameters
                                                                                              -
                                                                                              -
                                                                                              - $pdfPath - : string -
                                                                                              -
                                                                                              -

                                                                                              the relative path to the pdf file

                                                                                              -
                                                                                              - -
                                                                                              -
                                                                                              - $imagePath - : string -
                                                                                              -
                                                                                              -

                                                                                              the relative path where the image file should be saved (including file name and extension)

                                                                                              -
                                                                                              - -
                                                                                              -
                                                                                              - $options - : array<string|int, mixed> - = []
                                                                                              -
                                                                                              -

                                                                                              Additional rendering options

                                                                                              -
                                                                                              - -
                                                                                              -
                                                                                              - - -
                                                                                              - Tags - -
                                                                                              -
                                                                                              -
                                                                                              - throws -
                                                                                              -
                                                                                              - Exception - - -
                                                                                              -
                                                                                              - -
                                                                                              Return values
                                                                                              - bool - — - - -
                                                                                              -
                                                                                              -

                                                                                              - getCachedPdfPreview() - -

                                                                                              - - - - - public - getCachedPdfPreview(string $pdfPath[, array<string|int, mixed> $options = [] ][, string $fileExtension = 'jpg' ]) : string - - -
                                                                                              Parameters
                                                                                              -
                                                                                              -
                                                                                              - $pdfPath - : string -
                                                                                              -
                                                                                              -

                                                                                              The path to the pdf file

                                                                                              -
                                                                                              - -
                                                                                              -
                                                                                              - $options - : array<string|int, mixed> - = []
                                                                                              -
                                                                                              -

                                                                                              Additional rendering options. See generatePdfPreview

                                                                                              -
                                                                                              - -
                                                                                              -
                                                                                              - $fileExtension - : string - = 'jpg'
                                                                                              -
                                                                                              -
                                                                                              - -
                                                                                              -
                                                                                              - - -
                                                                                              - Tags - -
                                                                                              -
                                                                                              -
                                                                                              - throws -
                                                                                              -
                                                                                              - Exception - - -
                                                                                              -
                                                                                              - -
                                                                                              Return values
                                                                                              - string - — - - -
                                                                                              -
                                                                                              -

                                                                                              - alchemyPdf() - -

                                                                                              - - - - - protected - alchemyPdf(string $pdfPath, string $imagePath[, array<string|int, mixed> $options = [] ]) : bool - - -
                                                                                              Parameters
                                                                                              -
                                                                                              -
                                                                                              - $pdfPath - : string -
                                                                                              -
                                                                                              -
                                                                                              - -
                                                                                              -
                                                                                              - $imagePath - : string -
                                                                                              -
                                                                                              -
                                                                                              - -
                                                                                              -
                                                                                              - $options - : array<string|int, mixed> - = []
                                                                                              -
                                                                                              -
                                                                                              - -
                                                                                              -
                                                                                              - - -
                                                                                              - Tags - -
                                                                                              -
                                                                                              -
                                                                                              - throws -
                                                                                              -
                                                                                              - Exception - - -
                                                                                              -
                                                                                              - -
                                                                                              Return values
                                                                                              - bool - — - - -
                                                                                              -
                                                                                              -

                                                                                              - spatiePdf() - -

                                                                                              - - - - - protected - spatiePdf(string $pdfPath, string $imagePath[, array<string|int, mixed> $options = [] ]) : bool - - -
                                                                                              Parameters
                                                                                              -
                                                                                              -
                                                                                              - $pdfPath - : string -
                                                                                              -
                                                                                              -
                                                                                              - -
                                                                                              -
                                                                                              - $imagePath - : string -
                                                                                              -
                                                                                              -
                                                                                              - -
                                                                                              -
                                                                                              - $options - : array<string|int, mixed> - = []
                                                                                              -
                                                                                              -
                                                                                              - -
                                                                                              -
                                                                                              - - -
                                                                                              - Tags - -
                                                                                              -
                                                                                              -
                                                                                              - throws -
                                                                                              -
                                                                                              - Exception - - -
                                                                                              -
                                                                                              - -
                                                                                              Return values
                                                                                              - bool - — - - -
                                                                                              -
                                                                                              - - - - -
                                                                                              -
                                                                                              -
                                                                                              -
                                                                                              -

                                                                                              Search results

                                                                                              - -
                                                                                              -
                                                                                              -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                - - -
                                                                                                - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Pdf-PdfWriter.html b/classes/HeimrichHannot-UtilsBundle-Pdf-PdfWriter.html deleted file mode 100644 index 4736675a..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Pdf-PdfWriter.html +++ /dev/null @@ -1,1515 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                -

                                                                                                Contao Utils Bundle

                                                                                                - - -
                                                                                                - -
                                                                                                - - -
                                                                                                - -
                                                                                                -
                                                                                                - - - - -
                                                                                                - - -
                                                                                                -

                                                                                                - PdfWriter - - - extends AbstractPdfWriter - - -
                                                                                                - in package - -
                                                                                                - - -

                                                                                                - - - -

                                                                                                Class PdfWriter.

                                                                                                - - - -
                                                                                                - Tags - -
                                                                                                -
                                                                                                -
                                                                                                - deprecated -
                                                                                                -
                                                                                                - -

                                                                                                Use PdfCreatorFactory::createInstance(MpdfCreator::getType()) instead

                                                                                                -
                                                                                                - -
                                                                                                -
                                                                                                - - - - - - -

                                                                                                - Table of Contents - -

                                                                                                - -
                                                                                                -
                                                                                                - OUTPUT_MODE_DOWNLOAD - -  = 'download' -
                                                                                                -
                                                                                                - -
                                                                                                - OUTPUT_MODE_FILE - -  = 'file' -
                                                                                                -
                                                                                                - -
                                                                                                - OUTPUT_MODE_INLINE - -  = 'inline' -
                                                                                                -
                                                                                                - -
                                                                                                - OUTPUT_MODES - -  = [self::OUTPUT_MODE_DOWNLOAD, self::OUTPUT_MODE_FILE, self::OUTPUT_MODE_INLINE] -
                                                                                                -
                                                                                                - -
                                                                                                - $config - -  : array<string|int, mixed> -
                                                                                                -
                                                                                                Pdf configuration.
                                                                                                - -
                                                                                                - $fileName - -  : string -
                                                                                                -
                                                                                                Pdf file name.
                                                                                                - -
                                                                                                - $folder - -  : string -
                                                                                                -
                                                                                                The folder in case of saving to file.
                                                                                                - -
                                                                                                - $html - -  : string -
                                                                                                -
                                                                                                Pdf html content including styles.
                                                                                                - -
                                                                                                - $isPrepared - -  : bool -
                                                                                                -
                                                                                                - -
                                                                                                - $pdf - -  : Mpdf -
                                                                                                -
                                                                                                Current mpdf instance.
                                                                                                - -
                                                                                                - $template - -  : string -
                                                                                                -
                                                                                                Master pdf template.
                                                                                                - -
                                                                                                - __construct() - -  : mixed -
                                                                                                -
                                                                                                constructor.
                                                                                                - -
                                                                                                - addFontDirectories() - -  : PdfWriter -
                                                                                                -
                                                                                                Add font directories to the config.
                                                                                                - -
                                                                                                - generate() - -  : void -
                                                                                                -
                                                                                                Generate the pdf.
                                                                                                - -
                                                                                                - getConfig() - -  : array<string|int, mixed> -
                                                                                                -
                                                                                                Get the pdf config.
                                                                                                - -
                                                                                                - getFileName() - -  : string -
                                                                                                -
                                                                                                Get the pdf file name.
                                                                                                - -
                                                                                                - getFolder() - -  : string -
                                                                                                -
                                                                                                - -
                                                                                                - getHtml() - -  : string -
                                                                                                -
                                                                                                Get html including styles.
                                                                                                - -
                                                                                                - getPdf() - -  : Mpdf -
                                                                                                -
                                                                                                Get current pdf object.
                                                                                                - -
                                                                                                - getTemplate() - -  : string -
                                                                                                -
                                                                                                Get the master template path.
                                                                                                - -
                                                                                                - isPrepared() - -  : bool -
                                                                                                -
                                                                                                Check if prepare was already triggered.
                                                                                                - -
                                                                                                - mergeConfig() - -  : PdfWriter -
                                                                                                -
                                                                                                Merge current pdf config with given.
                                                                                                - -
                                                                                                - prepare() - -  : Mpdf -
                                                                                                -
                                                                                                Prepare the current mpdf object.
                                                                                                - -
                                                                                                - setConfig() - -  : PdfWriter -
                                                                                                -
                                                                                                Set pdf config, replace default with custom config.
                                                                                                - -
                                                                                                - setDefaultConfig() - -  : mixed -
                                                                                                -
                                                                                                - -
                                                                                                - setFileName() - -  : PdfWriter -
                                                                                                -
                                                                                                Set the pdf filename.
                                                                                                - -
                                                                                                - setFolder() - -  : void -
                                                                                                -
                                                                                                - -
                                                                                                - setHtml() - -  : PdfWriter -
                                                                                                -
                                                                                                Set html including styles.
                                                                                                - -
                                                                                                - setTemplate() - -  : PdfWriter -
                                                                                                -
                                                                                                Set the master template path.
                                                                                                - -
                                                                                                - - - - -
                                                                                                -

                                                                                                - Constants - -

                                                                                                -
                                                                                                -

                                                                                                - OUTPUT_MODE_DOWNLOAD - -

                                                                                                - - - - - - public - mixed - OUTPUT_MODE_DOWNLOAD - = 'download' - - - -
                                                                                                - -
                                                                                                - - - -
                                                                                                -
                                                                                                -

                                                                                                - OUTPUT_MODE_FILE - -

                                                                                                - - - - - - public - mixed - OUTPUT_MODE_FILE - = 'file' - - - -
                                                                                                - -
                                                                                                - - - -
                                                                                                -
                                                                                                -

                                                                                                - OUTPUT_MODE_INLINE - -

                                                                                                - - - - - - public - mixed - OUTPUT_MODE_INLINE - = 'inline' - - - -
                                                                                                - -
                                                                                                - - - -
                                                                                                -
                                                                                                -

                                                                                                - OUTPUT_MODES - -

                                                                                                - - - - - - public - mixed - OUTPUT_MODES - = [self::OUTPUT_MODE_DOWNLOAD, self::OUTPUT_MODE_FILE, self::OUTPUT_MODE_INLINE] - - - -
                                                                                                - -
                                                                                                - - - -
                                                                                                -
                                                                                                - - -
                                                                                                -

                                                                                                - Properties - -

                                                                                                -
                                                                                                -

                                                                                                - $config - - - -

                                                                                                - - -

                                                                                                Pdf configuration.

                                                                                                - - - protected - array<string|int, mixed> - $config - = [] - - - - - -
                                                                                                -
                                                                                                -

                                                                                                - $fileName - - - -

                                                                                                - - -

                                                                                                Pdf file name.

                                                                                                - - - protected - string - $fileName - - - - - - -
                                                                                                -
                                                                                                -

                                                                                                - $folder - - - -

                                                                                                - - -

                                                                                                The folder in case of saving to file.

                                                                                                - - - protected - string - $folder - - - - - - -
                                                                                                -
                                                                                                -

                                                                                                - $html - - - -

                                                                                                - - -

                                                                                                Pdf html content including styles.

                                                                                                - - - protected - string - $html - - - - - - -
                                                                                                -
                                                                                                -

                                                                                                - $isPrepared - - - -

                                                                                                - - - - - protected - bool - $isPrepared - = false - - - - - -
                                                                                                -
                                                                                                -

                                                                                                - $pdf - - - -

                                                                                                - - -

                                                                                                Current mpdf instance.

                                                                                                - - - protected - Mpdf - $pdf - - - - - - -
                                                                                                -
                                                                                                -

                                                                                                - $template - - - -

                                                                                                - - -

                                                                                                Master pdf template.

                                                                                                - - - protected - string - $template - - - - - - -
                                                                                                -
                                                                                                - -
                                                                                                -

                                                                                                - Methods - -

                                                                                                -
                                                                                                -

                                                                                                - __construct() - -

                                                                                                - - -

                                                                                                constructor.

                                                                                                - - - public - __construct() : mixed - - - - - -
                                                                                                Return values
                                                                                                - mixed - — - - -
                                                                                                -
                                                                                                -

                                                                                                - addFontDirectories() - -

                                                                                                - - -

                                                                                                Add font directories to the config.

                                                                                                - - - public - addFontDirectories(array<string|int, mixed> $paths) : PdfWriter - - -
                                                                                                Parameters
                                                                                                -
                                                                                                -
                                                                                                - $paths - : array<string|int, mixed> -
                                                                                                -
                                                                                                -

                                                                                                Directory pathseader

                                                                                                -
                                                                                                - -
                                                                                                -
                                                                                                - - - -
                                                                                                Return values
                                                                                                - PdfWriter - — -

                                                                                                Current pdf writer instance

                                                                                                -
                                                                                                - - -
                                                                                                -
                                                                                                -

                                                                                                - generate() - -

                                                                                                - - -

                                                                                                Generate the pdf.

                                                                                                - - - public - generate([string $mode = self::OUTPUT_MODE_DOWNLOAD ]) : void - - -
                                                                                                Parameters
                                                                                                -
                                                                                                -
                                                                                                - $mode - : string - = self::OUTPUT_MODE_DOWNLOAD
                                                                                                -
                                                                                                - -
                                                                                                -
                                                                                                - - - -
                                                                                                Return values
                                                                                                - void - — - - -
                                                                                                -
                                                                                                -

                                                                                                - getConfig() - -

                                                                                                - - -

                                                                                                Get the pdf config.

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

                                                                                                - getFileName() - -

                                                                                                - - -

                                                                                                Get the pdf file name.

                                                                                                - - - public - getFileName() : string - - - - - -
                                                                                                Return values
                                                                                                - string - — - - -
                                                                                                -
                                                                                                -

                                                                                                - getFolder() - -

                                                                                                - - - - - public - getFolder() : string - - - - - -
                                                                                                Return values
                                                                                                - string - — - - -
                                                                                                -
                                                                                                -

                                                                                                - getHtml() - -

                                                                                                - - -

                                                                                                Get html including styles.

                                                                                                - - - public - getHtml() : string - - - - - -
                                                                                                Return values
                                                                                                - string - — - - -
                                                                                                -
                                                                                                -

                                                                                                - getPdf() - -

                                                                                                - - -

                                                                                                Get current pdf object.

                                                                                                - - - public - getPdf([bool $init = false ]) : Mpdf - - -
                                                                                                Parameters
                                                                                                -
                                                                                                -
                                                                                                - $init - : bool - = false
                                                                                                -
                                                                                                -

                                                                                                Set true if you want to create a new pdf regardless there is always an existing pdf

                                                                                                -
                                                                                                - -
                                                                                                -
                                                                                                - - - -
                                                                                                Return values
                                                                                                - Mpdf - — - - -
                                                                                                -
                                                                                                -

                                                                                                - getTemplate() - -

                                                                                                - - -

                                                                                                Get the master template path.

                                                                                                - - - public - getTemplate() : string - - - - - -
                                                                                                Return values
                                                                                                - string - — - - -
                                                                                                -
                                                                                                -

                                                                                                - isPrepared() - -

                                                                                                - - -

                                                                                                Check if prepare was already triggered.

                                                                                                - - - public - isPrepared() : bool - - - - - -
                                                                                                Return values
                                                                                                - bool - — - - -
                                                                                                -
                                                                                                -

                                                                                                - mergeConfig() - -

                                                                                                - - -

                                                                                                Merge current pdf config with given.

                                                                                                - - - public - mergeConfig(array<string|int, mixed> $config) : PdfWriter - - -
                                                                                                Parameters
                                                                                                -
                                                                                                -
                                                                                                - $config - : array<string|int, mixed> -
                                                                                                -
                                                                                                -
                                                                                                - -
                                                                                                -
                                                                                                - - - -
                                                                                                Return values
                                                                                                - PdfWriter - — -

                                                                                                Current pdf writer instance

                                                                                                -
                                                                                                - - -
                                                                                                -
                                                                                                -

                                                                                                - prepare() - -

                                                                                                - - -

                                                                                                Prepare the current mpdf object.

                                                                                                - - - public - prepare() : Mpdf - - - - - -
                                                                                                Return values
                                                                                                - Mpdf - — - - -
                                                                                                -
                                                                                                -

                                                                                                - setConfig() - -

                                                                                                - - -

                                                                                                Set pdf config, replace default with custom config.

                                                                                                - - - public - setConfig(array<string|int, mixed> $config) : PdfWriter - - -
                                                                                                Parameters
                                                                                                -
                                                                                                -
                                                                                                - $config - : array<string|int, mixed> -
                                                                                                -
                                                                                                -
                                                                                                - -
                                                                                                -
                                                                                                - - - -
                                                                                                Return values
                                                                                                - PdfWriter - — -

                                                                                                Current pdf writer instance

                                                                                                -
                                                                                                - - -
                                                                                                -
                                                                                                -

                                                                                                - setDefaultConfig() - -

                                                                                                - - - - - public - setDefaultConfig() : mixed - -
                                                                                                - - - - -
                                                                                                Return values
                                                                                                - mixed - — - - -
                                                                                                -
                                                                                                -

                                                                                                - setFileName() - -

                                                                                                - - -

                                                                                                Set the pdf filename.

                                                                                                - - - public - setFileName(string $fileName) : PdfWriter - - -
                                                                                                Parameters
                                                                                                -
                                                                                                -
                                                                                                - $fileName - : string -
                                                                                                -
                                                                                                -
                                                                                                - -
                                                                                                -
                                                                                                - - - -
                                                                                                Return values
                                                                                                - PdfWriter - — -

                                                                                                Current pdf writer instance

                                                                                                -
                                                                                                - - -
                                                                                                -
                                                                                                -

                                                                                                - setFolder() - -

                                                                                                - - - - - public - setFolder(string $folder) : void - -
                                                                                                - -
                                                                                                Parameters
                                                                                                -
                                                                                                -
                                                                                                - $folder - : string -
                                                                                                -
                                                                                                -
                                                                                                - -
                                                                                                -
                                                                                                - - - -
                                                                                                Return values
                                                                                                - void - — - - -
                                                                                                -
                                                                                                -

                                                                                                - setHtml() - -

                                                                                                - - -

                                                                                                Set html including styles.

                                                                                                - - - public - setHtml(string $html) : PdfWriter - - -
                                                                                                Parameters
                                                                                                -
                                                                                                -
                                                                                                - $html - : string -
                                                                                                -
                                                                                                -
                                                                                                - -
                                                                                                -
                                                                                                - - - -
                                                                                                Return values
                                                                                                - PdfWriter - — - - -
                                                                                                -
                                                                                                -

                                                                                                - setTemplate() - -

                                                                                                - - -

                                                                                                Set the master template path.

                                                                                                - - - public - setTemplate(string $template) : PdfWriter - - -
                                                                                                Parameters
                                                                                                -
                                                                                                -
                                                                                                - $template - : string -
                                                                                                -
                                                                                                -
                                                                                                - -
                                                                                                -
                                                                                                - - - -
                                                                                                Return values
                                                                                                - PdfWriter - — -

                                                                                                Current pdf writer instance

                                                                                                -
                                                                                                - - -
                                                                                                -
                                                                                                - - - - -
                                                                                                -
                                                                                                -
                                                                                                -
                                                                                                -

                                                                                                Search results

                                                                                                - -
                                                                                                -
                                                                                                -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  - - -
                                                                                                  - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-PdfCreator-AbstractPdfCreator.html b/classes/HeimrichHannot-UtilsBundle-PdfCreator-AbstractPdfCreator.html deleted file mode 100644 index 86051231..00000000 --- a/classes/HeimrichHannot-UtilsBundle-PdfCreator-AbstractPdfCreator.html +++ /dev/null @@ -1,2435 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                  -

                                                                                                  Contao Utils Bundle

                                                                                                  - - -
                                                                                                  - -
                                                                                                  - - -
                                                                                                  - -
                                                                                                  -
                                                                                                  - - - - -
                                                                                                  - - -
                                                                                                  -

                                                                                                  - AbstractPdfCreator - - -
                                                                                                  - in package - -
                                                                                                  - - -

                                                                                                  - - - -

                                                                                                  Class AbstractPdfCreator.

                                                                                                  - - - -
                                                                                                  - Tags - -
                                                                                                  -
                                                                                                  -
                                                                                                  - deprecated -
                                                                                                  -
                                                                                                  - -

                                                                                                  PdfCreator was moved into it's own bundle (heimrichhannot/pdf-creator)

                                                                                                  -
                                                                                                  - -
                                                                                                  -
                                                                                                  - - - - - - -

                                                                                                  - Table of Contents - -

                                                                                                  - -
                                                                                                  -
                                                                                                  - FONT_STYLE_BOLD - -  = 'bold' -
                                                                                                  -
                                                                                                  - -
                                                                                                  - FONT_STYLE_BOLDITALIC - -  = 'bolditalic' -
                                                                                                  -
                                                                                                  - -
                                                                                                  - FONT_STYLE_ITALIC - -  = 'italic' -
                                                                                                  -
                                                                                                  - -
                                                                                                  - FONT_STYLE_REGUALAR - -  = 'regular' -
                                                                                                  -
                                                                                                  - -
                                                                                                  - ORIENTATION_LANDSCAPE - -  = 'landscape' -
                                                                                                  -
                                                                                                  - -
                                                                                                  - ORIENTATION_PORTRAIT - -  = 'portrait' -
                                                                                                  -
                                                                                                  - -
                                                                                                  - OUTPUT_MODE_DOWNLOAD - -  = 'download' -
                                                                                                  -
                                                                                                  - -
                                                                                                  - OUTPUT_MODE_FILE - -  = 'file' -
                                                                                                  -
                                                                                                  - -
                                                                                                  - OUTPUT_MODE_INLINE - -  = 'inline' -
                                                                                                  -
                                                                                                  - -
                                                                                                  - OUTPUT_MODE_STRING - -  = 'string' -
                                                                                                  -
                                                                                                  - -
                                                                                                  - OUTPUT_MODES - -  = [self::OUTPUT_MODE_DOWNLOAD, self::OUTPUT_MODE_FILE, self::OUTPUT_MODE_INLINE, self::OUTPUT_MODE_STRING] -
                                                                                                  -
                                                                                                  - -
                                                                                                  - $beforeCreateInstanceCallback - -  : callable|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  - $beforeOutputPdfCallback - -  : callable|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  - $filename - -  : string|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  - $folder - -  : string|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  - $fonts - -  : array<string|int, mixed>|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  - $format - -  : array<string|int, mixed>|string|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  - $htmlContent - -  : string|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  - $margins - -  : array<string|int, mixed>|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  - $mediaType - -  : string|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  - $orientation - -  : string|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  - $outputMode - -  : string|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  - $templateFilePath - -  : string|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  - addFont() - -  : $this -
                                                                                                  -
                                                                                                  - -
                                                                                                  - getBeforeCreateInstanceCallback() - -  : callable|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  - getBeforeOutputPdfCallback() - -  : callable|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  - getFilename() - -  : string -
                                                                                                  -
                                                                                                  - -
                                                                                                  - getFolder() - -  : string|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  - getFonts() - -  : array<string|int, mixed>|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  - getFormat() - -  : string|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  - getHtmlContent() - -  : mixed -
                                                                                                  -
                                                                                                  - -
                                                                                                  - getMargins() - -  : array<string|int, mixed>|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  - getMediaType() - -  : string|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  - getOrientation() - -  : string|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  - getOutputMode() - -  : string -
                                                                                                  -
                                                                                                  - -
                                                                                                  - getSupportedOutputModes() - -  : array<string|int, mixed> -
                                                                                                  -
                                                                                                  - -
                                                                                                  - getTemplateFilePath() - -  : string|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  - getType() - -  : string -
                                                                                                  -
                                                                                                  Return an unique type alias.
                                                                                                  - -
                                                                                                  - render() - -  : void -
                                                                                                  -
                                                                                                  - -
                                                                                                  - setBeforeCreateInstanceCallback() - -  : self -
                                                                                                  -
                                                                                                  Add an callback to modify constructor parameters for pdf library.
                                                                                                  - -
                                                                                                  - setBeforeOutputPdfCallback() - -  : self -
                                                                                                  -
                                                                                                  Add an callback to modify the configuration or parameters before outputting the pdf file.
                                                                                                  - -
                                                                                                  - setFilename() - -  : self -
                                                                                                  -
                                                                                                  - -
                                                                                                  - setFolder() - -  : self -
                                                                                                  -
                                                                                                  Absolute folder where to store pdf.
                                                                                                  - -
                                                                                                  - setFonts() - -  : self -
                                                                                                  -
                                                                                                  - -
                                                                                                  - setFormat() - -  : $this -
                                                                                                  -
                                                                                                  Set the document format.
                                                                                                  - -
                                                                                                  - setHtmlContent() - -  : self -
                                                                                                  -
                                                                                                  - -
                                                                                                  - setMargins() - -  : self -
                                                                                                  -
                                                                                                  Set document margins.
                                                                                                  - -
                                                                                                  - setMediaType() - -  : self -
                                                                                                  -
                                                                                                  - -
                                                                                                  - setOrientation() - -  : self -
                                                                                                  -
                                                                                                  Set orientation. Use AbstractPdfCreator::ORIENTATION_LANDSCAPE or AbstractPdfCreator::ORIENTATION_PORTRAIT.
                                                                                                  - -
                                                                                                  - setOutputMode() - -  : self -
                                                                                                  -
                                                                                                  - -
                                                                                                  - setTemplateFilePath() - -  : self -
                                                                                                  -
                                                                                                  Set the absolute path to a pdf template file.
                                                                                                  - -
                                                                                                  - - - - -
                                                                                                  -

                                                                                                  - Constants - -

                                                                                                  -
                                                                                                  -

                                                                                                  - FONT_STYLE_BOLD - -

                                                                                                  - - - - - - public - mixed - FONT_STYLE_BOLD - = 'bold' - - - -
                                                                                                  - -
                                                                                                  - - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - FONT_STYLE_BOLDITALIC - -

                                                                                                  - - - - - - public - mixed - FONT_STYLE_BOLDITALIC - = 'bolditalic' - - - -
                                                                                                  - -
                                                                                                  - - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - FONT_STYLE_ITALIC - -

                                                                                                  - - - - - - public - mixed - FONT_STYLE_ITALIC - = 'italic' - - - -
                                                                                                  - -
                                                                                                  - - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - FONT_STYLE_REGUALAR - -

                                                                                                  - - - - - - public - mixed - FONT_STYLE_REGUALAR - = 'regular' - - - -
                                                                                                  - -
                                                                                                  - - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - ORIENTATION_LANDSCAPE - -

                                                                                                  - - - - - - public - mixed - ORIENTATION_LANDSCAPE - = 'landscape' - - - -
                                                                                                  - -
                                                                                                  - - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - ORIENTATION_PORTRAIT - -

                                                                                                  - - - - - - public - mixed - ORIENTATION_PORTRAIT - = 'portrait' - - - -
                                                                                                  - -
                                                                                                  - - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - OUTPUT_MODE_DOWNLOAD - -

                                                                                                  - - - - - - public - mixed - OUTPUT_MODE_DOWNLOAD - = 'download' - - - -
                                                                                                  - -
                                                                                                  - - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - OUTPUT_MODE_FILE - -

                                                                                                  - - - - - - public - mixed - OUTPUT_MODE_FILE - = 'file' - - - -
                                                                                                  - -
                                                                                                  - - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - OUTPUT_MODE_INLINE - -

                                                                                                  - - - - - - public - mixed - OUTPUT_MODE_INLINE - = 'inline' - - - -
                                                                                                  - -
                                                                                                  - - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - OUTPUT_MODE_STRING - -

                                                                                                  - - - - - - public - mixed - OUTPUT_MODE_STRING - = 'string' - - - -
                                                                                                  - -
                                                                                                  - - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - OUTPUT_MODES - -

                                                                                                  - - - - - - public - mixed - OUTPUT_MODES - = [self::OUTPUT_MODE_DOWNLOAD, self::OUTPUT_MODE_FILE, self::OUTPUT_MODE_INLINE, self::OUTPUT_MODE_STRING] - - - -
                                                                                                  - -
                                                                                                  - - - -
                                                                                                  -
                                                                                                  - - -
                                                                                                  -

                                                                                                  - Properties - -

                                                                                                  -
                                                                                                  -

                                                                                                  - $beforeCreateInstanceCallback - - - -

                                                                                                  - - - - - protected - callable|null - $beforeCreateInstanceCallback - - - - - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - $beforeOutputPdfCallback - - - -

                                                                                                  - - - - - protected - callable|null - $beforeOutputPdfCallback - - - - - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - $filename - - - -

                                                                                                  - - - - - protected - string|null - $filename - - - - - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - $folder - - - -

                                                                                                  - - - - - protected - string|null - $folder - - - - - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - $fonts - - - -

                                                                                                  - - - - - protected - array<string|int, mixed>|null - $fonts - - - - - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - $format - - - -

                                                                                                  - - - - - protected - array<string|int, mixed>|string|null - $format - - - - - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - $htmlContent - - - -

                                                                                                  - - - - - protected - string|null - $htmlContent - - - - - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - $margins - - - -

                                                                                                  - - - - - protected - array<string|int, mixed>|null - $margins - - - - - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - $mediaType - - - -

                                                                                                  - - - - - protected - string|null - $mediaType - - - - - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - $orientation - - - -

                                                                                                  - - - - - protected - string|null - $orientation - - - - - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - $outputMode - - - -

                                                                                                  - - - - - protected - string|null - $outputMode - - - - - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - $templateFilePath - - - -

                                                                                                  - - - - - protected - string|null - $templateFilePath - - - - - - -
                                                                                                  -
                                                                                                  - -
                                                                                                  -

                                                                                                  - Methods - -

                                                                                                  -
                                                                                                  -

                                                                                                  - addFont() - -

                                                                                                  - - - - - public - addFont(string $filepath, string $family, string $style, string $weight) : $this - - -
                                                                                                  Parameters
                                                                                                  -
                                                                                                  -
                                                                                                  - $filepath - : string -
                                                                                                  -
                                                                                                  -

                                                                                                  Absolute filepath to the font file

                                                                                                  -
                                                                                                  - -
                                                                                                  -
                                                                                                  - $family - : string -
                                                                                                  -
                                                                                                  -

                                                                                                  Font family name

                                                                                                  -
                                                                                                  - -
                                                                                                  -
                                                                                                  - $style - : string -
                                                                                                  -
                                                                                                  -

                                                                                                  Font style (regular, italic, ...), see AbstractPdfCreator::FONT_STYLE constants

                                                                                                  -
                                                                                                  - -
                                                                                                  -
                                                                                                  - $weight - : string -
                                                                                                  -
                                                                                                  -

                                                                                                  Font weight

                                                                                                  -
                                                                                                  - -
                                                                                                  -
                                                                                                  - - - -
                                                                                                  Return values
                                                                                                  - $this - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - getBeforeCreateInstanceCallback() - -

                                                                                                  - - - - - public - getBeforeCreateInstanceCallback() : callable|null - -
                                                                                                  - - - - -
                                                                                                  Return values
                                                                                                  - callable|null - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - getBeforeOutputPdfCallback() - -

                                                                                                  - - - - - public - getBeforeOutputPdfCallback() : callable|null - -
                                                                                                  - - - - -
                                                                                                  Return values
                                                                                                  - callable|null - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - getFilename() - -

                                                                                                  - - - - - public - getFilename() : string - - - - - -
                                                                                                  Return values
                                                                                                  - string - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - getFolder() - -

                                                                                                  - - - - - public - getFolder() : string|null - -
                                                                                                  - - - - -
                                                                                                  Return values
                                                                                                  - string|null - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - getFonts() - -

                                                                                                  - - - - - public - getFonts() : array<string|int, mixed>|null - -
                                                                                                  - - - - -
                                                                                                  Return values
                                                                                                  - array<string|int, mixed>|null - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - getFormat() - -

                                                                                                  - - - - - public - getFormat() : string|null - -
                                                                                                  - - - - -
                                                                                                  Return values
                                                                                                  - string|null - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - getHtmlContent() - -

                                                                                                  - - - - - public - getHtmlContent() : mixed - - - - - -
                                                                                                  Return values
                                                                                                  - mixed - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - getMargins() - -

                                                                                                  - - - - - public - getMargins() : array<string|int, mixed>|null - -
                                                                                                  - - - - -
                                                                                                  Return values
                                                                                                  - array<string|int, mixed>|null - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - getMediaType() - -

                                                                                                  - - - - - public - getMediaType() : string|null - -
                                                                                                  - - - - -
                                                                                                  Return values
                                                                                                  - string|null - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - getOrientation() - -

                                                                                                  - - - - - public - getOrientation() : string|null - -
                                                                                                  - - - - -
                                                                                                  Return values
                                                                                                  - string|null - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - getOutputMode() - -

                                                                                                  - - - - - public - getOutputMode() : string - - - - - -
                                                                                                  Return values
                                                                                                  - string - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - getSupportedOutputModes() - -

                                                                                                  - - - - - public - abstract getSupportedOutputModes() : array<string|int, mixed> - -
                                                                                                  - - - - -
                                                                                                  Return values
                                                                                                  - array<string|int, mixed> - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - getTemplateFilePath() - -

                                                                                                  - - - - - public - getTemplateFilePath() : string|null - -
                                                                                                  - - - - -
                                                                                                  Return values
                                                                                                  - string|null - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - getType() - -

                                                                                                  - - -

                                                                                                  Return an unique type alias.

                                                                                                  - - - public - abstract static getType() : string - - - - - -
                                                                                                  Return values
                                                                                                  - string - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - render() - -

                                                                                                  - - - - - public - abstract render() : void - -
                                                                                                  - - - - -
                                                                                                  Return values
                                                                                                  - void - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - setBeforeCreateInstanceCallback() - -

                                                                                                  - - -

                                                                                                  Add an callback to modify constructor parameters for pdf library.

                                                                                                  - - - public - setBeforeCreateInstanceCallback(callable|null $beforeCreateInstanceCallback) : self - -

                                                                                                  Callback gets an BeforeCreateLibraryInstanceCallback object as parameter and should return an BeforeCreateLibraryInstanceCallback object.

                                                                                                  -
                                                                                                  - -
                                                                                                  Parameters
                                                                                                  -
                                                                                                  -
                                                                                                  - $beforeCreateInstanceCallback - : callable|null -
                                                                                                  -
                                                                                                  -
                                                                                                  - -
                                                                                                  -
                                                                                                  - - - -
                                                                                                  Return values
                                                                                                  - self - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - setBeforeOutputPdfCallback() - -

                                                                                                  - - -

                                                                                                  Add an callback to modify the configuration or parameters before outputting the pdf file.

                                                                                                  - - - public - setBeforeOutputPdfCallback(callable|null $beforeOutputPdfCallback) : self - -

                                                                                                  Callback gets an BeforeOutputPdfCallback object as parameter and should return an BeforeOutputPdfCallback object.

                                                                                                  -
                                                                                                  - -
                                                                                                  Parameters
                                                                                                  -
                                                                                                  -
                                                                                                  - $beforeOutputPdfCallback - : callable|null -
                                                                                                  -
                                                                                                  -
                                                                                                  - -
                                                                                                  -
                                                                                                  - - - -
                                                                                                  Return values
                                                                                                  - self - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - setFilename() - -

                                                                                                  - - - - - public - setFilename(string $filename) : self - -
                                                                                                  - -
                                                                                                  Parameters
                                                                                                  -
                                                                                                  -
                                                                                                  - $filename - : string -
                                                                                                  -
                                                                                                  -
                                                                                                  - -
                                                                                                  -
                                                                                                  - - - -
                                                                                                  Return values
                                                                                                  - self - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - setFolder() - -

                                                                                                  - - -

                                                                                                  Absolute folder where to store pdf.

                                                                                                  - - - public - setFolder(string $folder) : self - - -
                                                                                                  Parameters
                                                                                                  -
                                                                                                  -
                                                                                                  - $folder - : string -
                                                                                                  -
                                                                                                  -
                                                                                                  - -
                                                                                                  -
                                                                                                  - - - -
                                                                                                  Return values
                                                                                                  - self - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - setFonts() - -

                                                                                                  - - - - - public - setFonts(array<string|int, mixed> $fonts) : self - -
                                                                                                  - -
                                                                                                  Parameters
                                                                                                  -
                                                                                                  -
                                                                                                  - $fonts - : array<string|int, mixed> -
                                                                                                  -
                                                                                                  -
                                                                                                  - -
                                                                                                  -
                                                                                                  - - - -
                                                                                                  Return values
                                                                                                  - self - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - setFormat() - -

                                                                                                  - - -

                                                                                                  Set the document format.

                                                                                                  - - - public - setFormat(string|array<string|int, mixed> $format) : $this - - -
                                                                                                  Parameters
                                                                                                  -
                                                                                                  -
                                                                                                  - $format - : string|array<string|int, mixed> -
                                                                                                  -
                                                                                                  -

                                                                                                  A format type like A4, A5, Letter, Legal,... or an array of integers (width and height in mm).

                                                                                                  -
                                                                                                  - -
                                                                                                  -
                                                                                                  - - - -
                                                                                                  Return values
                                                                                                  - $this - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - setHtmlContent() - -

                                                                                                  - - - - - public - setHtmlContent(mixed $htmlContent) : self - - -
                                                                                                  Parameters
                                                                                                  -
                                                                                                  -
                                                                                                  - $htmlContent - : mixed -
                                                                                                  -
                                                                                                  - -
                                                                                                  -
                                                                                                  - - - -
                                                                                                  Return values
                                                                                                  - self - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - setMargins() - -

                                                                                                  - - -

                                                                                                  Set document margins.

                                                                                                  - - - public - setMargins(int|null $top[, int|null $right = null ][, int|null $bottom = null ][, int|null $left = null ]) : self - - -
                                                                                                  Parameters
                                                                                                  -
                                                                                                  -
                                                                                                  - $top - : int|null -
                                                                                                  -
                                                                                                  -
                                                                                                  - -
                                                                                                  -
                                                                                                  - $right - : int|null - = null
                                                                                                  -
                                                                                                  -
                                                                                                  - -
                                                                                                  -
                                                                                                  - $bottom - : int|null - = null
                                                                                                  -
                                                                                                  -
                                                                                                  - -
                                                                                                  -
                                                                                                  - $left - : int|null - = null
                                                                                                  -
                                                                                                  -
                                                                                                  - -
                                                                                                  -
                                                                                                  - - - -
                                                                                                  Return values
                                                                                                  - self - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - setMediaType() - -

                                                                                                  - - - - - public - setMediaType(string|null $mediaType) : self - - -
                                                                                                  Parameters
                                                                                                  -
                                                                                                  -
                                                                                                  - $mediaType - : string|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  -
                                                                                                  - - - -
                                                                                                  Return values
                                                                                                  - self - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - setOrientation() - -

                                                                                                  - - -

                                                                                                  Set orientation. Use AbstractPdfCreator::ORIENTATION_LANDSCAPE or AbstractPdfCreator::ORIENTATION_PORTRAIT.

                                                                                                  - - - public - setOrientation(string $orientation) : self - - -
                                                                                                  Parameters
                                                                                                  -
                                                                                                  -
                                                                                                  - $orientation - : string -
                                                                                                  -
                                                                                                  -
                                                                                                  - -
                                                                                                  -
                                                                                                  - - - -
                                                                                                  Return values
                                                                                                  - self - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - setOutputMode() - -

                                                                                                  - - - - - public - setOutputMode(string $outputMode) : self - -
                                                                                                  - -
                                                                                                  Parameters
                                                                                                  -
                                                                                                  -
                                                                                                  - $outputMode - : string -
                                                                                                  -
                                                                                                  -
                                                                                                  - -
                                                                                                  -
                                                                                                  - - - -
                                                                                                  Return values
                                                                                                  - self - — - - -
                                                                                                  -
                                                                                                  -

                                                                                                  - setTemplateFilePath() - -

                                                                                                  - - -

                                                                                                  Set the absolute path to a pdf template file.

                                                                                                  - - - public - setTemplateFilePath(string|null $templateFilePath) : self - - -
                                                                                                  Parameters
                                                                                                  -
                                                                                                  -
                                                                                                  - $templateFilePath - : string|null -
                                                                                                  -
                                                                                                  - -
                                                                                                  -
                                                                                                  - - - -
                                                                                                  Return values
                                                                                                  - self - — - - -
                                                                                                  -
                                                                                                  - - - - -
                                                                                                  -
                                                                                                  -
                                                                                                  -
                                                                                                  -

                                                                                                  Search results

                                                                                                  - -
                                                                                                  -
                                                                                                  -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    - - -
                                                                                                    - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-PdfCreator-BeforeCreateLibraryInstanceCallback.html b/classes/HeimrichHannot-UtilsBundle-PdfCreator-BeforeCreateLibraryInstanceCallback.html deleted file mode 100644 index 170420fd..00000000 --- a/classes/HeimrichHannot-UtilsBundle-PdfCreator-BeforeCreateLibraryInstanceCallback.html +++ /dev/null @@ -1,435 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                    -

                                                                                                    Contao Utils Bundle

                                                                                                    - - -
                                                                                                    - -
                                                                                                    - - -
                                                                                                    - -
                                                                                                    -
                                                                                                    - - - - -
                                                                                                    - - -
                                                                                                    -

                                                                                                    - BeforeCreateLibraryInstanceCallback - - -
                                                                                                    - in package - -
                                                                                                    - - -

                                                                                                    - - - -

                                                                                                    Class BeforeCreateLibraryInstanceCallback.

                                                                                                    - - - -
                                                                                                    - Tags - -
                                                                                                    -
                                                                                                    -
                                                                                                    - deprecated -
                                                                                                    -
                                                                                                    - -

                                                                                                    PdfCreator was moved into it's own bundle (heimrichhannot/pdf-creator)

                                                                                                    -
                                                                                                    - -
                                                                                                    -
                                                                                                    - - - - - - -

                                                                                                    - Table of Contents - -

                                                                                                    - -
                                                                                                    -
                                                                                                    - $constructorParameters - -  : array<string|int, mixed> -
                                                                                                    -
                                                                                                    - -
                                                                                                    - __construct() - -  : mixed -
                                                                                                    -
                                                                                                    BeforeCreateLibraryInstanceCallback constructor.
                                                                                                    - -
                                                                                                    - getConstructorParameters() - -  : array<string|int, mixed> -
                                                                                                    -
                                                                                                    - -
                                                                                                    - setConstructorParameters() - -  : void -
                                                                                                    -
                                                                                                    - -
                                                                                                    - - - - - - -
                                                                                                    -

                                                                                                    - Properties - -

                                                                                                    - -
                                                                                                    - -
                                                                                                    -

                                                                                                    - Methods - -

                                                                                                    -
                                                                                                    -

                                                                                                    - __construct() - -

                                                                                                    - - -

                                                                                                    BeforeCreateLibraryInstanceCallback constructor.

                                                                                                    - - - public - __construct([array<string|int, mixed> $constructorParameters = [] ]) : mixed - - -
                                                                                                    Parameters
                                                                                                    -
                                                                                                    -
                                                                                                    - $constructorParameters - : array<string|int, mixed> - = []
                                                                                                    -
                                                                                                    -
                                                                                                    - -
                                                                                                    -
                                                                                                    - - - -
                                                                                                    Return values
                                                                                                    - mixed - — - - -
                                                                                                    -
                                                                                                    -

                                                                                                    - getConstructorParameters() - -

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

                                                                                                    - setConstructorParameters() - -

                                                                                                    - - - - - public - setConstructorParameters(array<string|int, mixed> $constructorParameters) : void - -
                                                                                                    - -
                                                                                                    Parameters
                                                                                                    -
                                                                                                    -
                                                                                                    - $constructorParameters - : array<string|int, mixed> -
                                                                                                    -
                                                                                                    -
                                                                                                    - -
                                                                                                    -
                                                                                                    - - - -
                                                                                                    Return values
                                                                                                    - void - — - - -
                                                                                                    -
                                                                                                    - - - - -
                                                                                                    -
                                                                                                    -
                                                                                                    -
                                                                                                    -

                                                                                                    Search results

                                                                                                    - -
                                                                                                    -
                                                                                                    -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      - - -
                                                                                                      - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-PdfCreator-BeforeOutputPdfCallback.html b/classes/HeimrichHannot-UtilsBundle-PdfCreator-BeforeOutputPdfCallback.html deleted file mode 100644 index d9743bac..00000000 --- a/classes/HeimrichHannot-UtilsBundle-PdfCreator-BeforeOutputPdfCallback.html +++ /dev/null @@ -1,572 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                      -

                                                                                                      Contao Utils Bundle

                                                                                                      - - -
                                                                                                      - -
                                                                                                      - - -
                                                                                                      - -
                                                                                                      -
                                                                                                      - - - - -
                                                                                                      - - -
                                                                                                      -

                                                                                                      - BeforeOutputPdfCallback - - -
                                                                                                      - in package - -
                                                                                                      - - -

                                                                                                      - - - -

                                                                                                      Class BeforeOutputPdfCallback.

                                                                                                      - - - -
                                                                                                      - Tags - -
                                                                                                      -
                                                                                                      -
                                                                                                      - deprecated -
                                                                                                      -
                                                                                                      - -

                                                                                                      PdfCreator was moved into it's own bundle (heimrichhannot/pdf-creator)

                                                                                                      -
                                                                                                      - -
                                                                                                      -
                                                                                                      - - - - - - -

                                                                                                      - Table of Contents - -

                                                                                                      - -
                                                                                                      -
                                                                                                      - $libraryInstance - -  : mixed -
                                                                                                      -
                                                                                                      - -
                                                                                                      - $outputParameters - -  : array<string|int, mixed> -
                                                                                                      -
                                                                                                      - -
                                                                                                      - __construct() - -  : mixed -
                                                                                                      -
                                                                                                      - -
                                                                                                      - getLibraryInstance() - -  : mixed -
                                                                                                      -
                                                                                                      - -
                                                                                                      - getOutputParameters() - -  : array<string|int, mixed> -
                                                                                                      -
                                                                                                      - -
                                                                                                      - setLibraryInstance() - -  : void -
                                                                                                      -
                                                                                                      - -
                                                                                                      - setOutputParameters() - -  : void -
                                                                                                      -
                                                                                                      - -
                                                                                                      - - - - - - -
                                                                                                      -

                                                                                                      - Properties - -

                                                                                                      -
                                                                                                      -

                                                                                                      - $libraryInstance - - - -

                                                                                                      - - - - - protected - mixed - $libraryInstance - - -
                                                                                                      - -
                                                                                                      - - - -
                                                                                                      -
                                                                                                      -

                                                                                                      - $outputParameters - - - -

                                                                                                      - - - - - protected - array<string|int, mixed> - $outputParameters - - - - - - -
                                                                                                      -
                                                                                                      - -
                                                                                                      -

                                                                                                      - Methods - -

                                                                                                      -
                                                                                                      -

                                                                                                      - __construct() - -

                                                                                                      - - - - - public - __construct(mixed $libraryInstance[, array<string|int, mixed> $outputParameters = [] ]) : mixed - -
                                                                                                      - -
                                                                                                      Parameters
                                                                                                      -
                                                                                                      -
                                                                                                      - $libraryInstance - : mixed -
                                                                                                      -
                                                                                                      -
                                                                                                      - -
                                                                                                      -
                                                                                                      - $outputParameters - : array<string|int, mixed> - = []
                                                                                                      -
                                                                                                      -
                                                                                                      - -
                                                                                                      -
                                                                                                      - - - -
                                                                                                      Return values
                                                                                                      - mixed - — - - -
                                                                                                      -
                                                                                                      -

                                                                                                      - getLibraryInstance() - -

                                                                                                      - - - - - public - getLibraryInstance() : mixed - - - - - -
                                                                                                      Return values
                                                                                                      - mixed - — - - -
                                                                                                      -
                                                                                                      -

                                                                                                      - getOutputParameters() - -

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

                                                                                                      - setLibraryInstance() - -

                                                                                                      - - - - - public - setLibraryInstance(mixed $libraryInstance) : void - - -
                                                                                                      Parameters
                                                                                                      -
                                                                                                      -
                                                                                                      - $libraryInstance - : mixed -
                                                                                                      -
                                                                                                      - -
                                                                                                      -
                                                                                                      - - - -
                                                                                                      Return values
                                                                                                      - void - — - - -
                                                                                                      -
                                                                                                      -

                                                                                                      - setOutputParameters() - -

                                                                                                      - - - - - public - setOutputParameters(array<string|int, mixed> $outputParameters) : void - -
                                                                                                      - -
                                                                                                      Parameters
                                                                                                      -
                                                                                                      -
                                                                                                      - $outputParameters - : array<string|int, mixed> -
                                                                                                      -
                                                                                                      -
                                                                                                      - -
                                                                                                      -
                                                                                                      - - - -
                                                                                                      Return values
                                                                                                      - void - — - - -
                                                                                                      -
                                                                                                      - - - - -
                                                                                                      -
                                                                                                      -
                                                                                                      -
                                                                                                      -

                                                                                                      Search results

                                                                                                      - -
                                                                                                      -
                                                                                                      -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        - - -
                                                                                                        - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-PdfCreator-Concrete-MpdfCreator.html b/classes/HeimrichHannot-UtilsBundle-PdfCreator-Concrete-MpdfCreator.html deleted file mode 100644 index d98c3c6b..00000000 --- a/classes/HeimrichHannot-UtilsBundle-PdfCreator-Concrete-MpdfCreator.html +++ /dev/null @@ -1,2771 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                        -

                                                                                                        Contao Utils Bundle

                                                                                                        - - -
                                                                                                        - -
                                                                                                        - - -
                                                                                                        - -
                                                                                                        -
                                                                                                        - - - - -
                                                                                                        - - -
                                                                                                        -

                                                                                                        - MpdfCreator - - - extends AbstractPdfCreator - - -
                                                                                                        - in package - -
                                                                                                        - - -

                                                                                                        - - - -

                                                                                                        Class MpdfCreator.

                                                                                                        - - - -
                                                                                                        - Tags - -
                                                                                                        -
                                                                                                        -
                                                                                                        - deprecated -
                                                                                                        -
                                                                                                        - -

                                                                                                        PdfCreator was moved into it's own bundle (heimrichhannot/pdf-creator)

                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - - - - - - -

                                                                                                        - Table of Contents - -

                                                                                                        - -
                                                                                                        -
                                                                                                        - FONT_STYLE_BOLD - -  = 'bold' -
                                                                                                        -
                                                                                                        - -
                                                                                                        - FONT_STYLE_BOLDITALIC - -  = 'bolditalic' -
                                                                                                        -
                                                                                                        - -
                                                                                                        - FONT_STYLE_ITALIC - -  = 'italic' -
                                                                                                        -
                                                                                                        - -
                                                                                                        - FONT_STYLE_REGUALAR - -  = 'regular' -
                                                                                                        -
                                                                                                        - -
                                                                                                        - ORIENTATION_LANDSCAPE - -  = 'landscape' -
                                                                                                        -
                                                                                                        - -
                                                                                                        - ORIENTATION_PORTRAIT - -  = 'portrait' -
                                                                                                        -
                                                                                                        - -
                                                                                                        - OUTPUT_MODE_DOWNLOAD - -  = 'download' -
                                                                                                        -
                                                                                                        - -
                                                                                                        - OUTPUT_MODE_FILE - -  = 'file' -
                                                                                                        -
                                                                                                        - -
                                                                                                        - OUTPUT_MODE_INLINE - -  = 'inline' -
                                                                                                        -
                                                                                                        - -
                                                                                                        - OUTPUT_MODE_STRING - -  = 'string' -
                                                                                                        -
                                                                                                        - -
                                                                                                        - OUTPUT_MODES - -  = [self::OUTPUT_MODE_DOWNLOAD, self::OUTPUT_MODE_FILE, self::OUTPUT_MODE_INLINE, self::OUTPUT_MODE_STRING] -
                                                                                                        -
                                                                                                        - -
                                                                                                        - $beforeCreateInstanceCallback - -  : callable|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        - $beforeOutputPdfCallback - -  : callable|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        - $filename - -  : string|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        - $folder - -  : string|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        - $fonts - -  : array<string|int, mixed>|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        - $format - -  : array<string|int, mixed>|string|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        - $htmlContent - -  : string|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        - $legacyFontDirectoryConfig - -  : array<string|int, mixed> -
                                                                                                        -
                                                                                                        - -
                                                                                                        - $margins - -  : array<string|int, mixed>|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        - $mediaType - -  : string|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        - $orientation - -  : string|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        - $outputMode - -  : string|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        - $templateFilePath - -  : string|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        - __construct() - -  : mixed -
                                                                                                        -
                                                                                                        MpdfCreator constructor.
                                                                                                        - -
                                                                                                        - addFont() - -  : $this -
                                                                                                        -
                                                                                                        - -
                                                                                                        - addFontDirectories() - -  : self -
                                                                                                        -
                                                                                                        Add font directories to the config. Directory must contain mpdf-config.php.
                                                                                                        - -
                                                                                                        - getBeforeCreateInstanceCallback() - -  : callable|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        - getBeforeOutputPdfCallback() - -  : callable|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        - getFilename() - -  : string -
                                                                                                        -
                                                                                                        - -
                                                                                                        - getFolder() - -  : string|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        - getFonts() - -  : array<string|int, mixed>|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        - getFormat() - -  : string|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        - getHtmlContent() - -  : mixed -
                                                                                                        -
                                                                                                        - -
                                                                                                        - getMargins() - -  : array<string|int, mixed>|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        - getMediaType() - -  : string|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        - getOrientation() - -  : string|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        - getOutputMode() - -  : string -
                                                                                                        -
                                                                                                        - -
                                                                                                        - getSupportedOutputModes() - -  : array<string|int, mixed> -
                                                                                                        -
                                                                                                        - -
                                                                                                        - getTemplateFilePath() - -  : string|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        - getType() - -  : string -
                                                                                                        -
                                                                                                        Return an unique type alias.
                                                                                                        - -
                                                                                                        - render() - -  : void -
                                                                                                        -
                                                                                                        - -
                                                                                                        - setBeforeCreateInstanceCallback() - -  : self -
                                                                                                        -
                                                                                                        Add an callback to modify constructor parameters for pdf library.
                                                                                                        - -
                                                                                                        - setBeforeOutputPdfCallback() - -  : self -
                                                                                                        -
                                                                                                        Add an callback to modify the configuration or parameters before outputting the pdf file.
                                                                                                        - -
                                                                                                        - setFilename() - -  : self -
                                                                                                        -
                                                                                                        - -
                                                                                                        - setFolder() - -  : self -
                                                                                                        -
                                                                                                        Absolute folder where to store pdf.
                                                                                                        - -
                                                                                                        - setFonts() - -  : self -
                                                                                                        -
                                                                                                        - -
                                                                                                        - setFormat() - -  : $this -
                                                                                                        -
                                                                                                        Set the document format.
                                                                                                        - -
                                                                                                        - setHtmlContent() - -  : self -
                                                                                                        -
                                                                                                        - -
                                                                                                        - setMargins() - -  : self -
                                                                                                        -
                                                                                                        Set document margins.
                                                                                                        - -
                                                                                                        - setMediaType() - -  : self -
                                                                                                        -
                                                                                                        - -
                                                                                                        - setOrientation() - -  : self -
                                                                                                        -
                                                                                                        Set orientation. Use AbstractPdfCreator::ORIENTATION_LANDSCAPE or AbstractPdfCreator::ORIENTATION_PORTRAIT.
                                                                                                        - -
                                                                                                        - setOutputMode() - -  : self -
                                                                                                        -
                                                                                                        - -
                                                                                                        - setTemplateFilePath() - -  : self -
                                                                                                        -
                                                                                                        Set the absolute path to a pdf template file.
                                                                                                        - -
                                                                                                        - applyDocumentFormatConfiguration() - -  : array<string|int, mixed> -
                                                                                                        -
                                                                                                        - -
                                                                                                        - applyFonts() - -  : array<string|int, mixed> -
                                                                                                        -
                                                                                                        - -
                                                                                                        - applyTemplate() - -  : void -
                                                                                                        -
                                                                                                        - -
                                                                                                        - - - - -
                                                                                                        -

                                                                                                        - Constants - -

                                                                                                        -
                                                                                                        -

                                                                                                        - FONT_STYLE_BOLD - -

                                                                                                        - - - - - - public - mixed - FONT_STYLE_BOLD - = 'bold' - - - -
                                                                                                        - -
                                                                                                        - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - FONT_STYLE_BOLDITALIC - -

                                                                                                        - - - - - - public - mixed - FONT_STYLE_BOLDITALIC - = 'bolditalic' - - - -
                                                                                                        - -
                                                                                                        - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - FONT_STYLE_ITALIC - -

                                                                                                        - - - - - - public - mixed - FONT_STYLE_ITALIC - = 'italic' - - - -
                                                                                                        - -
                                                                                                        - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - FONT_STYLE_REGUALAR - -

                                                                                                        - - - - - - public - mixed - FONT_STYLE_REGUALAR - = 'regular' - - - -
                                                                                                        - -
                                                                                                        - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - ORIENTATION_LANDSCAPE - -

                                                                                                        - - - - - - public - mixed - ORIENTATION_LANDSCAPE - = 'landscape' - - - -
                                                                                                        - -
                                                                                                        - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - ORIENTATION_PORTRAIT - -

                                                                                                        - - - - - - public - mixed - ORIENTATION_PORTRAIT - = 'portrait' - - - -
                                                                                                        - -
                                                                                                        - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - OUTPUT_MODE_DOWNLOAD - -

                                                                                                        - - - - - - public - mixed - OUTPUT_MODE_DOWNLOAD - = 'download' - - - -
                                                                                                        - -
                                                                                                        - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - OUTPUT_MODE_FILE - -

                                                                                                        - - - - - - public - mixed - OUTPUT_MODE_FILE - = 'file' - - - -
                                                                                                        - -
                                                                                                        - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - OUTPUT_MODE_INLINE - -

                                                                                                        - - - - - - public - mixed - OUTPUT_MODE_INLINE - = 'inline' - - - -
                                                                                                        - -
                                                                                                        - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - OUTPUT_MODE_STRING - -

                                                                                                        - - - - - - public - mixed - OUTPUT_MODE_STRING - = 'string' - - - -
                                                                                                        - -
                                                                                                        - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - OUTPUT_MODES - -

                                                                                                        - - - - - - public - mixed - OUTPUT_MODES - = [self::OUTPUT_MODE_DOWNLOAD, self::OUTPUT_MODE_FILE, self::OUTPUT_MODE_INLINE, self::OUTPUT_MODE_STRING] - - - -
                                                                                                        - -
                                                                                                        - - - -
                                                                                                        -
                                                                                                        - - -
                                                                                                        -

                                                                                                        - Properties - -

                                                                                                        -
                                                                                                        -

                                                                                                        - $beforeCreateInstanceCallback - - - -

                                                                                                        - - - - - protected - callable|null - $beforeCreateInstanceCallback - - - - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - $beforeOutputPdfCallback - - - -

                                                                                                        - - - - - protected - callable|null - $beforeOutputPdfCallback - - - - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - $filename - - - -

                                                                                                        - - - - - protected - string|null - $filename - - - - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - $folder - - - -

                                                                                                        - - - - - protected - string|null - $folder - - - - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - $fonts - - - -

                                                                                                        - - - - - protected - array<string|int, mixed>|null - $fonts - - - - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - $format - - - -

                                                                                                        - - - - - protected - array<string|int, mixed>|string|null - $format - - - - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - $htmlContent - - - -

                                                                                                        - - - - - protected - string|null - $htmlContent - - - - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - $legacyFontDirectoryConfig - - - -

                                                                                                        - - - - - protected - array<string|int, mixed> - $legacyFontDirectoryConfig - - - - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - $margins - - - -

                                                                                                        - - - - - protected - array<string|int, mixed>|null - $margins - - - - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - $mediaType - - - -

                                                                                                        - - - - - protected - string|null - $mediaType - - - - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - $orientation - - - -

                                                                                                        - - - - - protected - string|null - $orientation - - - - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - $outputMode - - - -

                                                                                                        - - - - - protected - string|null - $outputMode - - - - - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - $templateFilePath - - - -

                                                                                                        - - - - - protected - string|null - $templateFilePath - - - - - - -
                                                                                                        -
                                                                                                        - -
                                                                                                        -

                                                                                                        - Methods - -

                                                                                                        -
                                                                                                        -

                                                                                                        - __construct() - -

                                                                                                        - - -

                                                                                                        MpdfCreator constructor.

                                                                                                        - - - public - __construct() : mixed - - - - - -
                                                                                                        Return values
                                                                                                        - mixed - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - addFont() - -

                                                                                                        - - - - - public - addFont(string $filepath, string $family, string $style, string $weight) : $this - - -
                                                                                                        Parameters
                                                                                                        -
                                                                                                        -
                                                                                                        - $filepath - : string -
                                                                                                        -
                                                                                                        -

                                                                                                        Absolute filepath to the font file

                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - $family - : string -
                                                                                                        -
                                                                                                        -

                                                                                                        Font family name

                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - $style - : string -
                                                                                                        -
                                                                                                        -

                                                                                                        Font style (regular, italic, ...), see AbstractPdfCreator::FONT_STYLE constants

                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - $weight - : string -
                                                                                                        -
                                                                                                        -

                                                                                                        Font weight

                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - - - -
                                                                                                        Return values
                                                                                                        - $this - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - addFontDirectories() - -

                                                                                                        - - -

                                                                                                        Add font directories to the config. Directory must contain mpdf-config.php.

                                                                                                        - - - public - addFontDirectories(array<string|int, mixed> $paths) : self - -

                                                                                                        Fallback method for legacy implementation, will be removed in a future version.

                                                                                                        -
                                                                                                        - -
                                                                                                        Parameters
                                                                                                        -
                                                                                                        -
                                                                                                        - $paths - : array<string|int, mixed> -
                                                                                                        -
                                                                                                        -

                                                                                                        Absolute path to font dir

                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - - -
                                                                                                        - Tags - -
                                                                                                        -
                                                                                                        -
                                                                                                        - deprecated -
                                                                                                        -
                                                                                                        - -

                                                                                                        Use addFont instead

                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - -
                                                                                                        Return values
                                                                                                        - self - — -

                                                                                                        Current pdf creator instance

                                                                                                        -
                                                                                                        - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - getBeforeCreateInstanceCallback() - -

                                                                                                        - - - - - public - getBeforeCreateInstanceCallback() : callable|null - -
                                                                                                        - - - - -
                                                                                                        Return values
                                                                                                        - callable|null - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - getBeforeOutputPdfCallback() - -

                                                                                                        - - - - - public - getBeforeOutputPdfCallback() : callable|null - -
                                                                                                        - - - - -
                                                                                                        Return values
                                                                                                        - callable|null - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - getFilename() - -

                                                                                                        - - - - - public - getFilename() : string - - - - - -
                                                                                                        Return values
                                                                                                        - string - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - getFolder() - -

                                                                                                        - - - - - public - getFolder() : string|null - -
                                                                                                        - - - - -
                                                                                                        Return values
                                                                                                        - string|null - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - getFonts() - -

                                                                                                        - - - - - public - getFonts() : array<string|int, mixed>|null - -
                                                                                                        - - - - -
                                                                                                        Return values
                                                                                                        - array<string|int, mixed>|null - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - getFormat() - -

                                                                                                        - - - - - public - getFormat() : string|null - -
                                                                                                        - - - - -
                                                                                                        Return values
                                                                                                        - string|null - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - getHtmlContent() - -

                                                                                                        - - - - - public - getHtmlContent() : mixed - - - - - -
                                                                                                        Return values
                                                                                                        - mixed - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - getMargins() - -

                                                                                                        - - - - - public - getMargins() : array<string|int, mixed>|null - -
                                                                                                        - - - - -
                                                                                                        Return values
                                                                                                        - array<string|int, mixed>|null - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - getMediaType() - -

                                                                                                        - - - - - public - getMediaType() : string|null - -
                                                                                                        - - - - -
                                                                                                        Return values
                                                                                                        - string|null - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - getOrientation() - -

                                                                                                        - - - - - public - getOrientation() : string|null - -
                                                                                                        - - - - -
                                                                                                        Return values
                                                                                                        - string|null - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - getOutputMode() - -

                                                                                                        - - - - - public - getOutputMode() : string - - - - - -
                                                                                                        Return values
                                                                                                        - string - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - getSupportedOutputModes() - -

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

                                                                                                        - getTemplateFilePath() - -

                                                                                                        - - - - - public - getTemplateFilePath() : string|null - -
                                                                                                        - - - - -
                                                                                                        Return values
                                                                                                        - string|null - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - getType() - -

                                                                                                        - - -

                                                                                                        Return an unique type alias.

                                                                                                        - - - public - static getType() : string - - - - - -
                                                                                                        Return values
                                                                                                        - string - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - render() - -

                                                                                                        - - - - - public - render() : void - -
                                                                                                        - - - - -
                                                                                                        Return values
                                                                                                        - void - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - setBeforeCreateInstanceCallback() - -

                                                                                                        - - -

                                                                                                        Add an callback to modify constructor parameters for pdf library.

                                                                                                        - - - public - setBeforeCreateInstanceCallback(callable|null $beforeCreateInstanceCallback) : self - -

                                                                                                        Callback gets an BeforeCreateLibraryInstanceCallback object as parameter and should return an BeforeCreateLibraryInstanceCallback object.

                                                                                                        -
                                                                                                        - -
                                                                                                        Parameters
                                                                                                        -
                                                                                                        -
                                                                                                        - $beforeCreateInstanceCallback - : callable|null -
                                                                                                        -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - - - -
                                                                                                        Return values
                                                                                                        - self - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - setBeforeOutputPdfCallback() - -

                                                                                                        - - -

                                                                                                        Add an callback to modify the configuration or parameters before outputting the pdf file.

                                                                                                        - - - public - setBeforeOutputPdfCallback(callable|null $beforeOutputPdfCallback) : self - -

                                                                                                        Callback gets an BeforeOutputPdfCallback object as parameter and should return an BeforeOutputPdfCallback object.

                                                                                                        -
                                                                                                        - -
                                                                                                        Parameters
                                                                                                        -
                                                                                                        -
                                                                                                        - $beforeOutputPdfCallback - : callable|null -
                                                                                                        -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - - - -
                                                                                                        Return values
                                                                                                        - self - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - setFilename() - -

                                                                                                        - - - - - public - setFilename(string $filename) : self - -
                                                                                                        - -
                                                                                                        Parameters
                                                                                                        -
                                                                                                        -
                                                                                                        - $filename - : string -
                                                                                                        -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - - - -
                                                                                                        Return values
                                                                                                        - self - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - setFolder() - -

                                                                                                        - - -

                                                                                                        Absolute folder where to store pdf.

                                                                                                        - - - public - setFolder(string $folder) : self - - -
                                                                                                        Parameters
                                                                                                        -
                                                                                                        -
                                                                                                        - $folder - : string -
                                                                                                        -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - - - -
                                                                                                        Return values
                                                                                                        - self - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - setFonts() - -

                                                                                                        - - - - - public - setFonts(array<string|int, mixed> $fonts) : self - -
                                                                                                        - -
                                                                                                        Parameters
                                                                                                        -
                                                                                                        -
                                                                                                        - $fonts - : array<string|int, mixed> -
                                                                                                        -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - - - -
                                                                                                        Return values
                                                                                                        - self - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - setFormat() - -

                                                                                                        - - -

                                                                                                        Set the document format.

                                                                                                        - - - public - setFormat(string|array<string|int, mixed> $format) : $this - - -
                                                                                                        Parameters
                                                                                                        -
                                                                                                        -
                                                                                                        - $format - : string|array<string|int, mixed> -
                                                                                                        -
                                                                                                        -

                                                                                                        A format type like A4, A5, Letter, Legal,... or an array of integers (width and height in mm).

                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - - - -
                                                                                                        Return values
                                                                                                        - $this - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - setHtmlContent() - -

                                                                                                        - - - - - public - setHtmlContent(mixed $htmlContent) : self - - -
                                                                                                        Parameters
                                                                                                        -
                                                                                                        -
                                                                                                        - $htmlContent - : mixed -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - - - -
                                                                                                        Return values
                                                                                                        - self - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - setMargins() - -

                                                                                                        - - -

                                                                                                        Set document margins.

                                                                                                        - - - public - setMargins(int|null $top[, int|null $right = null ][, int|null $bottom = null ][, int|null $left = null ]) : self - - -
                                                                                                        Parameters
                                                                                                        -
                                                                                                        -
                                                                                                        - $top - : int|null -
                                                                                                        -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - $right - : int|null - = null
                                                                                                        -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - $bottom - : int|null - = null
                                                                                                        -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - $left - : int|null - = null
                                                                                                        -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - - - -
                                                                                                        Return values
                                                                                                        - self - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - setMediaType() - -

                                                                                                        - - - - - public - setMediaType(string|null $mediaType) : self - - -
                                                                                                        Parameters
                                                                                                        -
                                                                                                        -
                                                                                                        - $mediaType - : string|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - - - -
                                                                                                        Return values
                                                                                                        - self - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - setOrientation() - -

                                                                                                        - - -

                                                                                                        Set orientation. Use AbstractPdfCreator::ORIENTATION_LANDSCAPE or AbstractPdfCreator::ORIENTATION_PORTRAIT.

                                                                                                        - - - public - setOrientation(string $orientation) : self - - -
                                                                                                        Parameters
                                                                                                        -
                                                                                                        -
                                                                                                        - $orientation - : string -
                                                                                                        -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - - - -
                                                                                                        Return values
                                                                                                        - self - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - setOutputMode() - -

                                                                                                        - - - - - public - setOutputMode(string $outputMode) : self - -
                                                                                                        - -
                                                                                                        Parameters
                                                                                                        -
                                                                                                        -
                                                                                                        - $outputMode - : string -
                                                                                                        -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - - - -
                                                                                                        Return values
                                                                                                        - self - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - setTemplateFilePath() - -

                                                                                                        - - -

                                                                                                        Set the absolute path to a pdf template file.

                                                                                                        - - - public - setTemplateFilePath(string|null $templateFilePath) : self - - -
                                                                                                        Parameters
                                                                                                        -
                                                                                                        -
                                                                                                        - $templateFilePath - : string|null -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - - - -
                                                                                                        Return values
                                                                                                        - self - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - applyDocumentFormatConfiguration() - -

                                                                                                        - - - - - protected - applyDocumentFormatConfiguration(array<string|int, mixed> $config) : array<string|int, mixed> - -
                                                                                                        - -
                                                                                                        Parameters
                                                                                                        -
                                                                                                        -
                                                                                                        - $config - : array<string|int, mixed> -
                                                                                                        -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - - - -
                                                                                                        Return values
                                                                                                        - array<string|int, mixed> - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - applyFonts() - -

                                                                                                        - - - - - protected - applyFonts(array<string|int, mixed> $config) : array<string|int, mixed> - -
                                                                                                        - -
                                                                                                        Parameters
                                                                                                        -
                                                                                                        -
                                                                                                        - $config - : array<string|int, mixed> -
                                                                                                        -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - - - -
                                                                                                        Return values
                                                                                                        - array<string|int, mixed> - — - - -
                                                                                                        -
                                                                                                        -

                                                                                                        - applyTemplate() - -

                                                                                                        - - - - - protected - applyTemplate(Mpdf $pdf) : void - - -
                                                                                                        Parameters
                                                                                                        -
                                                                                                        -
                                                                                                        - $pdf - : Mpdf -
                                                                                                        -
                                                                                                        -
                                                                                                        - -
                                                                                                        -
                                                                                                        - - -
                                                                                                        - Tags - -
                                                                                                        -
                                                                                                        -
                                                                                                        - throws -
                                                                                                        -
                                                                                                        - CrossReferenceException - - -
                                                                                                        -
                                                                                                        - throws -
                                                                                                        -
                                                                                                        - PdfParserException - - -
                                                                                                        -
                                                                                                        - throws -
                                                                                                        -
                                                                                                        - PdfTypeException - - -
                                                                                                        -
                                                                                                        - -
                                                                                                        Return values
                                                                                                        - void - — - - -
                                                                                                        -
                                                                                                        - - - - -
                                                                                                        -
                                                                                                        -
                                                                                                        -
                                                                                                        -

                                                                                                        Search results

                                                                                                        - -
                                                                                                        -
                                                                                                        -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          - - -
                                                                                                          - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Request-CurlRequest.html b/classes/HeimrichHannot-UtilsBundle-Request-CurlRequest.html deleted file mode 100644 index 64ae2950..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Request-CurlRequest.html +++ /dev/null @@ -1,575 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                          -

                                                                                                          Contao Utils Bundle

                                                                                                          - - -
                                                                                                          - -
                                                                                                          - - -
                                                                                                          - -
                                                                                                          -
                                                                                                          - - - - -
                                                                                                          - - -
                                                                                                          -

                                                                                                          - CurlRequest - - -
                                                                                                          - in package - -
                                                                                                          - - - implements - HttpRequestInterface - -

                                                                                                          - - - - -
                                                                                                          - - - - - - -

                                                                                                          - Interfaces, Classes and Traits - -

                                                                                                          - -
                                                                                                          -
                                                                                                          HttpRequestInterface
                                                                                                          -
                                                                                                          - - -
                                                                                                          - - -

                                                                                                          - Table of Contents - -

                                                                                                          - -
                                                                                                          -
                                                                                                          - $handle - -  : mixed -
                                                                                                          -
                                                                                                          - -
                                                                                                          - __construct() - -  : mixed -
                                                                                                          -
                                                                                                          CurlRequest constructor.
                                                                                                          - -
                                                                                                          - close() - -  : mixed -
                                                                                                          -
                                                                                                          - -
                                                                                                          - execute() - -  : mixed -
                                                                                                          -
                                                                                                          - -
                                                                                                          - getInfo() - -  : mixed -
                                                                                                          -
                                                                                                          - -
                                                                                                          - init() - -  : HttpRequestInterface -
                                                                                                          -
                                                                                                          - -
                                                                                                          - setOption() - -  : HttpRequestInterface -
                                                                                                          -
                                                                                                          - -
                                                                                                          - - - - - - -
                                                                                                          -

                                                                                                          - Properties - -

                                                                                                          -
                                                                                                          -

                                                                                                          - $handle - - - -

                                                                                                          - - - - - private - mixed - $handle - = null - -
                                                                                                          - -
                                                                                                          - - - -
                                                                                                          -
                                                                                                          - -
                                                                                                          -

                                                                                                          - Methods - -

                                                                                                          -
                                                                                                          -

                                                                                                          - __construct() - -

                                                                                                          - - -

                                                                                                          CurlRequest constructor.

                                                                                                          - - - public - __construct() : mixed - - - - - -
                                                                                                          Return values
                                                                                                          - mixed - — - - -
                                                                                                          -
                                                                                                          -

                                                                                                          - close() - -

                                                                                                          - - - - - public - close() : mixed - -
                                                                                                          - - - - -
                                                                                                          Return values
                                                                                                          - mixed - — - - -
                                                                                                          -
                                                                                                          -

                                                                                                          - execute() - -

                                                                                                          - - - - - public - execute() : mixed - -
                                                                                                          - - - - -
                                                                                                          Return values
                                                                                                          - mixed - — - - -
                                                                                                          -
                                                                                                          -

                                                                                                          - getInfo() - -

                                                                                                          - - - - - public - getInfo(mixed $name) : mixed - -
                                                                                                          - -
                                                                                                          Parameters
                                                                                                          -
                                                                                                          -
                                                                                                          - $name - : mixed -
                                                                                                          -
                                                                                                          -
                                                                                                          - -
                                                                                                          -
                                                                                                          - - - -
                                                                                                          Return values
                                                                                                          - mixed - — - - -
                                                                                                          - - -
                                                                                                          - - - - -
                                                                                                          -
                                                                                                          -
                                                                                                          -
                                                                                                          -

                                                                                                          Search results

                                                                                                          - -
                                                                                                          -
                                                                                                          -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            - - -
                                                                                                            - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Request-CurlRequestUtil.html b/classes/HeimrichHannot-UtilsBundle-Request-CurlRequestUtil.html deleted file mode 100644 index fc791a5a..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Request-CurlRequestUtil.html +++ /dev/null @@ -1,1072 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                            -

                                                                                                            Contao Utils Bundle

                                                                                                            - - -
                                                                                                            - -
                                                                                                            - - -
                                                                                                            - -
                                                                                                            -
                                                                                                            - - - - -
                                                                                                            - - -
                                                                                                            -

                                                                                                            - CurlRequestUtil - - -
                                                                                                            - in package - -
                                                                                                            - - -

                                                                                                            - - - - -
                                                                                                            - - - - - - - - -

                                                                                                            - Table of Contents - -

                                                                                                            - -
                                                                                                            -
                                                                                                            - HTTP_STATUS_CODE_MESSAGES - -  = [100 => 'Continue', 101 => 'Switching Protocols', 200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content', 300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 306 => '(Unused)', 307 => 'Temporary Redirect', 400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Timeout', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Long', 415 => 'Unsupported Media Type', 416 => 'Requested Range Not Satisfiable', 417 => 'Expectation Failed', 500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Timeout', 505 => 'HTTP Version Not Supported'] -
                                                                                                            -
                                                                                                            - -
                                                                                                            - $container - -  : ContainerInterface -
                                                                                                            -
                                                                                                            - -
                                                                                                            - $framework - -  : ContaoFrameworkInterface -
                                                                                                            -
                                                                                                            - -
                                                                                                            - $handle - -  : HttpRequestInterface -
                                                                                                            -
                                                                                                            - -
                                                                                                            - __construct() - -  : mixed -
                                                                                                            -
                                                                                                            - -
                                                                                                            - createCurlHandle() - -  : CurlRequest -
                                                                                                            -
                                                                                                            Create the curl handle.
                                                                                                            - -
                                                                                                            - getHandle() - -  : HttpRequestInterface|null -
                                                                                                            -
                                                                                                            - -
                                                                                                            - postRequest() - -  : array<string|int, mixed>|mixed -
                                                                                                            -
                                                                                                            Create a curl post request.
                                                                                                            - -
                                                                                                            - prepareHeaderArrayForPrint() - -  : string -
                                                                                                            -
                                                                                                            Creates a linebreak separated list of the headers in $arrHeaders -> see request() and postRequest().
                                                                                                            - -
                                                                                                            - recursiveGetRequest() - -  : array<string|int, mixed>|mixed|null -
                                                                                                            -
                                                                                                            Recursivly send get request and terminates if termination condition is given or max request count is reached.
                                                                                                            - -
                                                                                                            - recursivePostRequest() - -  : array<string|int, mixed>|mixed|null -
                                                                                                            -
                                                                                                            Recursivly send post request and terminates if termination condition is given or max request count is reached.
                                                                                                            - -
                                                                                                            - request() - -  : array<string|int, mixed>|mixed -
                                                                                                            -
                                                                                                            Executes a curl request while taking.
                                                                                                            - -
                                                                                                            - setHandle() - -  : mixed -
                                                                                                            -
                                                                                                            - -
                                                                                                            - splitResponseHeaderAndBody() - -  : array<string|int, mixed> -
                                                                                                            -
                                                                                                            - -
                                                                                                            - prepareHeaders() - -  : array<string|int, mixed> -
                                                                                                            -
                                                                                                            Prepare headers for curl handle.
                                                                                                            - -
                                                                                                            - - - - -
                                                                                                            -

                                                                                                            - Constants - -

                                                                                                            -
                                                                                                            -

                                                                                                            - HTTP_STATUS_CODE_MESSAGES - -

                                                                                                            - - - - - - public - mixed - HTTP_STATUS_CODE_MESSAGES - = [100 => 'Continue', 101 => 'Switching Protocols', 200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content', 300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 306 => '(Unused)', 307 => 'Temporary Redirect', 400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Timeout', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Long', 415 => 'Unsupported Media Type', 416 => 'Requested Range Not Satisfiable', 417 => 'Expectation Failed', 500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Timeout', 505 => 'HTTP Version Not Supported'] - - - -
                                                                                                            - -
                                                                                                            - - - -
                                                                                                            -
                                                                                                            - - -
                                                                                                            -

                                                                                                            - Properties - -

                                                                                                            -
                                                                                                            -

                                                                                                            - $container - - - -

                                                                                                            - - - - - protected - ContainerInterface - $container - - - - - - -
                                                                                                            -
                                                                                                            -

                                                                                                            - $framework - - - -

                                                                                                            - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
                                                                                                            - -
                                                                                                            - -
                                                                                                            -

                                                                                                            - Methods - -

                                                                                                            -
                                                                                                            -

                                                                                                            - __construct() - -

                                                                                                            - - - - - public - __construct(ContaoFrameworkInterface $framework, ContainerInterface $container) : mixed - -
                                                                                                            - -
                                                                                                            Parameters
                                                                                                            -
                                                                                                            -
                                                                                                            - $framework - : ContaoFrameworkInterface -
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - $container - : ContainerInterface -
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - - - -
                                                                                                            Return values
                                                                                                            - mixed - — - - -
                                                                                                            -
                                                                                                            -

                                                                                                            - createCurlHandle() - -

                                                                                                            - - -

                                                                                                            Create the curl handle.

                                                                                                            - - - public - createCurlHandle( $url) : CurlRequest - - -
                                                                                                            Parameters
                                                                                                            -
                                                                                                            -
                                                                                                            - $url - : -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - - - -
                                                                                                            Return values
                                                                                                            - CurlRequest - — - - -
                                                                                                            - -
                                                                                                            -

                                                                                                            - postRequest() - -

                                                                                                            - - -

                                                                                                            Create a curl post request.

                                                                                                            - - - public - postRequest(string $url[, array<string|int, mixed> $requestHeaders = [] ][, array<string|int, mixed> $postFields = [] ][, bool $returnResponseHeaders = false ]) : array<string|int, mixed>|mixed - - -
                                                                                                            Parameters
                                                                                                            -
                                                                                                            -
                                                                                                            - $url - : string -
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - $requestHeaders - : array<string|int, mixed> - = []
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - $postFields - : array<string|int, mixed> - = []
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - $returnResponseHeaders - : bool - = false
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - - - -
                                                                                                            Return values
                                                                                                            - array<string|int, mixed>|mixed - — - - -
                                                                                                            -
                                                                                                            -

                                                                                                            - prepareHeaderArrayForPrint() - -

                                                                                                            - - -

                                                                                                            Creates a linebreak separated list of the headers in $arrHeaders -> see request() and postRequest().

                                                                                                            - - - public - prepareHeaderArrayForPrint(array<string|int, mixed> $headers) : string - - -
                                                                                                            Parameters
                                                                                                            -
                                                                                                            -
                                                                                                            - $headers - : array<string|int, mixed> -
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - - - -
                                                                                                            Return values
                                                                                                            - string - — - - -
                                                                                                            -
                                                                                                            -

                                                                                                            - recursiveGetRequest() - -

                                                                                                            - - -

                                                                                                            Recursivly send get request and terminates if termination condition is given or max request count is reached.

                                                                                                            - - - public - recursiveGetRequest(int $maxRecursionCount, callable $callback, string $url[, array<string|int, mixed> $requestHeaders = [] ][, bool $returnResponseHeaders = false ]) : array<string|int, mixed>|mixed|null - - -
                                                                                                            Parameters
                                                                                                            -
                                                                                                            -
                                                                                                            - $maxRecursionCount - : int -
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - $callback - : callable -
                                                                                                            -
                                                                                                            -

                                                                                                            Termination condition callback. Return true to terminate.

                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - $url - : string -
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - $requestHeaders - : array<string|int, mixed> - = []
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - $returnResponseHeaders - : bool - = false
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - - - -
                                                                                                            Return values
                                                                                                            - array<string|int, mixed>|mixed|null - — - - -
                                                                                                            -
                                                                                                            -

                                                                                                            - recursivePostRequest() - -

                                                                                                            - - -

                                                                                                            Recursivly send post request and terminates if termination condition is given or max request count is reached.

                                                                                                            - - - public - recursivePostRequest(int $maxRecursionCount, callable $callback, string $url[, array<string|int, mixed> $requestHeaders = [] ][, array<string|int, mixed> $post = [] ][, bool $returnResponseHeaders = false ]) : array<string|int, mixed>|mixed|null - - -
                                                                                                            Parameters
                                                                                                            -
                                                                                                            -
                                                                                                            - $maxRecursionCount - : int -
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - $callback - : callable -
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - $url - : string -
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - $requestHeaders - : array<string|int, mixed> - = []
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - $post - : array<string|int, mixed> - = []
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - $returnResponseHeaders - : bool - = false
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - - - -
                                                                                                            Return values
                                                                                                            - array<string|int, mixed>|mixed|null - — - - -
                                                                                                            -
                                                                                                            -

                                                                                                            - request() - -

                                                                                                            - - -

                                                                                                            Executes a curl request while taking.

                                                                                                            - - - public - request( $url[, array<string|int, mixed> $requestHeaders = [] ][, bool $returnResponseHeaders = false ]) : array<string|int, mixed>|mixed - - -
                                                                                                            Parameters
                                                                                                            -
                                                                                                            -
                                                                                                            - $url - : -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - $requestHeaders - : array<string|int, mixed> - = []
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - $returnResponseHeaders - : bool - = false
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - - - -
                                                                                                            Return values
                                                                                                            - array<string|int, mixed>|mixed - — - - -
                                                                                                            - -
                                                                                                            -

                                                                                                            - splitResponseHeaderAndBody() - -

                                                                                                            - - - - - public - splitResponseHeaderAndBody(string $response, int $statusCode) : array<string|int, mixed> - - -
                                                                                                            Parameters
                                                                                                            -
                                                                                                            -
                                                                                                            - $response - : string -
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - $statusCode - : int -
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - - - -
                                                                                                            Return values
                                                                                                            - array<string|int, mixed> - — - - -
                                                                                                            -
                                                                                                            -

                                                                                                            - prepareHeaders() - -

                                                                                                            - - -

                                                                                                            Prepare headers for curl handle.

                                                                                                            - - - protected - prepareHeaders(array<string|int, mixed> $headers) : array<string|int, mixed> - - -
                                                                                                            Parameters
                                                                                                            -
                                                                                                            -
                                                                                                            - $headers - : array<string|int, mixed> -
                                                                                                            -
                                                                                                            -
                                                                                                            - -
                                                                                                            -
                                                                                                            - - - -
                                                                                                            Return values
                                                                                                            - array<string|int, mixed> - — - - -
                                                                                                            -
                                                                                                            - - - - -
                                                                                                            -
                                                                                                            -
                                                                                                            -
                                                                                                            -

                                                                                                            Search results

                                                                                                            - -
                                                                                                            -
                                                                                                            -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              - - -
                                                                                                              - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Request-HttpRequestInterface.html b/classes/HeimrichHannot-UtilsBundle-Request-HttpRequestInterface.html deleted file mode 100644 index ede355e6..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Request-HttpRequestInterface.html +++ /dev/null @@ -1,468 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                              -

                                                                                                              Contao Utils Bundle

                                                                                                              - - -
                                                                                                              - -
                                                                                                              - - -
                                                                                                              - -
                                                                                                              -
                                                                                                              - - - - -
                                                                                                              - - -
                                                                                                              -

                                                                                                              - HttpRequestInterface -
                                                                                                              - in - -
                                                                                                              -

                                                                                                              - - - - -
                                                                                                              - - - - - - - - -

                                                                                                              - Table of Contents - -

                                                                                                              - -
                                                                                                              -
                                                                                                              - close() - -  : mixed -
                                                                                                              -
                                                                                                              - -
                                                                                                              - execute() - -  : mixed -
                                                                                                              -
                                                                                                              - -
                                                                                                              - getInfo() - -  : mixed -
                                                                                                              -
                                                                                                              - -
                                                                                                              - init() - -  : self -
                                                                                                              -
                                                                                                              - -
                                                                                                              - setOption() - -  : self -
                                                                                                              -
                                                                                                              - -
                                                                                                              - - - - - -
                                                                                                              -

                                                                                                              - Methods - -

                                                                                                              -
                                                                                                              -

                                                                                                              - close() - -

                                                                                                              - - - - - public - close() : mixed - -
                                                                                                              - - - - -
                                                                                                              Return values
                                                                                                              - mixed - — - - -
                                                                                                              -
                                                                                                              -

                                                                                                              - execute() - -

                                                                                                              - - - - - public - execute() : mixed - -
                                                                                                              - - - - -
                                                                                                              Return values
                                                                                                              - mixed - — - - -
                                                                                                              -
                                                                                                              -

                                                                                                              - getInfo() - -

                                                                                                              - - - - - public - getInfo(mixed $name) : mixed - -
                                                                                                              - -
                                                                                                              Parameters
                                                                                                              -
                                                                                                              -
                                                                                                              - $name - : mixed -
                                                                                                              -
                                                                                                              -
                                                                                                              - -
                                                                                                              -
                                                                                                              - - - -
                                                                                                              Return values
                                                                                                              - mixed - — - - -
                                                                                                              -
                                                                                                              -

                                                                                                              - init() - -

                                                                                                              - - - - - public - init(mixed $url) : self - -
                                                                                                              - -
                                                                                                              Parameters
                                                                                                              -
                                                                                                              -
                                                                                                              - $url - : mixed -
                                                                                                              -
                                                                                                              -
                                                                                                              - -
                                                                                                              -
                                                                                                              - - - -
                                                                                                              Return values
                                                                                                              - self - — - - -
                                                                                                              -
                                                                                                              -

                                                                                                              - setOption() - -

                                                                                                              - - - - - public - setOption(mixed $name, mixed $value) : self - -
                                                                                                              - -
                                                                                                              Parameters
                                                                                                              -
                                                                                                              -
                                                                                                              - $name - : mixed -
                                                                                                              -
                                                                                                              -
                                                                                                              - -
                                                                                                              -
                                                                                                              - $value - : mixed -
                                                                                                              -
                                                                                                              -
                                                                                                              - -
                                                                                                              -
                                                                                                              - - - -
                                                                                                              Return values
                                                                                                              - self - — - - -
                                                                                                              -
                                                                                                              - - - - -
                                                                                                              -
                                                                                                              -
                                                                                                              -
                                                                                                              -

                                                                                                              Search results

                                                                                                              - -
                                                                                                              -
                                                                                                              -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                - - -
                                                                                                                - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Request-RequestUtil.html b/classes/HeimrichHannot-UtilsBundle-Request-RequestUtil.html deleted file mode 100644 index 7c4085ce..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Request-RequestUtil.html +++ /dev/null @@ -1,405 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                                -

                                                                                                                Contao Utils Bundle

                                                                                                                - - -
                                                                                                                - -
                                                                                                                - - -
                                                                                                                - -
                                                                                                                -
                                                                                                                - - - - -
                                                                                                                - - -
                                                                                                                -

                                                                                                                - RequestUtil - - -
                                                                                                                - in package - -
                                                                                                                - - -

                                                                                                                - - - - - - -
                                                                                                                - Tags - -
                                                                                                                -
                                                                                                                -
                                                                                                                - deprecated -
                                                                                                                -
                                                                                                                - -

                                                                                                                Use Utils service instead

                                                                                                                -
                                                                                                                - -
                                                                                                                -
                                                                                                                - codeCoverageIgnore -
                                                                                                                -
                                                                                                                - - -
                                                                                                                -
                                                                                                                - - - - - - -

                                                                                                                - Table of Contents - -

                                                                                                                - -
                                                                                                                -
                                                                                                                - $requestStack - -  : RequestStack -
                                                                                                                -
                                                                                                                - -
                                                                                                                - __construct() - -  : mixed -
                                                                                                                -
                                                                                                                RequestUtil constructor.
                                                                                                                - -
                                                                                                                - isNewVisitor() - -  : bool -
                                                                                                                -
                                                                                                                Detect if user already visited our domain before.
                                                                                                                - -
                                                                                                                - - - - - - -
                                                                                                                -

                                                                                                                - Properties - -

                                                                                                                -
                                                                                                                -

                                                                                                                - $requestStack - - - -

                                                                                                                - - - - - private - RequestStack - $requestStack - - - - - - -
                                                                                                                -
                                                                                                                - -
                                                                                                                -

                                                                                                                - Methods - -

                                                                                                                -
                                                                                                                -

                                                                                                                - __construct() - -

                                                                                                                - - -

                                                                                                                RequestUtil constructor.

                                                                                                                - - - public - __construct(RequestStack $requestStack) : mixed - - -
                                                                                                                Parameters
                                                                                                                -
                                                                                                                -
                                                                                                                - $requestStack - : RequestStack -
                                                                                                                -
                                                                                                                -
                                                                                                                - -
                                                                                                                -
                                                                                                                - - - -
                                                                                                                Return values
                                                                                                                - mixed - — - - -
                                                                                                                -
                                                                                                                -

                                                                                                                - isNewVisitor() - -

                                                                                                                - - -

                                                                                                                Detect if user already visited our domain before.

                                                                                                                - - - public - isNewVisitor() : bool - - - - -
                                                                                                                - Tags - -
                                                                                                                -
                                                                                                                -
                                                                                                                - deprecated -
                                                                                                                -
                                                                                                                - -

                                                                                                                Use Utils service instead

                                                                                                                -
                                                                                                                - -
                                                                                                                -
                                                                                                                - -
                                                                                                                Return values
                                                                                                                - bool - — - - -
                                                                                                                -
                                                                                                                - - - - -
                                                                                                                -
                                                                                                                -
                                                                                                                -
                                                                                                                -

                                                                                                                Search results

                                                                                                                - -
                                                                                                                -
                                                                                                                -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  - - -
                                                                                                                  - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Routing-RoutingUtil.html b/classes/HeimrichHannot-UtilsBundle-Routing-RoutingUtil.html deleted file mode 100644 index 241560dd..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Routing-RoutingUtil.html +++ /dev/null @@ -1,450 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                                  -

                                                                                                                  Contao Utils Bundle

                                                                                                                  - - -
                                                                                                                  - -
                                                                                                                  - - -
                                                                                                                  - -
                                                                                                                  -
                                                                                                                  - - - - -
                                                                                                                  - - -
                                                                                                                  -

                                                                                                                  - RoutingUtil - - -
                                                                                                                  - in package - -
                                                                                                                  - - -

                                                                                                                  - - - - - - -
                                                                                                                  - Tags - -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  - deprecated -
                                                                                                                  -
                                                                                                                  - -

                                                                                                                  Use Utils service instead

                                                                                                                  -
                                                                                                                  - -
                                                                                                                  -
                                                                                                                  - codeCoverageIgnore -
                                                                                                                  -
                                                                                                                  - - -
                                                                                                                  -
                                                                                                                  - - - - - - -

                                                                                                                  - Table of Contents - -

                                                                                                                  - -
                                                                                                                  -
                                                                                                                  - $utils - -  : Utils -
                                                                                                                  -
                                                                                                                  - -
                                                                                                                  - __construct() - -  : mixed -
                                                                                                                  -
                                                                                                                  - -
                                                                                                                  - generateBackendRoute() - -  : string -
                                                                                                                  -
                                                                                                                  Generate a backend route with token and referer.
                                                                                                                  - -
                                                                                                                  - - - - - - -
                                                                                                                  -

                                                                                                                  - Properties - -

                                                                                                                  - -
                                                                                                                  - -
                                                                                                                  -

                                                                                                                  - Methods - -

                                                                                                                  -
                                                                                                                  -

                                                                                                                  - __construct() - -

                                                                                                                  - - - - - public - __construct(Utils $utils) : mixed - -
                                                                                                                  - -
                                                                                                                  Parameters
                                                                                                                  -
                                                                                                                  -
                                                                                                                  - $utils - : Utils -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  - -
                                                                                                                  -
                                                                                                                  - - - -
                                                                                                                  Return values
                                                                                                                  - mixed - — - - -
                                                                                                                  -
                                                                                                                  -

                                                                                                                  - generateBackendRoute() - -

                                                                                                                  - - -

                                                                                                                  Generate a backend route with token and referer.

                                                                                                                  - - - public - generateBackendRoute([array<string|int, mixed> $params = [] ][, bool $addToken = true ][, bool $addReferer = true ][, string $route = 'contao_backend' ]) : string - - -
                                                                                                                  Parameters
                                                                                                                  -
                                                                                                                  -
                                                                                                                  - $params - : array<string|int, mixed> - = []
                                                                                                                  -
                                                                                                                  -

                                                                                                                  Url-Parameters

                                                                                                                  -
                                                                                                                  - -
                                                                                                                  -
                                                                                                                  - $addToken - : bool - = true
                                                                                                                  -
                                                                                                                  -
                                                                                                                  - -
                                                                                                                  -
                                                                                                                  - $addReferer - : bool - = true
                                                                                                                  -
                                                                                                                  -
                                                                                                                  - -
                                                                                                                  -
                                                                                                                  - $route - : string - = 'contao_backend'
                                                                                                                  -
                                                                                                                  -
                                                                                                                  - -
                                                                                                                  -
                                                                                                                  - - -
                                                                                                                  - Tags - -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  - deprecated -
                                                                                                                  -
                                                                                                                  - -

                                                                                                                  Use utils service instead

                                                                                                                  -
                                                                                                                  - -
                                                                                                                  -
                                                                                                                  - codeCoverageIgnore -
                                                                                                                  -
                                                                                                                  - - -
                                                                                                                  -
                                                                                                                  - -
                                                                                                                  Return values
                                                                                                                  - string - — -

                                                                                                                  The backend route url

                                                                                                                  -
                                                                                                                  - - -
                                                                                                                  -
                                                                                                                  - - - - -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -
                                                                                                                  -

                                                                                                                  Search results

                                                                                                                  - -
                                                                                                                  -
                                                                                                                  -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - - -
                                                                                                                    - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Rsce-RsceUtil.html b/classes/HeimrichHannot-UtilsBundle-Rsce-RsceUtil.html deleted file mode 100644 index e117dce9..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Rsce-RsceUtil.html +++ /dev/null @@ -1,404 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                                    -

                                                                                                                    Contao Utils Bundle

                                                                                                                    - - -
                                                                                                                    - -
                                                                                                                    - - -
                                                                                                                    - -
                                                                                                                    -
                                                                                                                    - - - - -
                                                                                                                    - - -
                                                                                                                    -

                                                                                                                    - RsceUtil - - -
                                                                                                                    - in package - -
                                                                                                                    - - -

                                                                                                                    - - - - -
                                                                                                                    - - - - - - - - -

                                                                                                                    - Table of Contents - -

                                                                                                                    - -
                                                                                                                    -
                                                                                                                    - $formUtil - -  : FormUtil -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    - __construct() - -  : mixed -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    - explodeRsceData() - -  : mixed -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    - - - - - - -
                                                                                                                    -

                                                                                                                    - Properties - -

                                                                                                                    -
                                                                                                                    -

                                                                                                                    - $formUtil - - - -

                                                                                                                    - - - - - private - FormUtil - $formUtil - - - - - - -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    -

                                                                                                                    - Methods - -

                                                                                                                    -
                                                                                                                    -

                                                                                                                    - __construct() - -

                                                                                                                    - - - - - public - __construct(FormUtil $formUtil) : mixed - -
                                                                                                                    - -
                                                                                                                    Parameters
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - $formUtil - : FormUtil -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    -
                                                                                                                    - - - -
                                                                                                                    Return values
                                                                                                                    - mixed - — - - -
                                                                                                                    -
                                                                                                                    -

                                                                                                                    - explodeRsceData() - -

                                                                                                                    - - - - - public - explodeRsceData(string $cteType, string $data, int $recordId[, mixed $options = [] ]) : mixed - -
                                                                                                                    - -
                                                                                                                    Parameters
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - $cteType - : string -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    -
                                                                                                                    - $data - : string -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    -
                                                                                                                    - $recordId - : int -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    -
                                                                                                                    - $options - : mixed - = []
                                                                                                                    -
                                                                                                                    -
                                                                                                                    - -
                                                                                                                    -
                                                                                                                    - - - -
                                                                                                                    Return values
                                                                                                                    - mixed - — - - -
                                                                                                                    -
                                                                                                                    - - - - -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -
                                                                                                                    -

                                                                                                                    Search results

                                                                                                                    - -
                                                                                                                    -
                                                                                                                    -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      - - -
                                                                                                                      - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Salutation-SalutationUtil.html b/classes/HeimrichHannot-UtilsBundle-Salutation-SalutationUtil.html deleted file mode 100644 index be2ed866..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Salutation-SalutationUtil.html +++ /dev/null @@ -1,457 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                                      -

                                                                                                                      Contao Utils Bundle

                                                                                                                      - - -
                                                                                                                      - -
                                                                                                                      - - -
                                                                                                                      - -
                                                                                                                      -
                                                                                                                      - - - - -
                                                                                                                      - - -
                                                                                                                      -

                                                                                                                      - SalutationUtil - - -
                                                                                                                      - in package - -
                                                                                                                      - - -

                                                                                                                      - - - - -
                                                                                                                      - - - - - - - - -

                                                                                                                      - Table of Contents - -

                                                                                                                      - -
                                                                                                                      -
                                                                                                                      - $framework - -  : ContaoFrameworkInterface -
                                                                                                                      -
                                                                                                                      - -
                                                                                                                      - __construct() - -  : mixed -
                                                                                                                      -
                                                                                                                      - -
                                                                                                                      - createNameByFields() - -  : mixed -
                                                                                                                      -
                                                                                                                      Creates complete names by inserting an array of the person's data.
                                                                                                                      - -
                                                                                                                      - createSalutation() - -  : string -
                                                                                                                      -
                                                                                                                      - -
                                                                                                                      - - - - - - -
                                                                                                                      -

                                                                                                                      - Properties - -

                                                                                                                      -
                                                                                                                      -

                                                                                                                      - $framework - - - -

                                                                                                                      - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
                                                                                                                      -
                                                                                                                      - -
                                                                                                                      -

                                                                                                                      - Methods - -

                                                                                                                      -
                                                                                                                      -

                                                                                                                      - __construct() - -

                                                                                                                      - - - - - public - __construct(ContaoFrameworkInterface $framework) : mixed - -
                                                                                                                      - -
                                                                                                                      Parameters
                                                                                                                      -
                                                                                                                      -
                                                                                                                      - $framework - : ContaoFrameworkInterface -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      - -
                                                                                                                      -
                                                                                                                      - - - -
                                                                                                                      Return values
                                                                                                                      - mixed - — - - -
                                                                                                                      -
                                                                                                                      -

                                                                                                                      - createNameByFields() - -

                                                                                                                      - - -

                                                                                                                      Creates complete names by inserting an array of the person's data.

                                                                                                                      - - - public - createNameByFields(string $language, array<string|int, mixed> $data) : mixed - -

                                                                                                                      Supported field names: firstname, lastname, academicTitle, additionalTitle, gender

                                                                                                                      -

                                                                                                                      If some of the fields shouldn't go into the processed name, just leave them out of $arrData

                                                                                                                      -
                                                                                                                      - -
                                                                                                                      Parameters
                                                                                                                      -
                                                                                                                      -
                                                                                                                      - $language - : string -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      - -
                                                                                                                      -
                                                                                                                      - $data - : array<string|int, mixed> -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      - -
                                                                                                                      -
                                                                                                                      - - - -
                                                                                                                      Return values
                                                                                                                      - mixed - — - - -
                                                                                                                      -
                                                                                                                      -

                                                                                                                      - createSalutation() - -

                                                                                                                      - - - - - public - createSalutation( $language,  $entity[, array<string|int, mixed> $options = [] ]) : string - - -
                                                                                                                      Parameters
                                                                                                                      -
                                                                                                                      -
                                                                                                                      - $language - : -
                                                                                                                      -
                                                                                                                      - -
                                                                                                                      -
                                                                                                                      - $entity - : -
                                                                                                                      -
                                                                                                                      -

                                                                                                                      object|array

                                                                                                                      -
                                                                                                                      - -
                                                                                                                      -
                                                                                                                      - $options - : array<string|int, mixed> - = []
                                                                                                                      -
                                                                                                                      -
                                                                                                                      - -
                                                                                                                      -
                                                                                                                      - - - -
                                                                                                                      Return values
                                                                                                                      - string - — - - -
                                                                                                                      -
                                                                                                                      - - - - -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -
                                                                                                                      -

                                                                                                                      Search results

                                                                                                                      - -
                                                                                                                      -
                                                                                                                      -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - - -
                                                                                                                        - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Security-CodeUtil.html b/classes/HeimrichHannot-UtilsBundle-Security-CodeUtil.html deleted file mode 100644 index 71d8c838..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Security-CodeUtil.html +++ /dev/null @@ -1,711 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                                        -

                                                                                                                        Contao Utils Bundle

                                                                                                                        - - -
                                                                                                                        - -
                                                                                                                        - - -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        - - - - -
                                                                                                                        - - -
                                                                                                                        -

                                                                                                                        - CodeUtil - - -
                                                                                                                        - in package - -
                                                                                                                        - - -

                                                                                                                        - - - - -
                                                                                                                        - - - - - - - - -

                                                                                                                        - Table of Contents - -

                                                                                                                        - -
                                                                                                                        -
                                                                                                                        - CAPITAL_LETTERS - -  = 'capitalLetters' -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        - DEFAULT_ALLOWED_SPECIAL_CHARS - -  = '[=<>()#/]' -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        - DEFAULT_ALPHABETS - -  = [self::CAPITAL_LETTERS, self::SMALL_LETTERS, self::NUMBERS] -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        - DEFAULT_RULES - -  = [self::CAPITAL_LETTERS, self::SMALL_LETTERS, self::NUMBERS] -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        - NUMBERS - -  = 'numbers' -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        - SMALL_LETTERS - -  = 'smallLetters' -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        - SPECIAL_CHARS - -  = 'specialChars' -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        - $blnPreventAmbiguous - -  : mixed -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        - $framework - -  : ContaoFrameworkInterface -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        - __construct() - -  : mixed -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        - generate() - -  : mixed -
                                                                                                                        -
                                                                                                                        Generates a code by certain criteria.
                                                                                                                        - -
                                                                                                                        - - - - -
                                                                                                                        -

                                                                                                                        - Constants - -

                                                                                                                        -
                                                                                                                        -

                                                                                                                        - CAPITAL_LETTERS - -

                                                                                                                        - - - - - - public - mixed - CAPITAL_LETTERS - = 'capitalLetters' - - - -
                                                                                                                        - -
                                                                                                                        - - - -
                                                                                                                        -
                                                                                                                        -

                                                                                                                        - DEFAULT_ALLOWED_SPECIAL_CHARS - -

                                                                                                                        - - - - - - public - mixed - DEFAULT_ALLOWED_SPECIAL_CHARS - = '[=<>()#/]' - - - -
                                                                                                                        - -
                                                                                                                        - - - -
                                                                                                                        -
                                                                                                                        -

                                                                                                                        - DEFAULT_ALPHABETS - -

                                                                                                                        - - - - - - public - mixed - DEFAULT_ALPHABETS - = [self::CAPITAL_LETTERS, self::SMALL_LETTERS, self::NUMBERS] - - - -
                                                                                                                        - -
                                                                                                                        - - - -
                                                                                                                        -
                                                                                                                        -

                                                                                                                        - DEFAULT_RULES - -

                                                                                                                        - - - - - - public - mixed - DEFAULT_RULES - = [self::CAPITAL_LETTERS, self::SMALL_LETTERS, self::NUMBERS] - - - -
                                                                                                                        - -
                                                                                                                        - - - -
                                                                                                                        -
                                                                                                                        -

                                                                                                                        - NUMBERS - -

                                                                                                                        - - - - - - public - mixed - NUMBERS - = 'numbers' - - - -
                                                                                                                        - -
                                                                                                                        - - - -
                                                                                                                        -
                                                                                                                        -

                                                                                                                        - SMALL_LETTERS - -

                                                                                                                        - - - - - - public - mixed - SMALL_LETTERS - = 'smallLetters' - - - -
                                                                                                                        - -
                                                                                                                        - - - -
                                                                                                                        -
                                                                                                                        -

                                                                                                                        - SPECIAL_CHARS - -

                                                                                                                        - - - - - - public - mixed - SPECIAL_CHARS - = 'specialChars' - - - -
                                                                                                                        - -
                                                                                                                        - - - -
                                                                                                                        -
                                                                                                                        - - -
                                                                                                                        -

                                                                                                                        - Properties - -

                                                                                                                        -
                                                                                                                        -

                                                                                                                        - $blnPreventAmbiguous - - - -

                                                                                                                        - - - - - protected - static mixed - $blnPreventAmbiguous - = true - -
                                                                                                                        - -
                                                                                                                        - - - -
                                                                                                                        -
                                                                                                                        -

                                                                                                                        - $framework - - - -

                                                                                                                        - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        -

                                                                                                                        - Methods - -

                                                                                                                        -
                                                                                                                        -

                                                                                                                        - __construct() - -

                                                                                                                        - - - - - public - __construct(ContaoFrameworkInterface $framework) : mixed - -
                                                                                                                        - -
                                                                                                                        Parameters
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - $framework - : ContaoFrameworkInterface -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        - - - -
                                                                                                                        Return values
                                                                                                                        - mixed - — - - -
                                                                                                                        -
                                                                                                                        -

                                                                                                                        - generate() - -

                                                                                                                        - - -

                                                                                                                        Generates a code by certain criteria.

                                                                                                                        - - - public - static generate([int $length = 8 ][, bool $preventAmbiguous = true ][, array<string|int, mixed> $alphabets = null ][, array<string|int, mixed> $rules = null ][, string $allowedSpecialChars = null ]) : mixed - - -
                                                                                                                        Parameters
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - $length - : int - = 8
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        - $preventAmbiguous - : bool - = true
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        - $alphabets - : array<string|int, mixed> - = null
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        - $rules - : array<string|int, mixed> - = null
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        - $allowedSpecialChars - : string - = null
                                                                                                                        -
                                                                                                                        -
                                                                                                                        - -
                                                                                                                        -
                                                                                                                        - - - -
                                                                                                                        Return values
                                                                                                                        - mixed - — - - -
                                                                                                                        -
                                                                                                                        - - - - -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -
                                                                                                                        -

                                                                                                                        Search results

                                                                                                                        - -
                                                                                                                        -
                                                                                                                        -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-PdfCreator-PdfCreatorFactory.html b/classes/HeimrichHannot-UtilsBundle-StaticUtil-SUtils.html similarity index 65% rename from classes/HeimrichHannot-UtilsBundle-PdfCreator-PdfCreatorFactory.html rename to classes/HeimrichHannot-UtilsBundle-StaticUtil-SUtils.html index c1bb6d0b..1b922b3d 100644 --- a/classes/HeimrichHannot-UtilsBundle-PdfCreator-PdfCreatorFactory.html +++ b/classes/HeimrichHannot-UtilsBundle-StaticUtil-SUtils.html @@ -86,12 +86,12 @@

                                                                                                                          Fil

                                                                                                                          - PdfCreatorFactory + SUtils
                                                                                                                          @@ -105,31 +105,16 @@

                                                                                                                          -

                                                                                                                          Class PdfCreatorFactory.

                                                                                                                          - - + +
                                                                                                                          -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          PdfCreator was moved into it's own bundle (heimrichhannot/pdf-creator)

                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          @@ -142,24 +127,31 @@

                                                                                                                          -
                                                                                                                          - createInstance() +
                                                                                                                          + $instances -  : AbstractPdfCreator|null +  : array<string|int, mixed>
                                                                                                                          -
                                                                                                                          Return a pdf creator instance for given type or null, if no type is registered for given type.
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          + array() + +  : StaticArrayUtil +
                                                                                                                          +
                                                                                                                          - getTypes() + class() -  : array<string|int, mixed> +  : StaticClassUtil
                                                                                                                          -
                                                                                                                          Return supported pdf creator types.
                                                                                                                          +
                                                                                                                          - getPdfCreatorRegistry() + getInstance() -  : mixed +  : T
                                                                                                                          @@ -170,11 +162,51 @@

                                                                                                                          +
                                                                                                                          +

                                                                                                                          + Properties + +

                                                                                                                          +
                                                                                                                          +

                                                                                                                          + $instances + + + +

                                                                                                                          + + + + + protected + static array<string|int, mixed> + $instances + = [] + +
                                                                                                                          + +
                                                                                                                          + + + +
                                                                                                                          +

                                                                                                                          Methods - +

                                                                                                                          -public -static " > -

                                                                                                                          - createInstance() - +

                                                                                                                          + array() +

                                                                                                                          -

                                                                                                                          Return a pdf creator instance for given type or null, if no type is registered for given type.

                                                                                                                          - + public - static createInstance(string $type) : AbstractPdfCreator|null + static array() : StaticArrayUtil - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $type - : string -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          +
                                                                                                                          +
                                                                                                                          Return values
                                                                                                                          - AbstractPdfCreator|null + StaticArrayUtil — @@ -226,29 +247,29 @@
                                                                                                                          Return values
                                                                                                                          -public -static " > -

                                                                                                                          - getTypes() - +

                                                                                                                          + class() +

                                                                                                                          -

                                                                                                                          Return supported pdf creator types.

                                                                                                                          - + public - static getTypes() : array<string|int, mixed> + static class() : StaticClassUtil + +
                                                                                                                          -
                                                                                                                          Return values
                                                                                                                          - array<string|int, mixed> + StaticClassUtil — @@ -259,31 +280,57 @@
                                                                                                                          Return values
                                                                                                                          -protected -static " > -

                                                                                                                          - getPdfCreatorRegistry() - +

                                                                                                                          + getInstance() +

                                                                                                                          protected - static getPdfCreatorRegistry() : mixed - -
                                                                                                                          + static getInstance(class-string<\HeimrichHannot\UtilsBundle\StaticUtil\T> $class) : T +
                                                                                                                          Parameters
                                                                                                                          +
                                                                                                                          +
                                                                                                                          + $class + : class-string<\HeimrichHannot\UtilsBundle\StaticUtil\T> +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          + +
                                                                                                                          + Tags + +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          + template +
                                                                                                                          +
                                                                                                                          + +

                                                                                                                          T

                                                                                                                          +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          Return values
                                                                                                                          - mixed + T — - +

                                                                                                                          The instance of the given class.

                                                                                                                          +
                                                                                                                          +
                                                                                                                          @@ -364,7 +411,7 @@

                                                                                                                          Search results

                                                                                                                          - + diff --git a/classes/HeimrichHannot-UtilsBundle-Util-Type-ArrayUtil.html b/classes/HeimrichHannot-UtilsBundle-StaticUtil-StaticArrayUtil.html similarity index 78% rename from classes/HeimrichHannot-UtilsBundle-Util-Type-ArrayUtil.html rename to classes/HeimrichHannot-UtilsBundle-StaticUtil-StaticArrayUtil.html index 32b15d03..5b176150 100644 --- a/classes/HeimrichHannot-UtilsBundle-Util-Type-ArrayUtil.html +++ b/classes/HeimrichHannot-UtilsBundle-StaticUtil-StaticArrayUtil.html @@ -86,14 +86,16 @@

                                                                                                                          Fil

                                                                                                                          - ArrayUtil + StaticArrayUtil + + extends AbstractStaticUtil +
                                                                                                                          in package @@ -106,9 +108,9 @@

                                                                                                                          @@ -129,25 +131,25 @@

                                                                                                                          - insertAfterKey() + insertAfterKey()  : void
                                                                                                                          Insert a value into an existing array by key name.
                                                                                                                          - insertBeforeKey() + insertBeforeKey() -  : mixed +  : void
                                                                                                                          Insert a new entry before a specific or multiple keys in array.
                                                                                                                          - removeValue() + removeValue()  : bool
                                                                                                                          -
                                                                                                                          Removes a value in an array.
                                                                                                                          +
                                                                                                                          Removes a value from an array.
                                                                                                                          @@ -160,22 +162,22 @@

                                                                                                                          Methods - +

                                                                                                                          insertAfterKey() - +

                                                                                                                          @@ -183,13 +185,13 @@

                                                                                                                          public - insertAfterKey(array<string|int, mixed> &$array, string $key, mixed $value[, string $newKey = null ][, array<string|int, mixed> $options = [] ]) : void + static insertAfterKey(array<string|int, mixed> &$array, string $key, mixed $value[, string $newKey = null ][, array<string|int, mixed> $options = [] ]) : void

                                                                                                                          Additional options:

                                                                                                                          • (bool) strict: Strict behavior for array search. Default false
                                                                                                                            • -
                                                                                                                          • (bool) attachIfKeyNotExist: Attach value at the end of the array if key not exist. Default: true
                                                                                                                            • -
                                                                                                                          • (int) offset: Add an additional offset
                                                                                                                            • +
                                                                                                                          • (bool) attachMissingKey: Attach value to the end of the array if the key does not exist. Default: true
                                                                                                                            • +
                                                                                                                          • (int) offset: Add additional offset.
                                                                                                                          @@ -235,8 +237,7 @@

                                                                                                                          Parameters
                                                                                                                          : array<string|int, mixed> = []

                                                                                                                          -

                                                                                                                          Additional options

                                                                                                                          -
                                                                                                                          +
                                                                                                                          @@ -257,12 +258,12 @@

                                                                                                                          Return values
                                                                                                                          >

                                                                                                                          insertBeforeKey() - +

                                                                                                                          @@ -270,7 +271,7 @@

                                                                                                                          public - static insertBeforeKey(array<string|int, mixed> &$array, string|array<string|int, mixed> $keys, string $newKey, mixed $newValue) : mixed + static insertBeforeKey(array<string|int, mixed> &$array, array<string|int, mixed>|string $keys, string $newKey, mixed $newValue) : void

                                                                                                                          If the keys not exist, the new entry is added to the end of the array. Array is passed as reference.

                                                                                                                          @@ -289,7 +290,7 @@
                                                                                                                          Parameters
                                                                                                                          $keys - : string|array<string|int, mixed> + : array<string|int, mixed>|string

                                                                                                                          The key or keys where the new entry should be added before

                                                                                                                          @@ -319,7 +320,7 @@
                                                                                                                          Parameters
                                                                                                                          Return values
                                                                                                                          - mixed + void — @@ -328,34 +329,35 @@
                                                                                                                          Return values
                                                                                                                          class="phpdocumentor-element -method -public - " + -static " >

                                                                                                                          removeValue() - +

                                                                                                                          -

                                                                                                                          Removes a value in an array.

                                                                                                                          +

                                                                                                                          Removes a value from an array.

                                                                                                                          public - removeValue( $value, array<string|int, mixed> &$array) : bool + static removeValue(mixed $value, array<string|int, mixed> &$array) : bool
                                                                                                                          Parameters
                                                                                                                          $value - : + : mixed
                                                                                                                          - +
                                                                                                                          +
                                                                                                                          $array @@ -455,7 +457,7 @@

                                                                                                                          Search results

                                                                                                                          - + diff --git a/classes/HeimrichHannot-UtilsBundle-DependencyInjection-Configuration.html b/classes/HeimrichHannot-UtilsBundle-StaticUtil-StaticClassUtil.html similarity index 74% rename from classes/HeimrichHannot-UtilsBundle-DependencyInjection-Configuration.html rename to classes/HeimrichHannot-UtilsBundle-StaticUtil-StaticClassUtil.html index a69d57d0..398044ea 100644 --- a/classes/HeimrichHannot-UtilsBundle-DependencyInjection-Configuration.html +++ b/classes/HeimrichHannot-UtilsBundle-StaticUtil-StaticClassUtil.html @@ -86,13 +86,16 @@

                                                                                                                          Fil

                                                                                                                          - Configuration + StaticClassUtil + + extends AbstractStaticUtil +
                                                                                                                          in package @@ -101,16 +104,13 @@

                                                                                                                          - - implements - ConfigurationInterface

                                                                                                                          @@ -122,17 +122,6 @@

                                                                                                                          -

                                                                                                                          - Interfaces, Classes and Traits - -

                                                                                                                          - -
                                                                                                                          -
                                                                                                                          ConfigurationInterface
                                                                                                                          -
                                                                                                                          - - -

                                                                                                                          @@ -142,11 +131,11 @@

                                                                                                                          - getConfigTreeBuilder() + hasTrait() -  : TreeBuilder +  : bool
                                                                                                                          -
                                                                                                                          Generates the configuration tree builder.
                                                                                                                          +
                                                                                                                          Check if a class or any of its parents implements a trait.
                                                                                                                          @@ -159,39 +148,60 @@

                                                                                                                          Methods - +

                                                                                                                          -

                                                                                                                          - getConfigTreeBuilder() - +

                                                                                                                          + hasTrait() +

                                                                                                                          -

                                                                                                                          Generates the configuration tree builder.

                                                                                                                          +

                                                                                                                          Check if a class or any of its parents implements a trait.

                                                                                                                          public - getConfigTreeBuilder() : TreeBuilder + static hasTrait(object|class-string $class, class-string $trait) : bool - +
                                                                                                                          Parameters
                                                                                                                          +
                                                                                                                          +
                                                                                                                          + $class + : object|class-string +
                                                                                                                          +
                                                                                                                          +

                                                                                                                          The class to check.

                                                                                                                          +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          + $trait + : class-string +
                                                                                                                          +
                                                                                                                          +

                                                                                                                          The trait to check for.

                                                                                                                          +
                                                                                                                          + +
                                                                                                                          +
                                                                                                                          +
                                                                                                                          Return values
                                                                                                                          - TreeBuilder + bool — -

                                                                                                                          The tree builder

                                                                                                                          +

                                                                                                                          True if the class or any of its parents implements the trait, false otherwise.

                                                                                                                          @@ -274,7 +284,7 @@

                                                                                                                          Search results

                                                                                                                          - + diff --git a/classes/HeimrichHannot-UtilsBundle-String-StringUtil.html b/classes/HeimrichHannot-UtilsBundle-String-StringUtil.html deleted file mode 100644 index 1e8b4a26..00000000 --- a/classes/HeimrichHannot-UtilsBundle-String-StringUtil.html +++ /dev/null @@ -1,2263 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                                          -

                                                                                                                          Contao Utils Bundle

                                                                                                                          - - -
                                                                                                                          - -
                                                                                                                          - - -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - - - -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          - StringUtil - - -
                                                                                                                          - in package - -
                                                                                                                          - - -

                                                                                                                          - - - -

                                                                                                                          Class StringUtil.

                                                                                                                          - - - -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          Use Utils service instead

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - - - - - -

                                                                                                                          - Table of Contents - -

                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - CAPITAL_LETTERS - -  = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ' -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - CAPITAL_LETTERS_NONAMBIGUOUS - -  = 'ABCDEFGHJKLMNPQRSTUVWX' -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - NUMBERS - -  = '0123456789' -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - NUMBERS_NONAMBIGUOUS - -  = '23456789' -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - SMALL_LETTERS - -  = 'abcdefghijklmnopqrstuvwxyz' -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - SMALL_LETTERS_NONAMBIGUOUS - -  = 'abcdefghjkmnpqrstuvwx' -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - $framework - -  : ContaoFrameworkInterface -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - $utils - -  : Utils -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - __construct() - -  : mixed -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - camelCaseToDashed() - -  : string -
                                                                                                                          -
                                                                                                                          Convert a camel case string to a dashed string.
                                                                                                                          - -
                                                                                                                          - camelCaseToSnake() - -  : string -
                                                                                                                          -
                                                                                                                          Convert a camel case string to a snake cased string.
                                                                                                                          - -
                                                                                                                          - convertToInlineCss() - -  : string -
                                                                                                                          -
                                                                                                                          Convert css into inline styles.
                                                                                                                          - -
                                                                                                                          - convertXmlToArray() - -  : mixed -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - endsWith() - -  : bool -
                                                                                                                          -
                                                                                                                          Check for the occurrence at the end of the string.
                                                                                                                          - -
                                                                                                                          - ensureLineBreaks() - -  : string -
                                                                                                                          -
                                                                                                                          Ensure line breaks for several languages.
                                                                                                                          - -
                                                                                                                          - html2Text() - -  : string -
                                                                                                                          -
                                                                                                                          Converts html to text.
                                                                                                                          - -
                                                                                                                          - lowerCase() - -  : string -
                                                                                                                          -
                                                                                                                          Convenience method for lower casing in a save callback.
                                                                                                                          - -
                                                                                                                          - pregReplaceLast() - -  : mixed|string -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - random() - -  : mixed -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - randomChar() - -  : mixed -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - randomLetter() - -  : mixed -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - randomNumber() - -  : mixed -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - removeLeadingAndTrailingSlash() - -  : string -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - removeLeadingString() - -  : mixed -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - removeTrailingString() - -  : mixed -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - replaceInsertTags() - -  : string -
                                                                                                                          -
                                                                                                                          Replace insert tags with their values.
                                                                                                                          - -
                                                                                                                          - replaceUnicodeEmojisByHtml() - -  : array<string|int, mixed>|string|array<string|int, string>|null -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          - restoreBasicEntities() - -  : string -
                                                                                                                          -
                                                                                                                          Restore basic entities.
                                                                                                                          - -
                                                                                                                          - startsWith() - -  : bool -
                                                                                                                          -
                                                                                                                          Check for the occurrence at the start of the string.
                                                                                                                          - -
                                                                                                                          - truncateHtml() - -  : string -
                                                                                                                          -
                                                                                                                          Truncates a given string respecting html element.
                                                                                                                          - -
                                                                                                                          - - - - -
                                                                                                                          -

                                                                                                                          - Constants - -

                                                                                                                          -
                                                                                                                          -

                                                                                                                          - CAPITAL_LETTERS - -

                                                                                                                          - - - - - - public - mixed - CAPITAL_LETTERS - = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ' - - - -
                                                                                                                          - -
                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - CAPITAL_LETTERS_NONAMBIGUOUS - -

                                                                                                                          - - - - - - public - mixed - CAPITAL_LETTERS_NONAMBIGUOUS - = 'ABCDEFGHJKLMNPQRSTUVWX' - - - -
                                                                                                                          - -
                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - NUMBERS - -

                                                                                                                          - - - - - - public - mixed - NUMBERS - = '0123456789' - - - -
                                                                                                                          - -
                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - NUMBERS_NONAMBIGUOUS - -

                                                                                                                          - - - - - - public - mixed - NUMBERS_NONAMBIGUOUS - = '23456789' - - - -
                                                                                                                          - -
                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - SMALL_LETTERS - -

                                                                                                                          - - - - - - public - mixed - SMALL_LETTERS - = 'abcdefghijklmnopqrstuvwxyz' - - - -
                                                                                                                          - -
                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - SMALL_LETTERS_NONAMBIGUOUS - -

                                                                                                                          - - - - - - public - mixed - SMALL_LETTERS_NONAMBIGUOUS - = 'abcdefghjkmnpqrstuvwx' - - - -
                                                                                                                          - -
                                                                                                                          - - - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -

                                                                                                                          - Properties - -

                                                                                                                          -
                                                                                                                          -

                                                                                                                          - $framework - - - -

                                                                                                                          - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - $utils - - - -

                                                                                                                          - - - - - protected - Utils - $utils - - - - - - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -

                                                                                                                          - Methods - -

                                                                                                                          -
                                                                                                                          -

                                                                                                                          - __construct() - -

                                                                                                                          - - - - - public - __construct(ContaoFrameworkInterface $framework, Utils $utils) : mixed - -
                                                                                                                          - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $framework - : ContaoFrameworkInterface -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - $utils - : Utils -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - - -
                                                                                                                          Return values
                                                                                                                          - mixed - — - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - camelCaseToDashed() - -

                                                                                                                          - - -

                                                                                                                          Convert a camel case string to a dashed string.

                                                                                                                          - - - public - camelCaseToDashed(string $value) : string - -

                                                                                                                          Example: MyPrettyClass to my-pretty-class

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $value - : string -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          Use utils service instead

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - codeCoverageIgnore -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Return values
                                                                                                                          - string - — - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - camelCaseToSnake() - -

                                                                                                                          - - -

                                                                                                                          Convert a camel case string to a snake cased string.

                                                                                                                          - - - public - camelCaseToSnake(string $value) : string - -

                                                                                                                          Example: MyPrettyClass to my_pretty_class

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $value - : string -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          Use utils service instead

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - codeCoverageIgnore -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Return values
                                                                                                                          - string - — - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - convertToInlineCss() - -

                                                                                                                          - - -

                                                                                                                          Convert css into inline styles.

                                                                                                                          - - - public - convertToInlineCss(string $text[, array<string|int, mixed> $cssText = null ]) : string - - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $text - : string -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - $cssText - : array<string|int, mixed> - = null
                                                                                                                          -
                                                                                                                          -

                                                                                                                          the css as text (no paths allowed atm)

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - codeCoverageIgnore -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          Use CssInliner-Library directly in your code. We recommend tijsverkoyen/css-to-inline-styles (https://github.com/tijsverkoyen/CssToInlineStyles)

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Return values
                                                                                                                          - string - — - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - convertXmlToArray() - -

                                                                                                                          - - - - - public - convertXmlToArray(string $xmlData) : mixed - - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $xmlData - : string -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - codeCoverageIgnore -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          Use utils service instead

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Return values
                                                                                                                          - mixed - — - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - endsWith() - -

                                                                                                                          - - -

                                                                                                                          Check for the occurrence at the end of the string.

                                                                                                                          - - - public - endsWith(string $haystack, string $needle) : bool - - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $haystack - : string -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          The string to search in

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - $needle - : string -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          The needle

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          Use utils service instead

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - codeCoverageIgnore -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Return values
                                                                                                                          - bool - — - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - ensureLineBreaks() - -

                                                                                                                          - - -

                                                                                                                          Ensure line breaks for several languages.

                                                                                                                          - - - public - ensureLineBreaks(string $buffer[, string $language = 'en' ]) : string - - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $buffer - : string -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - $language - : string - = 'en'
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          use locale util of utils service instead

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Return values
                                                                                                                          - string - — - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - html2Text() - -

                                                                                                                          - - -

                                                                                                                          Converts html to text.

                                                                                                                          - - - public - html2Text(string $html[, array<string|int, mixed> $options = [] ]) : string - - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $html - : string -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - $options - : array<string|int, mixed> - = []
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - throws -
                                                                                                                          -
                                                                                                                          - Html2TextException - - -
                                                                                                                          -
                                                                                                                          - codeCoverageIgnore -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          Use html2text-library direct in your code, we recommend html2text/html2text (https://github.com/mtibben/html2text)

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Return values
                                                                                                                          - string - — - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - lowerCase() - -

                                                                                                                          - - -

                                                                                                                          Convenience method for lower casing in a save callback.

                                                                                                                          - - - public - lowerCase( $value, DataContainer $objDc) : string - - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $value - : -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - $objDc - : DataContainer -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - codeCoverageIgnore -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          Deprecated in favor of custom callback that could be used with contao service callbacks

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Return values
                                                                                                                          - string - — - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - pregReplaceLast() - -

                                                                                                                          - - - - - public - pregReplaceLast(string $regExp, string $subject) : mixed|string - - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $regExp - : string -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - $subject - : string -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - codeCoverageIgnore -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          Use utils service instead

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Return values
                                                                                                                          - mixed|string - — - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - random() - -

                                                                                                                          - - - - - public - random(string $charList) : mixed - - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $charList - : string -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - codeCoverageIgnore -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          Use utils service instead

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Return values
                                                                                                                          - mixed - — - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - randomChar() - -

                                                                                                                          - - - - - public - randomChar([bool $includeAmbiguousChars = false ]) : mixed - - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $includeAmbiguousChars - : bool - = false
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - codeCoverageIgnore -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          Use utils service instead

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Return values
                                                                                                                          - mixed - — - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - randomLetter() - -

                                                                                                                          - - - - - public - randomLetter([bool $includeAmbiguousChars = false ]) : mixed - - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $includeAmbiguousChars - : bool - = false
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - codeCoverageIgnore -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          Use utils service instead

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Return values
                                                                                                                          - mixed - — - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - randomNumber() - -

                                                                                                                          - - - - - public - randomNumber([bool $includeAmbiguousChars = false ]) : mixed - - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $includeAmbiguousChars - : bool - = false
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - codeCoverageIgnore -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          Use utils service instead

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Return values
                                                                                                                          - mixed - — - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - removeLeadingAndTrailingSlash() - -

                                                                                                                          - - - - - public - removeLeadingAndTrailingSlash(string $string) : string - - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $string - : string -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - codeCoverageIgnore -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          Use trim($string, "/") instead

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Return values
                                                                                                                          - string - — - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - removeLeadingString() - -

                                                                                                                          - - - - - public - removeLeadingString(string $string, string $subject) : mixed - - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $string - : string -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - $subject - : string -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - codeCoverageIgnore -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          Use utils service instead

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Return values
                                                                                                                          - mixed - — - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - removeTrailingString() - -

                                                                                                                          - - - - - public - removeTrailingString(string $string, string $subject) : mixed - - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $string - : string -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - $subject - : string -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - codeCoverageIgnore -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          Use utils service instead

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Return values
                                                                                                                          - mixed - — - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - replaceInsertTags() - -

                                                                                                                          - - -

                                                                                                                          Replace insert tags with their values.

                                                                                                                          - - - public - replaceInsertTags(string $buffer[, bool $cache = true ]) : string - - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $buffer - : string -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          The text with the tags to be replaced

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - $cache - : bool - = true
                                                                                                                          -
                                                                                                                          -

                                                                                                                          If false, non-cacheable tags will be replaced

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - codeCoverageIgnore -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          Use Controller::replaceInsertTags as adapter

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Return values
                                                                                                                          - string - — -

                                                                                                                          The text with the replaced tags

                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - replaceUnicodeEmojisByHtml() - -

                                                                                                                          - - - - - public - replaceUnicodeEmojisByHtml(string|null $text) : array<string|int, mixed>|string|array<string|int, string>|null - - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $text - : string|null -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - codeCoverageIgnore -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          Will be removed in version 3.0. Use elvanto/litemoji (https://github.com/elvanto/litemoji) instead.

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Return values
                                                                                                                          - array<string|int, mixed>|string|array<string|int, string>|null - — - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - restoreBasicEntities() - -

                                                                                                                          - - -

                                                                                                                          Restore basic entities.

                                                                                                                          - - - public - restoreBasicEntities(string $string) : string - - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $string - : string -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          The string with the tags to be replaced

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - codeCoverageIgnore -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          use \Contao\StringUtil::restoreBasicEntities() instead

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Return values
                                                                                                                          - string - — -

                                                                                                                          The string with the original entities

                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - startsWith() - -

                                                                                                                          - - -

                                                                                                                          Check for the occurrence at the start of the string.

                                                                                                                          - - - public - startsWith( $haystack,  $needle) : bool - - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $haystack - : -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          string The string to search in

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - $needle - : -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          string The needle

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          Use utils service instead

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - codeCoverageIgnore -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Return values
                                                                                                                          - bool - — - - -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          - truncateHtml() - -

                                                                                                                          - - -

                                                                                                                          Truncates a given string respecting html element.

                                                                                                                          - - - public - truncateHtml(string $text[, int $length = 100 ][, string $ending = '&nbsp;&hellip;' ][, bool $exact = false ][, bool $considerHtml = true ]) : string - - -
                                                                                                                          Parameters
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - $text - : string -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - $length - : int - = 100
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - $ending - : string - = '&nbsp;&hellip;'
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - $exact - : bool - = false
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - $considerHtml - : bool - = true
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          - Tags - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          - codeCoverageIgnore -
                                                                                                                          -
                                                                                                                          - - -
                                                                                                                          -
                                                                                                                          - deprecated -
                                                                                                                          -
                                                                                                                          - -

                                                                                                                          Use utils service instead

                                                                                                                          -
                                                                                                                          - -
                                                                                                                          -
                                                                                                                          - -
                                                                                                                          Return values
                                                                                                                          - string - — - - -
                                                                                                                          -
                                                                                                                          - - - - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -
                                                                                                                          -

                                                                                                                          Search results

                                                                                                                          - -
                                                                                                                          -
                                                                                                                          -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Template-TemplateUtil.html b/classes/HeimrichHannot-UtilsBundle-Template-TemplateUtil.html deleted file mode 100644 index 1279e134..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Template-TemplateUtil.html +++ /dev/null @@ -1,1099 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                                            -

                                                                                                                            Contao Utils Bundle

                                                                                                                            - - -
                                                                                                                            - -
                                                                                                                            - - -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - - - - -
                                                                                                                            - - -
                                                                                                                            -

                                                                                                                            - TemplateUtil - - -
                                                                                                                            - in package - -
                                                                                                                            - - -

                                                                                                                            - - - - -
                                                                                                                            - - - - - - - - -

                                                                                                                            - Table of Contents - -

                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - $cache - -  : FilesystemAdapter -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            - $container - -  : ContainerInterface -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            - $containerUtil - -  : ContainerUtil -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            - $twigFiles - -  : array<string|int, mixed> -
                                                                                                                            -
                                                                                                                            Known files.
                                                                                                                            - -
                                                                                                                            - $kernel - -  : KernelInterface -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            - __construct() - -  : mixed -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            - findTemplates() - -  : array<string|int, mixed> -
                                                                                                                            -
                                                                                                                            Return the files matching a GLOB pattern.
                                                                                                                            - -
                                                                                                                            - getAllTemplates() - -  : mixed -
                                                                                                                            -
                                                                                                                            Get a list of all available templates.
                                                                                                                            - -
                                                                                                                            - getBundleTemplate() - -  : string -
                                                                                                                            -
                                                                                                                            Find a particular template file within all bundles and return its path.
                                                                                                                            - -
                                                                                                                            - getPageAliasAsCssClass() - -  : mixed -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            - getTemplate() - -  : string -
                                                                                                                            -
                                                                                                                            Find a particular template file and return its path.
                                                                                                                            - -
                                                                                                                            - getTemplateGroup() - -  : array<string|int, mixed> -
                                                                                                                            -
                                                                                                                            Return all template files of a particular group as array.
                                                                                                                            - -
                                                                                                                            - isTemplatePartEmpty() - -  : bool -
                                                                                                                            -
                                                                                                                            Return true, if the template part is empty.
                                                                                                                            - -
                                                                                                                            - removeTemplateComment() - -  : mixed -
                                                                                                                            -
                                                                                                                            remove TEMPLATE START/END comment from template if in debug mode.
                                                                                                                            - -
                                                                                                                            - renderTwigTemplate() - -  : string -
                                                                                                                            -
                                                                                                                            Renders a twig template with data.
                                                                                                                            - -
                                                                                                                            - - - - - - -
                                                                                                                            -

                                                                                                                            - Properties - -

                                                                                                                            -
                                                                                                                            -

                                                                                                                            - $cache - - - -

                                                                                                                            - - - - - protected - FilesystemAdapter - $cache - - - - - - -
                                                                                                                            -
                                                                                                                            -

                                                                                                                            - $container - - - -

                                                                                                                            - - - - - protected - ContainerInterface - $container - - - - - - -
                                                                                                                            - -
                                                                                                                            -

                                                                                                                            - $twigFiles - - - -

                                                                                                                            - - -

                                                                                                                            Known files.

                                                                                                                            - - - protected - static array<string|int, mixed> - $twigFiles - = [] - - - - - -
                                                                                                                            -
                                                                                                                            -

                                                                                                                            - $kernel - - - -

                                                                                                                            - - - - - private - KernelInterface - $kernel - - - - - - -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -

                                                                                                                            - Methods - -

                                                                                                                            -
                                                                                                                            -

                                                                                                                            - __construct() - -

                                                                                                                            - - - - - public - __construct(ContainerInterface $container) : mixed - -
                                                                                                                            - -
                                                                                                                            Parameters
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - $container - : ContainerInterface -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - - - -
                                                                                                                            Return values
                                                                                                                            - mixed - — - - -
                                                                                                                            -
                                                                                                                            -

                                                                                                                            - findTemplates() - -

                                                                                                                            - - -

                                                                                                                            Return the files matching a GLOB pattern.

                                                                                                                            - - - public - findTemplates(string $path[, string $pattern = null ][, string $format = 'twig' ]) : array<string|int, mixed> - - -
                                                                                                                            Parameters
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - $path - : string -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - $pattern - : string - = null
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - $format - : string - = 'twig'
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - - - -
                                                                                                                            Return values
                                                                                                                            - array<string|int, mixed> - — - - -
                                                                                                                            -
                                                                                                                            -

                                                                                                                            - getAllTemplates() - -

                                                                                                                            - - -

                                                                                                                            Get a list of all available templates.

                                                                                                                            - - - public - getAllTemplates() : mixed - - - - - -
                                                                                                                            Return values
                                                                                                                            - mixed - — - - -
                                                                                                                            -
                                                                                                                            -

                                                                                                                            - getBundleTemplate() - -

                                                                                                                            - - -

                                                                                                                            Find a particular template file within all bundles and return its path.

                                                                                                                            - - - public - getBundleTemplate(string $name[, string $format = 'html.twig' ]) : string - - -
                                                                                                                            Parameters
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - $name - : string -
                                                                                                                            -
                                                                                                                            -

                                                                                                                            The name of the template

                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - $format - : string - = 'html.twig'
                                                                                                                            -
                                                                                                                            -

                                                                                                                            The file extension

                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            - Tags - -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - throws -
                                                                                                                            -
                                                                                                                            - InvalidArgumentException - -

                                                                                                                            If $strFormat is unknown

                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - throws -
                                                                                                                            -
                                                                                                                            - RuntimeException - -

                                                                                                                            If the template group folder is insecure

                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            Return values
                                                                                                                            - string - — -

                                                                                                                            The path to the template file

                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -
                                                                                                                            -

                                                                                                                            - getPageAliasAsCssClass() - -

                                                                                                                            - - - - - public - getPageAliasAsCssClass() : mixed - -
                                                                                                                            - - - - -
                                                                                                                            Return values
                                                                                                                            - mixed - — - - -
                                                                                                                            -
                                                                                                                            -

                                                                                                                            - getTemplate() - -

                                                                                                                            - - -

                                                                                                                            Find a particular template file and return its path.

                                                                                                                            - - - public - getTemplate(string $name[, string $format = 'twig' ]) : string - - -
                                                                                                                            Parameters
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - $name - : string -
                                                                                                                            -
                                                                                                                            -

                                                                                                                            The name of the template

                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - $format - : string - = 'twig'
                                                                                                                            -
                                                                                                                            -

                                                                                                                            The file extension

                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            - Tags - -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - throws -
                                                                                                                            -
                                                                                                                            - InvalidArgumentException - -

                                                                                                                            If $strFormat is unknown

                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - throws -
                                                                                                                            -
                                                                                                                            - RuntimeException - -

                                                                                                                            If the template group folder is insecure

                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - throws -
                                                                                                                            -
                                                                                                                            - Twig_Error_Loader - - -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            Return values
                                                                                                                            - string - — -

                                                                                                                            The path to the template file

                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -
                                                                                                                            -

                                                                                                                            - getTemplateGroup() - -

                                                                                                                            - - -

                                                                                                                            Return all template files of a particular group as array.

                                                                                                                            - - - public - getTemplateGroup(string $prefix[, string $format = 'html.twig' ]) : array<string|int, mixed> - - -
                                                                                                                            Parameters
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - $prefix - : string -
                                                                                                                            -
                                                                                                                            -

                                                                                                                            The template name prefix (e.g. "ce_")

                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - $format - : string - = 'html.twig'
                                                                                                                            -
                                                                                                                            -

                                                                                                                            The file extension

                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            - Tags - -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - coversNothing -
                                                                                                                            -
                                                                                                                            - -

                                                                                                                            As long as Controller::getTemplateGroup is not testable (ThemeModel…)

                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            Return values
                                                                                                                            - array<string|int, mixed> - — -

                                                                                                                            An array of template names (html.twig templates without file extension, others with file extension)

                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            -
                                                                                                                            -

                                                                                                                            - isTemplatePartEmpty() - -

                                                                                                                            - - -

                                                                                                                            Return true, if the template part is empty.

                                                                                                                            - - - public - isTemplatePartEmpty([string $template = null ]) : bool - -

                                                                                                                            Template comments from debug and white spaces are treated as empty.

                                                                                                                            -

                                                                                                                            Datatypes other than string (typical null) are also treated as empty.

                                                                                                                            -
                                                                                                                            - -
                                                                                                                            Parameters
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - $template - : string - = null
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - - - -
                                                                                                                            Return values
                                                                                                                            - bool - — - - -
                                                                                                                            -
                                                                                                                            -

                                                                                                                            - removeTemplateComment() - -

                                                                                                                            - - -

                                                                                                                            remove TEMPLATE START/END comment from template if in debug mode.

                                                                                                                            - - - public - removeTemplateComment(mixed $template) : mixed - - -
                                                                                                                            Parameters
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - $template - : mixed -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - - - -
                                                                                                                            Return values
                                                                                                                            - mixed - — - - -
                                                                                                                            -
                                                                                                                            -

                                                                                                                            - renderTwigTemplate() - -

                                                                                                                            - - -

                                                                                                                            Renders a twig template with data.

                                                                                                                            - - - public - renderTwigTemplate(string $name[, array<string|int, mixed> $context = [] ]) : string - - -
                                                                                                                            Parameters
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - $name - : string -
                                                                                                                            -
                                                                                                                            -

                                                                                                                            The twig template name

                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - $context - : array<string|int, mixed> - = []
                                                                                                                            -
                                                                                                                            -

                                                                                                                            The twig template context data

                                                                                                                            -
                                                                                                                            - -
                                                                                                                            -
                                                                                                                            - - -
                                                                                                                            - Tags - -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            - throws -
                                                                                                                            -
                                                                                                                            - InvalidArgumentException - - -
                                                                                                                            -
                                                                                                                            - throws -
                                                                                                                            -
                                                                                                                            - Twig_Error_Loader - - -
                                                                                                                            -
                                                                                                                            - throws -
                                                                                                                            -
                                                                                                                            - Twig_Error_Runtime - - -
                                                                                                                            -
                                                                                                                            - throws -
                                                                                                                            -
                                                                                                                            - Twig_Error_Syntax - - -
                                                                                                                            -
                                                                                                                            - -
                                                                                                                            Return values
                                                                                                                            - string - — - - -
                                                                                                                            -
                                                                                                                            - - - - -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -
                                                                                                                            -

                                                                                                                            Search results

                                                                                                                            - -
                                                                                                                            -
                                                                                                                            -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              - - -
                                                                                                                              - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Twig-ArrayExtension.html b/classes/HeimrichHannot-UtilsBundle-Twig-ArrayExtension.html deleted file mode 100644 index 9e72ffca..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Twig-ArrayExtension.html +++ /dev/null @@ -1,352 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                                              -

                                                                                                                              Contao Utils Bundle

                                                                                                                              - - -
                                                                                                                              - -
                                                                                                                              - - -
                                                                                                                              - -
                                                                                                                              -
                                                                                                                              - - - - -
                                                                                                                              - - -
                                                                                                                              -

                                                                                                                              - ArrayExtension - - - extends AbstractExtension - - -
                                                                                                                              - in package - -
                                                                                                                              - - - implements - ContainerAwareInterface - - - Uses - ContainerAwareTrait -

                                                                                                                              - - - - -
                                                                                                                              - - - - - - -

                                                                                                                              - Interfaces, Classes and Traits - -

                                                                                                                              - -
                                                                                                                              -
                                                                                                                              ContainerAwareInterface
                                                                                                                              -
                                                                                                                              - - -
                                                                                                                              - - -

                                                                                                                              - Table of Contents - -

                                                                                                                              - -
                                                                                                                              -
                                                                                                                              - deserialize() - -  : array<string|int, mixed>|null -
                                                                                                                              -
                                                                                                                              - -
                                                                                                                              - getFilters() - -  : array<string|int, mixed>|array<string|int, Twig_SimpleFilter> -
                                                                                                                              -
                                                                                                                              Get list of twig filters.
                                                                                                                              - -
                                                                                                                              - - - - - - - -
                                                                                                                              -

                                                                                                                              - Methods - -

                                                                                                                              -
                                                                                                                              -

                                                                                                                              - deserialize() - -

                                                                                                                              - - - - - public - deserialize(string|null $text[, bool $forceArray = false ]) : array<string|int, mixed>|null - -
                                                                                                                              - -
                                                                                                                              Parameters
                                                                                                                              -
                                                                                                                              -
                                                                                                                              - $text - : string|null -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              - -
                                                                                                                              -
                                                                                                                              - $forceArray - : bool - = false
                                                                                                                              -
                                                                                                                              -
                                                                                                                              - -
                                                                                                                              -
                                                                                                                              - - - -
                                                                                                                              Return values
                                                                                                                              - array<string|int, mixed>|null - — - - -
                                                                                                                              -
                                                                                                                              -

                                                                                                                              - getFilters() - -

                                                                                                                              - - -

                                                                                                                              Get list of twig filters.

                                                                                                                              - - - public - getFilters() : array<string|int, mixed>|array<string|int, Twig_SimpleFilter> - - - - - -
                                                                                                                              Return values
                                                                                                                              - array<string|int, mixed>|array<string|int, Twig_SimpleFilter> - — - - -
                                                                                                                              -
                                                                                                                              - - - - -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -
                                                                                                                              -

                                                                                                                              Search results

                                                                                                                              - -
                                                                                                                              -
                                                                                                                              -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - - -
                                                                                                                                - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Twig-DateExtension.html b/classes/HeimrichHannot-UtilsBundle-Twig-DateExtension.html deleted file mode 100644 index 53ddf151..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Twig-DateExtension.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                                                -

                                                                                                                                Contao Utils Bundle

                                                                                                                                - - -
                                                                                                                                - -
                                                                                                                                - - -
                                                                                                                                - -
                                                                                                                                -
                                                                                                                                - - - - -
                                                                                                                                - - -
                                                                                                                                -

                                                                                                                                - DateExtension - - - extends AbstractExtension - - -
                                                                                                                                - in package - -
                                                                                                                                - - -

                                                                                                                                - - - - -
                                                                                                                                - - - - - - - - -

                                                                                                                                - Table of Contents - -

                                                                                                                                - -
                                                                                                                                -
                                                                                                                                - getFilters() - -  : array<string|int, mixed>|array<string|int, Twig_SimpleFilter> -
                                                                                                                                -
                                                                                                                                Get list of twig filters.
                                                                                                                                - -
                                                                                                                                - getLocalizedDate() - -  : string -
                                                                                                                                -
                                                                                                                                - -
                                                                                                                                - - - - - - - -
                                                                                                                                -

                                                                                                                                - Methods - -

                                                                                                                                -
                                                                                                                                -

                                                                                                                                - getFilters() - -

                                                                                                                                - - -

                                                                                                                                Get list of twig filters.

                                                                                                                                - - - public - getFilters() : array<string|int, mixed>|array<string|int, Twig_SimpleFilter> - - - - - -
                                                                                                                                Return values
                                                                                                                                - array<string|int, mixed>|array<string|int, Twig_SimpleFilter> - — - - -
                                                                                                                                -
                                                                                                                                -

                                                                                                                                - getLocalizedDate() - -

                                                                                                                                - - - - - public - getLocalizedDate(mixed $timestamp[, string $format = null ]) : string - -
                                                                                                                                - -
                                                                                                                                Parameters
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - $timestamp - : mixed -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - -
                                                                                                                                -
                                                                                                                                - $format - : string - = null
                                                                                                                                -
                                                                                                                                -
                                                                                                                                - -
                                                                                                                                -
                                                                                                                                - - - -
                                                                                                                                Return values
                                                                                                                                - string - — - - -
                                                                                                                                -
                                                                                                                                - - - - -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                -

                                                                                                                                Search results

                                                                                                                                - -
                                                                                                                                -
                                                                                                                                -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  - - -
                                                                                                                                  - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Twig-DcaExtension.html b/classes/HeimrichHannot-UtilsBundle-Twig-DcaExtension.html deleted file mode 100644 index ea18faf2..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Twig-DcaExtension.html +++ /dev/null @@ -1,352 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                                                  -

                                                                                                                                  Contao Utils Bundle

                                                                                                                                  - - -
                                                                                                                                  - -
                                                                                                                                  - - -
                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                  - - - - -
                                                                                                                                  - - -
                                                                                                                                  -

                                                                                                                                  - DcaExtension - - - extends AbstractExtension - - -
                                                                                                                                  - in package - -
                                                                                                                                  - - - implements - ContainerAwareInterface - - - Uses - ContainerAwareTrait -

                                                                                                                                  - - - - -
                                                                                                                                  - - - - - - -

                                                                                                                                  - Interfaces, Classes and Traits - -

                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                  ContainerAwareInterface
                                                                                                                                  -
                                                                                                                                  - - -
                                                                                                                                  - - -

                                                                                                                                  - Table of Contents - -

                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                  - fieldLabel() - -  : string -
                                                                                                                                  -
                                                                                                                                  - -
                                                                                                                                  - getFilters() - -  : mixed -
                                                                                                                                  -
                                                                                                                                  - -
                                                                                                                                  - - - - - - - -
                                                                                                                                  -

                                                                                                                                  - Methods - -

                                                                                                                                  -
                                                                                                                                  -

                                                                                                                                  - fieldLabel() - -

                                                                                                                                  - - - - - public - fieldLabel(string $field, string $table) : string - -
                                                                                                                                  - -
                                                                                                                                  Parameters
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  - $field - : string -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                  - $table - : string -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                  - - - -
                                                                                                                                  Return values
                                                                                                                                  - string - — - - -
                                                                                                                                  -
                                                                                                                                  -

                                                                                                                                  - getFilters() - -

                                                                                                                                  - - - - - public - getFilters() : mixed - -
                                                                                                                                  - - - - -
                                                                                                                                  Return values
                                                                                                                                  - mixed - — - - -
                                                                                                                                  -
                                                                                                                                  - - - - -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                  -

                                                                                                                                  Search results

                                                                                                                                  - -
                                                                                                                                  -
                                                                                                                                  -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - - -
                                                                                                                                    - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Twig-DownloadExtension.html b/classes/HeimrichHannot-UtilsBundle-Twig-DownloadExtension.html deleted file mode 100644 index f0fe02d9..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Twig-DownloadExtension.html +++ /dev/null @@ -1,829 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                                                    -

                                                                                                                                    Contao Utils Bundle

                                                                                                                                    - - -
                                                                                                                                    - -
                                                                                                                                    - - -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - - - - -
                                                                                                                                    - - -
                                                                                                                                    -

                                                                                                                                    - DownloadExtension - - - extends AbstractExtension - - -
                                                                                                                                    - in package - -
                                                                                                                                    - - -

                                                                                                                                    - - - - -
                                                                                                                                    - - - - - - - - -

                                                                                                                                    - Table of Contents - -

                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - $requestStack - -  : RequestStack -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - $twig - -  : Environment -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - $utils - -  : Utils -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - __construct() - -  : mixed -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    - getDownload() - -  : string -
                                                                                                                                    -
                                                                                                                                    Get download based on given path/uuid.
                                                                                                                                    - -
                                                                                                                                    - getDownloadData() - -  : array<string|int, mixed>|null -
                                                                                                                                    -
                                                                                                                                    Get download data based on given path/uuid.
                                                                                                                                    - -
                                                                                                                                    - getDownloadLink() - -  : string -
                                                                                                                                    -
                                                                                                                                    Get download link `?file=` based on given path/uuid.
                                                                                                                                    - -
                                                                                                                                    - getDownloadPath() - -  : string -
                                                                                                                                    -
                                                                                                                                    Get download path based on given path/uuid.
                                                                                                                                    - -
                                                                                                                                    - getDownloadTitle() - -  : string -
                                                                                                                                    -
                                                                                                                                    Get download title based on given path/uuid.
                                                                                                                                    - -
                                                                                                                                    - getFilters() - -  : array<string|int, mixed>|array<string|int, Twig_SimpleFilter> -
                                                                                                                                    -
                                                                                                                                    Get list of twig filters.
                                                                                                                                    - -
                                                                                                                                    - - - - - - -
                                                                                                                                    -

                                                                                                                                    - Properties - -

                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    - $requestStack - - - -

                                                                                                                                    - - - - - private - RequestStack - $requestStack - - - - - - -
                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    - $twig - - - -

                                                                                                                                    - - - - - private - Environment - $twig - - - - - - -
                                                                                                                                    - -
                                                                                                                                    - -
                                                                                                                                    -

                                                                                                                                    - Methods - -

                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    - __construct() - -

                                                                                                                                    - - - - - public - __construct(RequestStack $requestStack, Utils $utils, Environment $twig) : mixed - -
                                                                                                                                    - -
                                                                                                                                    Parameters
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - $requestStack - : RequestStack -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - $utils - : Utils -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - $twig - : Environment -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - - - -
                                                                                                                                    Return values
                                                                                                                                    - mixed - — - - -
                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    - getDownload() - -

                                                                                                                                    - - -

                                                                                                                                    Get download based on given path/uuid.

                                                                                                                                    - - - public - getDownload(mixed $path[, bool $download = true ][, array<string|int, mixed> $data = [] ][, string $template = '@HeimrichHannotContaoUtils/download.html.twig' ]) : string - - -
                                                                                                                                    Parameters
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - $path - : mixed -
                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    File path/uuid

                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - $download - : bool - = true
                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    Return link as download link if true, as download path if false

                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - $data - : array<string|int, mixed> - = []
                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    Add custom data here

                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - $template - : string - = '@HeimrichHannotContaoUtils/download.html.twig'
                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    Use custom download template

                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - - -
                                                                                                                                    - Tags - -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - throws -
                                                                                                                                    -
                                                                                                                                    - LoaderError - - -
                                                                                                                                    -
                                                                                                                                    - throws -
                                                                                                                                    -
                                                                                                                                    - RuntimeError - - -
                                                                                                                                    -
                                                                                                                                    - throws -
                                                                                                                                    -
                                                                                                                                    - SyntaxError - - -
                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    Return values
                                                                                                                                    - string - — -

                                                                                                                                    Download html element

                                                                                                                                    -
                                                                                                                                    - - -
                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    - getDownloadData() - -

                                                                                                                                    - - -

                                                                                                                                    Get download data based on given path/uuid.

                                                                                                                                    - - - public - getDownloadData(mixed $path[, array<string|int, mixed> $data = [] ]) : array<string|int, mixed>|null - - -
                                                                                                                                    Parameters
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - $path - : mixed -
                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    File path/uuid

                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - $data - : array<string|int, mixed> - = []
                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    Add custom data here

                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - - - -
                                                                                                                                    Return values
                                                                                                                                    - array<string|int, mixed>|null - — -

                                                                                                                                    Download element data

                                                                                                                                    -
                                                                                                                                    - - -
                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    - getDownloadLink() - -

                                                                                                                                    - - -

                                                                                                                                    Get download link `?file=` based on given path/uuid.

                                                                                                                                    - - - public - getDownloadLink(mixed $path[, array<string|int, mixed> $data = [] ]) : string - - -
                                                                                                                                    Parameters
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - $path - : mixed -
                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    File path/uuid

                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - $data - : array<string|int, mixed> - = []
                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    Add custom data here

                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - - - -
                                                                                                                                    Return values
                                                                                                                                    - string - — -

                                                                                                                                    File download link

                                                                                                                                    -
                                                                                                                                    - - -
                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    - getDownloadPath() - -

                                                                                                                                    - - -

                                                                                                                                    Get download path based on given path/uuid.

                                                                                                                                    - - - public - getDownloadPath(mixed $path[, array<string|int, mixed> $data = [] ]) : string - - -
                                                                                                                                    Parameters
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - $path - : mixed -
                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    File path/uuid

                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - $data - : array<string|int, mixed> - = []
                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    Add custom data here

                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - - - -
                                                                                                                                    Return values
                                                                                                                                    - string - — -

                                                                                                                                    File path

                                                                                                                                    -
                                                                                                                                    - - -
                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    - getDownloadTitle() - -

                                                                                                                                    - - -

                                                                                                                                    Get download title based on given path/uuid.

                                                                                                                                    - - - public - getDownloadTitle(mixed $path[, array<string|int, mixed> $data = [] ]) : string - - -
                                                                                                                                    Parameters
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    - $path - : mixed -
                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    File path/uuid

                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - $data - : array<string|int, mixed> - = []
                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    Add custom data here

                                                                                                                                    -
                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    - - - -
                                                                                                                                    Return values
                                                                                                                                    - string - — -

                                                                                                                                    Download title

                                                                                                                                    -
                                                                                                                                    - - -
                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    - getFilters() - -

                                                                                                                                    - - -

                                                                                                                                    Get list of twig filters.

                                                                                                                                    - - - public - getFilters() : array<string|int, mixed>|array<string|int, Twig_SimpleFilter> - - - - - -
                                                                                                                                    Return values
                                                                                                                                    - array<string|int, mixed>|array<string|int, Twig_SimpleFilter> - — - - -
                                                                                                                                    -
                                                                                                                                    - - - - -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                    -

                                                                                                                                    Search results

                                                                                                                                    - -
                                                                                                                                    -
                                                                                                                                    -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      - - -
                                                                                                                                      - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Twig-FileExtension.html b/classes/HeimrichHannot-UtilsBundle-Twig-FileExtension.html deleted file mode 100644 index 3265e5f9..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Twig-FileExtension.html +++ /dev/null @@ -1,577 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                                                      -

                                                                                                                                      Contao Utils Bundle

                                                                                                                                      - - -
                                                                                                                                      - -
                                                                                                                                      - - -
                                                                                                                                      - -
                                                                                                                                      -
                                                                                                                                      - - - - -
                                                                                                                                      - - -
                                                                                                                                      -

                                                                                                                                      - FileExtension - - - extends AbstractExtension - - -
                                                                                                                                      - in package - -
                                                                                                                                      - - - implements - ContainerAwareInterface - - - Uses - ContainerAwareTrait -

                                                                                                                                      - - - - -
                                                                                                                                      - - - - - - -

                                                                                                                                      - Interfaces, Classes and Traits - -

                                                                                                                                      - -
                                                                                                                                      -
                                                                                                                                      ContainerAwareInterface
                                                                                                                                      -
                                                                                                                                      - - -
                                                                                                                                      - - -

                                                                                                                                      - Table of Contents - -

                                                                                                                                      - -
                                                                                                                                      -
                                                                                                                                      - FILE_OBJECT_PROPERTIES - -  = ['size', 'readableFilesize', 'filesize', 'name', 'basename', 'dirname', 'filename', 'extension', 'origext', 'tmpname', 'path', 'value', 'mime', 'ctime', 'mtime', 'atime', 'icon', 'imageSize', 'width', 'height', 'imageViewSize', 'viewWidth', 'viewHeight', 'isImage', 'isGdImage', 'isSvgImage', 'channels', 'bits', 'isRgbImage', 'isCmykImage'] -
                                                                                                                                      -
                                                                                                                                      - -
                                                                                                                                      - convertBinaryToUuid() - -  : mixed -
                                                                                                                                      -
                                                                                                                                      - -
                                                                                                                                      - getFileContent() - -  : mixed -
                                                                                                                                      -
                                                                                                                                      - -
                                                                                                                                      - getFileData() - -  : array<string|int, mixed> -
                                                                                                                                      -
                                                                                                                                      Get file data based on given uuid.
                                                                                                                                      - -
                                                                                                                                      - getFilePath() - -  : string -
                                                                                                                                      -
                                                                                                                                      Get file path based on given uuid.
                                                                                                                                      - -
                                                                                                                                      - getFilters() - -  : array<string|int, mixed>|array<string|int, Twig_SimpleFilter> -
                                                                                                                                      -
                                                                                                                                      Get list of twig filters.
                                                                                                                                      - -
                                                                                                                                      - - - - -
                                                                                                                                      -

                                                                                                                                      - Constants - -

                                                                                                                                      -
                                                                                                                                      -

                                                                                                                                      - FILE_OBJECT_PROPERTIES - -

                                                                                                                                      - - - - - - public - mixed - FILE_OBJECT_PROPERTIES - = ['size', 'readableFilesize', 'filesize', 'name', 'basename', 'dirname', 'filename', 'extension', 'origext', 'tmpname', 'path', 'value', 'mime', 'ctime', 'mtime', 'atime', 'icon', 'imageSize', 'width', 'height', 'imageViewSize', 'viewWidth', 'viewHeight', 'isImage', 'isGdImage', 'isSvgImage', 'channels', 'bits', 'isRgbImage', 'isCmykImage'] - - - -
                                                                                                                                      - -
                                                                                                                                      - - - -
                                                                                                                                      -
                                                                                                                                      - - - -
                                                                                                                                      -

                                                                                                                                      - Methods - -

                                                                                                                                      -
                                                                                                                                      -

                                                                                                                                      - convertBinaryToUuid() - -

                                                                                                                                      - - - - - public - convertBinaryToUuid(mixed $binary) : mixed - -
                                                                                                                                      - -
                                                                                                                                      Parameters
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      - $binary - : mixed -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      - -
                                                                                                                                      -
                                                                                                                                      - - - -
                                                                                                                                      Return values
                                                                                                                                      - mixed - — - - -
                                                                                                                                      -
                                                                                                                                      -

                                                                                                                                      - getFileContent() - -

                                                                                                                                      - - - - - public - getFileContent(mixed $file) : mixed - -
                                                                                                                                      - -
                                                                                                                                      Parameters
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      - $file - : mixed -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      - -
                                                                                                                                      -
                                                                                                                                      - - - -
                                                                                                                                      Return values
                                                                                                                                      - mixed - — - - -
                                                                                                                                      -
                                                                                                                                      -

                                                                                                                                      - getFileData() - -

                                                                                                                                      - - -

                                                                                                                                      Get file data based on given uuid.

                                                                                                                                      - - - public - getFileData(mixed $file[, array<string|int, mixed> $data = [] ][, array<string|int, mixed> $jsonSerializeOptions = [] ]) : array<string|int, mixed> - - -
                                                                                                                                      Parameters
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      - $file - : mixed -
                                                                                                                                      -
                                                                                                                                      -

                                                                                                                                      File uuid

                                                                                                                                      -
                                                                                                                                      - -
                                                                                                                                      -
                                                                                                                                      - $data - : array<string|int, mixed> - = []
                                                                                                                                      -
                                                                                                                                      -

                                                                                                                                      Add file data here

                                                                                                                                      -
                                                                                                                                      - -
                                                                                                                                      -
                                                                                                                                      - $jsonSerializeOptions - : array<string|int, mixed> - = []
                                                                                                                                      -
                                                                                                                                      -

                                                                                                                                      Options for the object to array transformation

                                                                                                                                      -
                                                                                                                                      - -
                                                                                                                                      -
                                                                                                                                      - - -
                                                                                                                                      - Tags - -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      - throws -
                                                                                                                                      -
                                                                                                                                      - ReflectionException - - -
                                                                                                                                      -
                                                                                                                                      - -
                                                                                                                                      Return values
                                                                                                                                      - array<string|int, mixed> - — -

                                                                                                                                      File data

                                                                                                                                      -
                                                                                                                                      - - -
                                                                                                                                      -
                                                                                                                                      -

                                                                                                                                      - getFilePath() - -

                                                                                                                                      - - -

                                                                                                                                      Get file path based on given uuid.

                                                                                                                                      - - - public - getFilePath(mixed $file) : string - - -
                                                                                                                                      Parameters
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      - $file - : mixed -
                                                                                                                                      -
                                                                                                                                      -

                                                                                                                                      File uuid

                                                                                                                                      -
                                                                                                                                      - -
                                                                                                                                      -
                                                                                                                                      - - - -
                                                                                                                                      Return values
                                                                                                                                      - string - — -

                                                                                                                                      File path

                                                                                                                                      -
                                                                                                                                      - - -
                                                                                                                                      -
                                                                                                                                      -

                                                                                                                                      - getFilters() - -

                                                                                                                                      - - -

                                                                                                                                      Get list of twig filters.

                                                                                                                                      - - - public - getFilters() : array<string|int, mixed>|array<string|int, Twig_SimpleFilter> - - - - - -
                                                                                                                                      Return values
                                                                                                                                      - array<string|int, mixed>|array<string|int, Twig_SimpleFilter> - — - - -
                                                                                                                                      -
                                                                                                                                      - - - - -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                      -

                                                                                                                                      Search results

                                                                                                                                      - -
                                                                                                                                      -
                                                                                                                                      -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Twig-ImageExtension.html b/classes/HeimrichHannot-UtilsBundle-Twig-ImageExtension.html deleted file mode 100644 index abed8946..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Twig-ImageExtension.html +++ /dev/null @@ -1,702 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                                                        -

                                                                                                                                        Contao Utils Bundle

                                                                                                                                        - - -
                                                                                                                                        - -
                                                                                                                                        - - -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        - - - - -
                                                                                                                                        - - -
                                                                                                                                        -

                                                                                                                                        - ImageExtension - - - extends AbstractExtension - - -
                                                                                                                                        - in package - -
                                                                                                                                        - - - implements - ContainerAwareInterface - - - Uses - ContainerAwareTrait -

                                                                                                                                        - - - - -
                                                                                                                                        - - - - - - -

                                                                                                                                        - Interfaces, Classes and Traits - -

                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        ContainerAwareInterface
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        - - -

                                                                                                                                        - Table of Contents - -

                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        - getFilters() - -  : array<string|int, mixed>|array<string|int, Twig_SimpleFilter> -
                                                                                                                                        -
                                                                                                                                        Get list of twig filters.
                                                                                                                                        - -
                                                                                                                                        - getImage() - -  : string -
                                                                                                                                        -
                                                                                                                                        Get image based on given path/uuid.
                                                                                                                                        - -
                                                                                                                                        - getImageCaption() - -  : string|null -
                                                                                                                                        -
                                                                                                                                        Get image caption based on given path/uuid.
                                                                                                                                        - -
                                                                                                                                        - getImageData() - -  : array<string|int, mixed> -
                                                                                                                                        -
                                                                                                                                        Get image data based on given path/uuid.
                                                                                                                                        - -
                                                                                                                                        - getImageGallery() - -  : string -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        - getImageSize() - -  : mixed -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        - getImageWidth() - -  : string|null -
                                                                                                                                        -
                                                                                                                                        Get image width based on given path/uuid.
                                                                                                                                        - -
                                                                                                                                        - - - - - - - -
                                                                                                                                        -

                                                                                                                                        - Methods - -

                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        - getFilters() - -

                                                                                                                                        - - -

                                                                                                                                        Get list of twig filters.

                                                                                                                                        - - - public - getFilters() : array<string|int, mixed>|array<string|int, Twig_SimpleFilter> - - - - - -
                                                                                                                                        Return values
                                                                                                                                        - array<string|int, mixed>|array<string|int, Twig_SimpleFilter> - — - - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        - getImage() - -

                                                                                                                                        - - -

                                                                                                                                        Get image based on given path/uuid.

                                                                                                                                        - - - public - getImage(mixed $image[, string|array<string|int, mixed> $size = null ][, array<string|int, mixed> $data = [] ][, string $template = 'image.html.twig' ]) : string - - -
                                                                                                                                        Parameters
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - $image - : mixed -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        File path/uuid

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

                                                                                                                                        Array or serialized string containing [width, height, imageSize-ID]

                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        - $data - : array<string|int, mixed> - = []
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Add image data here [href => 'URL', class => 'img css class']…

                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        - $template - : string - = 'image.html.twig'
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Use custom image template

                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        - Tags - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - throws -
                                                                                                                                        -
                                                                                                                                        - InvalidArgumentException - - -
                                                                                                                                        -
                                                                                                                                        - throws -
                                                                                                                                        -
                                                                                                                                        - Twig_Error_Loader - - -
                                                                                                                                        -
                                                                                                                                        - throws -
                                                                                                                                        -
                                                                                                                                        - Twig_Error_Runtime - - -
                                                                                                                                        -
                                                                                                                                        - throws -
                                                                                                                                        -
                                                                                                                                        - Twig_Error_Syntax - - -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        Return values
                                                                                                                                        - string - — -

                                                                                                                                        Image html element with given size

                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        - getImageCaption() - -

                                                                                                                                        - - -

                                                                                                                                        Get image caption based on given path/uuid.

                                                                                                                                        - - - public - getImageCaption(mixed $image) : string|null - - -
                                                                                                                                        Parameters
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - $image - : mixed -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        File path/uuid

                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        - - - -
                                                                                                                                        Return values
                                                                                                                                        - string|null - — -

                                                                                                                                        Image caption if available, else null

                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        - getImageData() - -

                                                                                                                                        - - -

                                                                                                                                        Get image data based on given path/uuid.

                                                                                                                                        - - - public - getImageData(mixed $image[, string|array<string|int, mixed> $size = null ][, array<string|int, mixed> $data = [] ]) : array<string|int, mixed> - - -
                                                                                                                                        Parameters
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - $image - : mixed -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        File path/uuid

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

                                                                                                                                        Array or serialized string containing [width, height, imageSize-ID]

                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        - $data - : array<string|int, mixed> - = []
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Add image data here [href => 'URL', class => 'img css class']…

                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        - - - -
                                                                                                                                        Return values
                                                                                                                                        - array<string|int, mixed> - — -

                                                                                                                                        Image data

                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        - getImageGallery() - -

                                                                                                                                        - - - - - public - getImageGallery(mixed $images[, string $template = 'image_gallery.html.twig' ]) : string - -
                                                                                                                                        - -
                                                                                                                                        Parameters
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - $images - : mixed -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        - $template - : string - = 'image_gallery.html.twig'
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        - - - -
                                                                                                                                        Return values
                                                                                                                                        - string - — - - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        - getImageSize() - -

                                                                                                                                        - - - - - public - getImageSize(mixed $size) : mixed - -
                                                                                                                                        - -
                                                                                                                                        Parameters
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - $size - : mixed -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        - - - -
                                                                                                                                        Return values
                                                                                                                                        - mixed - — - - -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        - getImageWidth() - -

                                                                                                                                        - - -

                                                                                                                                        Get image width based on given path/uuid.

                                                                                                                                        - - - public - getImageWidth(mixed $image) : string|null - - -
                                                                                                                                        Parameters
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        - $image - : mixed -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        File path/uuid

                                                                                                                                        -
                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        - - - -
                                                                                                                                        Return values
                                                                                                                                        - string|null - — -

                                                                                                                                        Image caption if available, else null

                                                                                                                                        -
                                                                                                                                        - - -
                                                                                                                                        -
                                                                                                                                        - - - - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                        -

                                                                                                                                        Search results

                                                                                                                                        - -
                                                                                                                                        -
                                                                                                                                        -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - - -
                                                                                                                                          - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Twig-StringExtension.html b/classes/HeimrichHannot-UtilsBundle-Twig-StringExtension.html index f7132106..8d10b40a 100644 --- a/classes/HeimrichHannot-UtilsBundle-Twig-StringExtension.html +++ b/classes/HeimrichHannot-UtilsBundle-Twig-StringExtension.html @@ -110,7 +110,7 @@

                                                                                                                                          @@ -130,17 +130,10 @@

                                                                                                                                          -
                                                                                                                                          - $anonymizerUtil - -  : AnonymizerUtil -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          - $framework +
                                                                                                                                          + $utils -  : ContaoFrameworkInterface +  : Utils
                                                                                                                                          @@ -156,13 +149,6 @@

                                                                                                                                           : string -
                                                                                                                                          - -
                                                                                                                                          - autolink() - -  : string -
                                                                                                                                          @@ -172,13 +158,6 @@

                                                                                                                                          Get list of twig filters.
                                                                                                                                          -
                                                                                                                                          - replaceInsertTag() - -  : mixed -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          @@ -195,64 +174,34 @@

                                                                                                                                          class=" phpdocumentor-element -property - -private + -protected " > -

                                                                                                                                          - $anonymizerUtil - +

                                                                                                                                          + $utils +

                                                                                                                                          - private - AnonymizerUtil - $anonymizerUtil + protected + Utils + $utils - - - - -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          - $framework - - - -

                                                                                                                                          - +
                                                                                                                                          - - - private - ContaoFrameworkInterface - $framework - +
                                                                                                                                          - -
                                                                                                                                          @@ -275,30 +224,22 @@

                                                                                                                                          public - __construct(AnonymizerUtil $anonymizerUtil, ContaoFrameworkInterface $framework) : mixed + __construct(Utils $utils) : mixed

                                                                                                                                          Parameters
                                                                                                                                          - $anonymizerUtil - : AnonymizerUtil -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - $framework - : ContaoFrameworkInterface + $utils + : Utils
                                                                                                                                          @@ -327,7 +268,7 @@

                                                                                                                                          @@ -357,58 +298,6 @@

                                                                                                                                          Return values
                                                                                                                                          — -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          - autolink() - -

                                                                                                                                          - - - - - public - autolink(string $text[, array<string|int, mixed> $options = [] ]) : string - -
                                                                                                                                          - -
                                                                                                                                          Parameters
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - $text - : string -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - $options - : array<string|int, mixed> - = []
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - - - -
                                                                                                                                          Return values
                                                                                                                                          - string - — - -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          - replaceInsertTag() - -

                                                                                                                                          - - - - - public - replaceInsertTag(string $text[, bool $cache = true ]) : mixed - -
                                                                                                                                          - -
                                                                                                                                          Parameters
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - $text - : string -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - $cache - : bool - = true
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - - - -
                                                                                                                                          Return values
                                                                                                                                          - mixed - — - -

                                                                                                                                          diff --git a/classes/HeimrichHannot-UtilsBundle-Twig-TestExtension.html b/classes/HeimrichHannot-UtilsBundle-Twig-TestExtension.html deleted file mode 100644 index 28d86609..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Twig-TestExtension.html +++ /dev/null @@ -1,904 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                                                          -

                                                                                                                                          Contao Utils Bundle

                                                                                                                                          - - -
                                                                                                                                          - -
                                                                                                                                          - - -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - - - - -
                                                                                                                                          - - -
                                                                                                                                          -

                                                                                                                                          - TestExtension - - - extends AbstractExtension - - -
                                                                                                                                          - in package - -
                                                                                                                                          - - - implements - ContainerAwareInterface - - - Uses - ContainerAwareTrait -

                                                                                                                                          - - - - -
                                                                                                                                          - - - - - - -

                                                                                                                                          - Interfaces, Classes and Traits - -

                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          ContainerAwareInterface
                                                                                                                                          -
                                                                                                                                          - - -
                                                                                                                                          - - -

                                                                                                                                          - Table of Contents - -

                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - getTests() - -  : array<string|int, mixed>|array<string|int, TwigTest> -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          - isArray() - -  : bool -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          - isBinaryUuid() - -  : bool -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          - isBool() - -  : bool -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          - isEmail() - -  : bool -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          - isFloat() - -  : bool -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          - isInt() - -  : bool -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          - isNumeric() - -  : bool -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          - isObject() - -  : bool -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          - isString() - -  : bool -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          - isStringUuid() - -  : bool -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          - isUrl() - -  : bool -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          - isUuid() - -  : bool -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          - - - - - - - -
                                                                                                                                          -

                                                                                                                                          - Methods - -

                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          - getTests() - -

                                                                                                                                          - - - - - public - getTests() : array<string|int, mixed>|array<string|int, TwigTest> - - - - - -
                                                                                                                                          Return values
                                                                                                                                          - array<string|int, mixed>|array<string|int, TwigTest> - — - - -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          - isArray() - -

                                                                                                                                          - - - - - public - isArray(mixed $value) : bool - -
                                                                                                                                          - -
                                                                                                                                          Parameters
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - $value - : mixed -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - - - -
                                                                                                                                          Return values
                                                                                                                                          - bool - — - - -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          - isBinaryUuid() - -

                                                                                                                                          - - - - - public - isBinaryUuid(mixed $value) : bool - -
                                                                                                                                          - -
                                                                                                                                          Parameters
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - $value - : mixed -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - - - -
                                                                                                                                          Return values
                                                                                                                                          - bool - — - - -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          - isBool() - -

                                                                                                                                          - - - - - public - isBool(mixed $value) : bool - -
                                                                                                                                          - -
                                                                                                                                          Parameters
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - $value - : mixed -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - - - -
                                                                                                                                          Return values
                                                                                                                                          - bool - — - - -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          - isEmail() - -

                                                                                                                                          - - - - - public - isEmail(mixed $value) : bool - -
                                                                                                                                          - -
                                                                                                                                          Parameters
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - $value - : mixed -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - - - -
                                                                                                                                          Return values
                                                                                                                                          - bool - — - - -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          - isFloat() - -

                                                                                                                                          - - - - - public - isFloat(mixed $value) : bool - -
                                                                                                                                          - -
                                                                                                                                          Parameters
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - $value - : mixed -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - - - -
                                                                                                                                          Return values
                                                                                                                                          - bool - — - - -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          - isInt() - -

                                                                                                                                          - - - - - public - isInt(mixed $value) : bool - -
                                                                                                                                          - -
                                                                                                                                          Parameters
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - $value - : mixed -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - - - -
                                                                                                                                          Return values
                                                                                                                                          - bool - — - - -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          - isNumeric() - -

                                                                                                                                          - - - - - public - isNumeric(mixed $value) : bool - -
                                                                                                                                          - -
                                                                                                                                          Parameters
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - $value - : mixed -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - - - -
                                                                                                                                          Return values
                                                                                                                                          - bool - — - - -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          - isObject() - -

                                                                                                                                          - - - - - public - isObject(mixed $value) : bool - -
                                                                                                                                          - -
                                                                                                                                          Parameters
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - $value - : mixed -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - - - -
                                                                                                                                          Return values
                                                                                                                                          - bool - — - - -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          - isString() - -

                                                                                                                                          - - - - - public - isString(mixed $value) : bool - -
                                                                                                                                          - -
                                                                                                                                          Parameters
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - $value - : mixed -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - - - -
                                                                                                                                          Return values
                                                                                                                                          - bool - — - - -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          - isStringUuid() - -

                                                                                                                                          - - - - - public - isStringUuid(mixed $value) : bool - -
                                                                                                                                          - -
                                                                                                                                          Parameters
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - $value - : mixed -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - - - -
                                                                                                                                          Return values
                                                                                                                                          - bool - — - - -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          - isUrl() - -

                                                                                                                                          - - - - - public - isUrl(mixed $value) : bool - -
                                                                                                                                          - -
                                                                                                                                          Parameters
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - $value - : mixed -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - - - -
                                                                                                                                          Return values
                                                                                                                                          - bool - — - - -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          - isUuid() - -

                                                                                                                                          - - - - - public - isUuid(mixed $value) : bool - -
                                                                                                                                          - -
                                                                                                                                          Parameters
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - $value - : mixed -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          - - - -
                                                                                                                                          Return values
                                                                                                                                          - bool - — - - -
                                                                                                                                          -
                                                                                                                                          - - - - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                          -

                                                                                                                                          Search results

                                                                                                                                          - -
                                                                                                                                          -
                                                                                                                                          -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Url-UrlUtil.html b/classes/HeimrichHannot-UtilsBundle-Url-UrlUtil.html deleted file mode 100644 index e2d616f4..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Url-UrlUtil.html +++ /dev/null @@ -1,1354 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                                                            -

                                                                                                                                            Contao Utils Bundle

                                                                                                                                            - - -
                                                                                                                                            - -
                                                                                                                                            - - -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - - - - -
                                                                                                                                            - - -
                                                                                                                                            -

                                                                                                                                            - UrlUtil - - -
                                                                                                                                            - in package - -
                                                                                                                                            - - -

                                                                                                                                            - - - - -
                                                                                                                                            - - - - - - - - -

                                                                                                                                            - Table of Contents - -

                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - TERMINATE_EXIT_LOCATION_SET - -  = 900 -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            - TERMINATE_HEADERS_ALREADY_SENT - -  = 800 -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            - $framework - -  : ContaoFrameworkInterface -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            - $requestStack - -  : RequestStack -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            - $requestUtil - -  : RequestUtil -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            - __construct() - -  : mixed -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            - addAutoItemToPage() - -  : mixed -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            - addQueryString() - -  : string -
                                                                                                                                            -
                                                                                                                                            Add a query string to the given URI string or page ID.
                                                                                                                                            - -
                                                                                                                                            - addURIScheme() - -  : string -
                                                                                                                                            -
                                                                                                                                            Add a url scheme to a given url.
                                                                                                                                            - -
                                                                                                                                            - getBaseUrl() - -  : mixed -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            - getCurrentUrl() - -  : string -
                                                                                                                                            -
                                                                                                                                            Return the current url with requestUri.
                                                                                                                                            - -
                                                                                                                                            - getJumpToPageObject() - -  : PageModel|null -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            - getJumpToPageUrl() - -  : string|null -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            - getRelativePath() - -  : string -
                                                                                                                                            -
                                                                                                                                            Convert an absolute url to an relative url.
                                                                                                                                            - -
                                                                                                                                            - isNewVisitor() - -  : bool -
                                                                                                                                            -
                                                                                                                                            Detect if user already visited our domain before.
                                                                                                                                            - -
                                                                                                                                            - prepareUrl() - -  : string -
                                                                                                                                            -
                                                                                                                                            Prepare URL from ID and keep query string from current string.
                                                                                                                                            - -
                                                                                                                                            - redirect() - -  : int|array<string|int, mixed>|null -
                                                                                                                                            -
                                                                                                                                            Redirect to another page.
                                                                                                                                            - -
                                                                                                                                            - removeQueryString() - -  : string -
                                                                                                                                            -
                                                                                                                                            Remove query parameters from the current URL.
                                                                                                                                            - -
                                                                                                                                            - - - - -
                                                                                                                                            -

                                                                                                                                            - Constants - -

                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            - TERMINATE_EXIT_LOCATION_SET - -

                                                                                                                                            - - - - - - public - mixed - TERMINATE_EXIT_LOCATION_SET - = 900 - - - -
                                                                                                                                            - -
                                                                                                                                            - - - -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            - TERMINATE_HEADERS_ALREADY_SENT - -

                                                                                                                                            - - - - - - public - mixed - TERMINATE_HEADERS_ALREADY_SENT - = 800 - - - -
                                                                                                                                            - -
                                                                                                                                            - - - -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            -

                                                                                                                                            - Properties - -

                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            - $framework - - - -

                                                                                                                                            - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            - $requestStack - - - -

                                                                                                                                            - - - - - private - RequestStack - $requestStack - - - - - - -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            - $requestUtil - - - -

                                                                                                                                            - - - - - private - RequestUtil - $requestUtil - - - - - - -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -

                                                                                                                                            - Methods - -

                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            - __construct() - -

                                                                                                                                            - - - - - public - __construct(ContaoFrameworkInterface $framework, RequestUtil $requestUtil, RequestStack $requestStack) : mixed - -
                                                                                                                                            - -
                                                                                                                                            Parameters
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - $framework - : ContaoFrameworkInterface -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - $requestUtil - : RequestUtil -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - $requestStack - : RequestStack -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - - - -
                                                                                                                                            Return values
                                                                                                                                            - mixed - — - - -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            - addAutoItemToPage() - -

                                                                                                                                            - - - - - public - static addAutoItemToPage(Model $page, Model $entity[, mixed $autoItemType = 'items' ]) : mixed - -
                                                                                                                                            - -
                                                                                                                                            Parameters
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - $page - : Model -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - $entity - : Model -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - $autoItemType - : mixed - = 'items'
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - - - -
                                                                                                                                            Return values
                                                                                                                                            - mixed - — - - -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            - addQueryString() - -

                                                                                                                                            - - -

                                                                                                                                            Add a query string to the given URI string or page ID.

                                                                                                                                            - - - public - addQueryString(string $query[, mixed $url = null ]) : string - - -
                                                                                                                                            Parameters
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - $query - : string -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - $url - : mixed - = null
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            - Tags - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - throws -
                                                                                                                                            -
                                                                                                                                            - InvalidArgumentException - - -
                                                                                                                                            -
                                                                                                                                            - deprecated -
                                                                                                                                            -
                                                                                                                                            - -

                                                                                                                                            Use Utils service instead

                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - codeCoverageIgnore -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            Return values
                                                                                                                                            - string - — - - -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            - addURIScheme() - -

                                                                                                                                            - - -

                                                                                                                                            Add a url scheme to a given url.

                                                                                                                                            - - - public - addURIScheme([string $url = '' ][, string $protocol = 'http' ]) : string - - -
                                                                                                                                            Parameters
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - $url - : string - = ''
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - $protocol - : string - = 'http'
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - - - -
                                                                                                                                            Return values
                                                                                                                                            - string - — - - -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            - getBaseUrl() - -

                                                                                                                                            - - - - - public - getBaseUrl([bool $absolute = false ]) : mixed - - -
                                                                                                                                            Parameters
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - $absolute - : bool - = false
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            - Tags - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - deprecated -
                                                                                                                                            -
                                                                                                                                            - -

                                                                                                                                            Use Utils::request() instead

                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            Return values
                                                                                                                                            - mixed - — - - -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            - getCurrentUrl() - -

                                                                                                                                            - - -

                                                                                                                                            Return the current url with requestUri.

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

                                                                                                                                            Options:

                                                                                                                                            -
                                                                                                                                              -
                                                                                                                                            • skipParams: boolean
                                                                                                                                              • -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            Parameters
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - $options - : array<string|int, mixed> - = []
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - - - -
                                                                                                                                            Return values
                                                                                                                                            - string - — - - -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            - getJumpToPageObject() - -

                                                                                                                                            - - - - - public - getJumpToPageObject(int $jumpTo[, bool $fallbackToObjPage = true ]) : PageModel|null - - -
                                                                                                                                            Parameters
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - $jumpTo - : int -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - $fallbackToObjPage - : bool - = true
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - - - -
                                                                                                                                            Return values
                                                                                                                                            - PageModel|null - — - - -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            - getJumpToPageUrl() - -

                                                                                                                                            - - - - - public - getJumpToPageUrl(int $jumpTo[, bool $fallbackToObjPage = true ]) : string|null - -
                                                                                                                                            - -
                                                                                                                                            Parameters
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - $jumpTo - : int -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - $fallbackToObjPage - : bool - = true
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - - - -
                                                                                                                                            Return values
                                                                                                                                            - string|null - — - - -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            - getRelativePath() - -

                                                                                                                                            - - -

                                                                                                                                            Convert an absolute url to an relative url.

                                                                                                                                            - - - public - getRelativePath(string $url[, array<string|int, mixed> $options = [] ]) : string - -

                                                                                                                                            Options:

                                                                                                                                            -
                                                                                                                                              -
                                                                                                                                            • removeLeadingSlash: (boolean) Remove a
                                                                                                                                              • -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            Parameters
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - $url - : string -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            The url that should be made relative

                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - $options - : array<string|int, mixed> - = []
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            Pass additional options

                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            - Tags - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - throws -
                                                                                                                                            -
                                                                                                                                            - InvalidUrlException - - -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            Return values
                                                                                                                                            - string - — - - -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            - isNewVisitor() - -

                                                                                                                                            - - -

                                                                                                                                            Detect if user already visited our domain before.

                                                                                                                                            - - - public - isNewVisitor() : bool - - - - -
                                                                                                                                            - Tags - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - deprecated -
                                                                                                                                            -
                                                                                                                                            - -

                                                                                                                                            please use RequestUtil::isNewVisitor() instead

                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - codeCoverageIgnore -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            Return values
                                                                                                                                            - bool - — - - -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            - prepareUrl() - -

                                                                                                                                            - - -

                                                                                                                                            Prepare URL from ID and keep query string from current string.

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

                                                                                                                                            Options:

                                                                                                                                            -
                                                                                                                                              -
                                                                                                                                            • absoluteUrl: (boolean) Return absolute url instead of relative url. Only applicable if id or null is given as url. Default: false
                                                                                                                                              • -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            Parameters
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - $url - : mixed - = null
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - $options - : array<string|int, mixed> - = []
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            pass additional options

                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            - Tags - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - deprecated -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            -
                                                                                                                                            - codeCoverageIgnore -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            Return values
                                                                                                                                            - string - — - - -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            - redirect() - -

                                                                                                                                            - - -

                                                                                                                                            Redirect to another page.

                                                                                                                                            - - - public - redirect(string $strLocation[, int $intStatus = 303 ][, bool $test = false ][, bool $skipSent = false ]) : int|array<string|int, mixed>|null - - -
                                                                                                                                            Parameters
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - $strLocation - : string -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            The target URL

                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - $intStatus - : int - = 303
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            The HTTP status code (defaults to 303)

                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - $test - : bool - = false
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            For test purposes set to true to test exit/headers

                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - $skipSent - : bool - = false
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            Skip if headers already sent for test purposes

                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - - - -
                                                                                                                                            Return values
                                                                                                                                            - int|array<string|int, mixed>|null - — - - -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            - removeQueryString() - -

                                                                                                                                            - - -

                                                                                                                                            Remove query parameters from the current URL.

                                                                                                                                            - - - public - removeQueryString(array<string|int, mixed> $params[, string|int|null $url = null ][, array<string|int, mixed> $options = [] ]) : string - -

                                                                                                                                            Options:

                                                                                                                                            -
                                                                                                                                              -
                                                                                                                                            • absoluteUrl: (boolean) Return absolute url instead of relative url. Only applicable if id or null is given as url. Default: false
                                                                                                                                              • -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            Parameters
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - $params - : array<string|int, mixed> -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            List of parameters to remove from url

                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - $url - : string|int|null - = null
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            Full Uri, Page id or null (for current environment uri)

                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - $options - : array<string|int, mixed> - = []
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            - Tags - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            - deprecated -
                                                                                                                                            -
                                                                                                                                            - -

                                                                                                                                            Use utils service instead

                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            - codeCoverageIgnore -
                                                                                                                                            -
                                                                                                                                            - - -
                                                                                                                                            -
                                                                                                                                            - -
                                                                                                                                            Return values
                                                                                                                                            - string - — - - -
                                                                                                                                            -
                                                                                                                                            - - - - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                            -

                                                                                                                                            Search results

                                                                                                                                            - -
                                                                                                                                            -
                                                                                                                                            -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - - -
                                                                                                                                              - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-User-UserUtil.html b/classes/HeimrichHannot-UtilsBundle-User-UserUtil.html deleted file mode 100644 index 0b1f6603..00000000 --- a/classes/HeimrichHannot-UtilsBundle-User-UserUtil.html +++ /dev/null @@ -1,593 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                                                              -

                                                                                                                                              Contao Utils Bundle

                                                                                                                                              - - -
                                                                                                                                              - -
                                                                                                                                              - - -
                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              - - - - -
                                                                                                                                              - - -
                                                                                                                                              -

                                                                                                                                              - UserUtil - - -
                                                                                                                                              - in package - -
                                                                                                                                              - - - - Uses - PersonTrait -

                                                                                                                                              - - - -

                                                                                                                                              Class UserUtil.

                                                                                                                                              - - - - - - - - - -

                                                                                                                                              - Table of Contents - -

                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              - TABLE - -  = 'tl_user' -
                                                                                                                                              -
                                                                                                                                              - -
                                                                                                                                              - $framework - -  : ContaoFrameworkInterface -
                                                                                                                                              -
                                                                                                                                              - -
                                                                                                                                              - $modelUtil - -  : ModelUtil -
                                                                                                                                              -
                                                                                                                                              - -
                                                                                                                                              - __construct() - -  : mixed -
                                                                                                                                              -
                                                                                                                                              - -
                                                                                                                                              - findActiveByGroups() - -  : UserModel|array<string|int, UserModel>|Collection|null -
                                                                                                                                              -
                                                                                                                                              - -
                                                                                                                                              - hasAccessToField() - -  : mixed -
                                                                                                                                              -
                                                                                                                                              - -
                                                                                                                                              - isAdmin() - -  : bool -
                                                                                                                                              -
                                                                                                                                              - -
                                                                                                                                              - - - - -
                                                                                                                                              -

                                                                                                                                              - Constants - -

                                                                                                                                              -
                                                                                                                                              -

                                                                                                                                              - TABLE - -

                                                                                                                                              - - - - - - public - mixed - TABLE - = 'tl_user' - - - -
                                                                                                                                              - -
                                                                                                                                              - - - -
                                                                                                                                              -
                                                                                                                                              - - -
                                                                                                                                              -

                                                                                                                                              - Properties - -

                                                                                                                                              -
                                                                                                                                              -

                                                                                                                                              - $framework - - - -

                                                                                                                                              - - - - - protected - ContaoFrameworkInterface - $framework - - - - - - -
                                                                                                                                              -
                                                                                                                                              -

                                                                                                                                              - $modelUtil - - - -

                                                                                                                                              - - - - - protected - ModelUtil - $modelUtil - - - - - - -
                                                                                                                                              -
                                                                                                                                              - -
                                                                                                                                              -

                                                                                                                                              - Methods - -

                                                                                                                                              -
                                                                                                                                              -

                                                                                                                                              - __construct() - -

                                                                                                                                              - - - - - public - __construct(ContaoFrameworkInterface $framework, ModelUtil $modelUtil) : mixed - -
                                                                                                                                              - -
                                                                                                                                              Parameters
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - $framework - : ContaoFrameworkInterface -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              - $modelUtil - : ModelUtil -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              - - - -
                                                                                                                                              Return values
                                                                                                                                              - mixed - — - - -
                                                                                                                                              -
                                                                                                                                              -

                                                                                                                                              - findActiveByGroups() - -

                                                                                                                                              - - - - - public - findActiveByGroups(array<string|int, mixed> $groups[, array<string|int, mixed> $options = [] ]) : UserModel|array<string|int, UserModel>|Collection|null - - -
                                                                                                                                              Parameters
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - $groups - : array<string|int, mixed> -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              - $options - : array<string|int, mixed> - = []
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              - - -
                                                                                                                                              - Tags - -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - deprecated -
                                                                                                                                              -
                                                                                                                                              - -

                                                                                                                                              use Utils service instead

                                                                                                                                              -
                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              - -
                                                                                                                                              Return values
                                                                                                                                              - UserModel|array<string|int, UserModel>|Collection|null - — - - -
                                                                                                                                              -
                                                                                                                                              -

                                                                                                                                              - hasAccessToField() - -

                                                                                                                                              - - - - - public - hasAccessToField(mixed $table, mixed $field) : mixed - -
                                                                                                                                              - -
                                                                                                                                              Parameters
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - $table - : mixed -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              - $field - : mixed -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              - - - -
                                                                                                                                              Return values
                                                                                                                                              - mixed - — - - -
                                                                                                                                              -
                                                                                                                                              -

                                                                                                                                              - isAdmin() - -

                                                                                                                                              - - - - - public - isAdmin() : bool - -
                                                                                                                                              - - - - -
                                                                                                                                              Return values
                                                                                                                                              - bool - — - - -
                                                                                                                                              -
                                                                                                                                              - - - - -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                              -

                                                                                                                                              Search results

                                                                                                                                              - -
                                                                                                                                              -
                                                                                                                                              -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                - - -
                                                                                                                                                - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Util-AbstractServiceSubscriber.html b/classes/HeimrichHannot-UtilsBundle-Util-AbstractServiceSubscriber.html deleted file mode 100644 index 03a0df82..00000000 --- a/classes/HeimrichHannot-UtilsBundle-Util-AbstractServiceSubscriber.html +++ /dev/null @@ -1,234 +0,0 @@ - - - - - Contao Utils Bundle - - - - - - - - - - - - - - - - - - - -
                                                                                                                                                -

                                                                                                                                                Contao Utils Bundle

                                                                                                                                                - - -
                                                                                                                                                - -
                                                                                                                                                - - -
                                                                                                                                                - -
                                                                                                                                                -
                                                                                                                                                - - - - -
                                                                                                                                                - - -
                                                                                                                                                -

                                                                                                                                                - AbstractServiceSubscriber - - -
                                                                                                                                                - in package - -
                                                                                                                                                - - - implements - ServiceSubscriberInterface - -

                                                                                                                                                - - - - -
                                                                                                                                                - - - - - - -

                                                                                                                                                - Interfaces, Classes and Traits - -

                                                                                                                                                - -
                                                                                                                                                -
                                                                                                                                                ServiceSubscriberInterface
                                                                                                                                                -
                                                                                                                                                - - -
                                                                                                                                                - - - - - - - - - - - - - -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                -

                                                                                                                                                Search results

                                                                                                                                                - -
                                                                                                                                                -
                                                                                                                                                -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  -
                                                                                                                                                  - - -
                                                                                                                                                  - - - - - - - - diff --git a/classes/HeimrichHannot-UtilsBundle-Util-Ui-AccordionUtil.html b/classes/HeimrichHannot-UtilsBundle-Util-AccordionUtil.html similarity index 85% rename from classes/HeimrichHannot-UtilsBundle-Util-Ui-AccordionUtil.html rename to classes/HeimrichHannot-UtilsBundle-Util-AccordionUtil.html index 95d5e3a3..39e9f2cb 100644 --- a/classes/HeimrichHannot-UtilsBundle-Util-Ui-AccordionUtil.html +++ b/classes/HeimrichHannot-UtilsBundle-Util-AccordionUtil.html @@ -87,7 +87,6 @@

                                                                                                                                                  Fil
                                                                                                                                                • HeimrichHannot
                                                                                                                                                • UtilsBundle
                                                                                                                                                • Util
                                                                                                                                                  • -
                                                                                                                                                • Ui
                                                                                                                                                  • @@ -106,7 +105,7 @@

                                                                                                                                                  @@ -265,12 +268,12 @@

                                                                                                                                                  >

                                                                                                                                                  $contaoFramework - +