FieldCollectionCommomMethods

trait AeonDigital\DataModel\Traits\FieldCollectionCommomMethods

Métodos e propriedades comuns para uso de classes que implementam iFieldCollection.

Properties

Methods

public AeonDigital\DataModel\Traits\FieldCollectionCommomMethods::collectionGetState()

Retorna o código de estado de uma coleção de dados.

Returns:‹ string ›

public AeonDigital\DataModel\Traits\FieldCollectionCommomMethods::collectionGetLastValidateState()

Retornará valid caso a última validação de uma coleção tenha ocorrido sem falhas.

Caso a validação tenha falhado, retornará o código que identifica a natureza do erro.

Returns:‹ string ›

public AeonDigital\DataModel\Traits\FieldCollectionCommomMethods::collectionIsDistinct()

Indica se esta coleção exige que cada um de seus valores seja único.

Returns:‹ bool ›

public AeonDigital\DataModel\Traits\FieldCollectionCommomMethods::collectionGetDistinctKeys()

Retorna a coleção de nomes de campos (chaves) que permitem avaliar quando uma coleção

de modelos de dados possui objetos iguais.

Usado apenas para casos de coleções de modelos de dados iModel.

Se nenhuma coleção for definida para distinctKeys então deverá usar TODOS os

campos do modelo de dados para efetuar a comparação.

Returns:‹ ?array ›

public AeonDigital\DataModel\Traits\FieldCollectionCommomMethods::collectionAddValue($v)

Adiciona um novo valor para esta coleção.

Para a aceitação do valor serão seguidas as mesmas regras especificadas para campos

simples e reference.

Parameters:

• ‹ mixed › $v
  Valor a ser adicionado na coleção.

Returns:

‹ bool ›
Retornará true se o valor tornou o campo válido ou false caso agora ele esteja inválido. Também retornará false caso o valor seja totalmente incompatível com o campo.

public AeonDigital\DataModel\Traits\FieldCollectionCommomMethods::collectionGetIndexOfValue($v)

Procura pelo valor indicado na coleção atualmente armazenada e retorna o índice do mesmo.

Valores que não estão aptos a serem armazenados neste campo irão sempre retornar null.

Havendo mais de 1 valor igual na coleção, retornará o índice da primeira ocorrência

encontrada.

Parameters:

• ‹ mixed › $v
  Valor que será verificado.

Returns:

‹ ?int ›

public AeonDigital\DataModel\Traits\FieldCollectionCommomMethods::collectionCountOccurrenciesOfValue($v)

Retorna a contagem de ocorrências do valor passado na coleção atualmente armazenada.

Parameters:

• ‹ mixed › $v
  Valor que será verificado.

Returns:

‹ int ›

public AeonDigital\DataModel\Traits\FieldCollectionCommomMethods::collectionHasValue($v)

Verifica se o valor informado existe na coleção de valores atuais deste campo.

Parameters:

• ‹ mixed › $v
  Valor que será verificado.

Returns:

‹ bool ›

public AeonDigital\DataModel\Traits\FieldCollectionCommomMethods::collectionCount()

Retorna a quantidade de valores que estão atualmente definidos na coleção do campo.

Returns:‹ int ›

public AeonDigital\DataModel\Traits\FieldCollectionCommomMethods::collectionUnsetValue($v, $all=false)

Removerá da coleção de valores a primeira ocorrência do valor informado.

Parameters:

• ‹ mixed › $v
  Valor que será removido.
• ‹ bool › $all
  Quando true irá remover TODAS as ocorrências do valor indicado.

Returns:

‹ void ›

public AeonDigital\DataModel\Traits\FieldCollectionCommomMethods::collectionUnsetIndex($i)

Removerá da coleção de valores o item na posição indicada.

Parameters:

• ‹ int › $i
  Índice que será removido.

Returns:

‹ void ›

public AeonDigital\DataModel\Traits\FieldCollectionCommomMethods::collectionGetAcceptedCount()

Resgata as regras de aceitação para a contagem de itens em uma coleção de dados.

O retorno deve ser um array associativo seguindo as seguintes orientações:

``` php

$arr = [

// int Coleção de valores exatos que podem ser encontrados na contagem dos itens em uma coleção.

"exactValues" => 0,

// int[] Coleção que indica os múltiplos que a coleção pode possuir.

"multiples" => [],

// int Número mínimo de itens que a coleção deve ter.

"min" => 0,

// int Número máximo de itens que a coleção deve ter.

"max" => 0

];

```

Returns:‹ ?array ›

public AeonDigital\DataModel\Traits\FieldCollectionCommomMethods::collectionGetMin()

Retornará o número mínimo de itens que esta coleção pode possuir para ser considerada

válida.

Returns:‹ ?int ›

public AeonDigital\DataModel\Traits\FieldCollectionCommomMethods::collectionGetMax()

Retornará o número máximo de itens que esta coleção pode possuir para ser considerada

válida.

Returns:‹ ?int ›