1. class
  2. Plugins
  3. \
  4. EmpireDeclarationsPlugin
  5. \
  6. Business
  7. \
  8. Database
  9. \
  10. DeclarationRepository

DeclarationRepository

class DeclarationRepository extends TranslatableRepository implements AbstractBlockElementRepositoryInterface

Class DeclarationRepository is injected as empire_declaration_plugin.declaration_repository service. DeclarationRepository is used for crud operation for entity.

Use this class to work with database.

Traits

JQGridTrait
Trait JQGridTrait

Constants

TRANSLATION_WALKER_HINT

ALIAS

Alias for entity
CATEGORY_ALIAS

Alias for declaration category entity
DECLARATION_BLOCKS_RESULT_CACHE

Define key for caching declarations for block elements

Properties

protected string $defaultLocale from TranslatableRepository

Methods

setDefaultLocale(string $locale)

Sets default locale

from TranslatableRepository
QueryBuilder
getOneOrNullResult(QueryBuilder $qb, string $locale = null, string $hydrationMode = null)

Returns translated one (or null if not found) result for given locale

from TranslatableRepository
mixed
getResult(QueryBuilder $qb, string $locale = null, int $hydrationMode = AbstractQuery::HYDRATE_OBJECT)

Returns translated results for given locale

from TranslatableRepository
array
getArrayResult(QueryBuilder $qb, string $locale = null)

Returns translated array results for given locale

from TranslatableRepository
QueryBuilder
getSingleResult(QueryBuilder $qb, string $locale = null, string $hydrationMode = null)

Returns translated single result for given locale

from TranslatableRepository
array
getScalarResult(QueryBuilder $qb, string $locale = null)

Returns translated scalar result for given locale

from TranslatableRepository
QueryBuilder
getSingleScalarResult(QueryBuilder $qb, string $locale = null)

Returns translated single scalar result for given locale

from TranslatableRepository
PrimaryKeyInterface
save(PrimaryKeyInterface $entity)

No description

from TranslatableRepository
remove(mixed $entity)

Remove entity

from TranslatableRepository
bool
removeArray(array $arrayOfEntities)

Remove entities provided as array

from TranslatableRepository
PrimaryKeyInterface
edit(PrimaryKeyInterface $entity)

Sets default locale to entity and merge

from TranslatableRepository
mixed
getAll()

Find all entities depending on locale

from TranslatableRepository
mixed
getByPrimaryKey(PrimaryKeyInterface $entity)

Find entity by primary key

from TranslatableRepository
QueryBuilder
getById(int $id)

Find entity by id

from TranslatableRepository
QueryBuilder|array
getGroupFromDB(array $array)

Find group od entities

from TranslatableRepository
EntityManager
getManager()

Singleton

from TranslatableRepository
mixed
saveCollection(array $array)

Persist collection

from TranslatableRepository
array
getLanguagesForIds(array $ids)

Find all distinct locale from declarations that match provided ids

Query
getTranslatedQuery(QueryBuilder $qb, string $locale = null)

Returns translated Doctrine query instance

from TranslatableRepository
startTransaction()

Begins transaction over database

from TranslatableRepository
commitTransaction()

Commit transaction over database

from TranslatableRepository
rollbackTransaction()

Rollback transaction over database

from TranslatableRepository
string
getAlias()

No description

jQGridJoinFields(QueryBuilder $qb, JQGridWrapper $jqGridWrapper)

All joins used in select.

from JQGridTrait
jQGridGroupByFields(QueryBuilder $qb, JQGridWrapper $jqGridWrapper)

Should contain group by which jqgrid uses.

from JQGridTrait
array
findAllForJQGRID(int $page, int $offset, array $sortParams, array $additionalParams, JQGridWrapper $jqGridWrapper)

JQGrid function

from JQGridTrait
array
searchForJQGRID(array $searchParams, array $sortParams, bool $isCountSearch = false, array $additionalParams = array(), JQGridWrapper $jqGridWrapper = null)

JQGrid function

from JQGridTrait
array
findOneByIdCustom(int $id)

Find declaration(as array) by id

stdClass
saveItem(Declaration $item)

Persist new Declaration

stdClass
editItem(Declaration $declaration)

Updating existed Declaration

array
getAllItems(array $itemsId)

Find all declarations(as object) that match provided ids. If empty array return all declarations

array
deleteItems(array $entities)

Remove all declarations that match provided ids

array
getEntitiesForBlockElementsExtension(array $ids)

Get entities from database by ids Tis method is used to for block elements extension Make sure you order data by ids - ids is array of elements and it is sorted by priority - so add this to select -> ' FIELD('.$this->getAlias().'.id'.', '.implode(', ', $ids).') AS sort_col'); - and order by this field Also make sure you cache this data -> qb->useQueryCache(true)->useResultCache(true, 3600)

array
getEntityNamesForIds(array $ids)

Get id and name (field must be name so change it in select) of entity Used in event for block element edit Make sure you order data by ids - ids is array of elements and it is sorted by priority - so add this to select -> ' FIELD('.$this->getAlias().'.id'.', '.implode(', ', $ids).') AS sort_col'); - and order by this field

deleteResultCaches()

Delete all cached results

array
searchDeclarationsByName(string $searchTerm, array $params)

Find declaration(as array) with provided name

Details

in TranslatableRepository at line 41
setDefaultLocale(string $locale)

Sets default locale

Parameters

string $locale

in TranslatableRepository at line 57
QueryBuilder getOneOrNullResult(QueryBuilder $qb, string $locale = null, string $hydrationMode = null)

Returns translated one (or null if not found) result for given locale

Parameters

QueryBuilder $qb A Doctrine query builder instance
string $locale A locale name
string $hydrationMode A Doctrine results hydration mode

Return Value

QueryBuilder

Exceptions

NonUniqueResultException

in TranslatableRepository at line 72
mixed getResult(QueryBuilder $qb, string $locale = null, int $hydrationMode = AbstractQuery::HYDRATE_OBJECT)

Returns translated results for given locale

Parameters

QueryBuilder $qb A Doctrine query builder instance
string $locale A locale name
int $hydrationMode A Doctrine results hydration mode

Return Value

mixed

in TranslatableRepository at line 85
array getArrayResult(QueryBuilder $qb, string $locale = null)

Returns translated array results for given locale

Parameters

QueryBuilder $qb A Doctrine query builder instance
string $locale A locale name

Return Value

array

in TranslatableRepository at line 102
QueryBuilder getSingleResult(QueryBuilder $qb, string $locale = null, string $hydrationMode = null)

Returns translated single result for given locale

Parameters

QueryBuilder $qb A Doctrine query builder instance
string $locale A locale name
string $hydrationMode A Doctrine results hydration mode

Return Value

QueryBuilder

Exceptions

NoResultException
NonUniqueResultException

in TranslatableRepository at line 115
array getScalarResult(QueryBuilder $qb, string $locale = null)

Returns translated scalar result for given locale

Parameters

QueryBuilder $qb A Doctrine query builder instance
string $locale A locale name

Return Value

array

in TranslatableRepository at line 130
QueryBuilder getSingleScalarResult(QueryBuilder $qb, string $locale = null)

Returns translated single scalar result for given locale

Parameters

QueryBuilder $qb A Doctrine query builder instance
string $locale A locale name

Return Value

QueryBuilder

Exceptions

NonUniqueResultException

in TranslatableRepository at line 142
PrimaryKeyInterface save(PrimaryKeyInterface $entity)

Parameters

PrimaryKeyInterface $entity

Return Value

PrimaryKeyInterface

Exceptions

Exception

in TranslatableRepository at line 172
remove(mixed $entity)

Remove entity

Parameters

mixed $entity

Exceptions

Exception

in TranslatableRepository at line 200
bool removeArray(array $arrayOfEntities)

Remove entities provided as array

Parameters

array $arrayOfEntities

Return Value

bool

Exceptions

Exception

in TranslatableRepository at line 228
PrimaryKeyInterface edit(PrimaryKeyInterface $entity)

Sets default locale to entity and merge

Parameters

PrimaryKeyInterface $entity

Return Value

PrimaryKeyInterface

Exceptions

Exception

in TranslatableRepository at line 253
mixed getAll()

Find all entities depending on locale

Return Value

mixed

in TranslatableRepository at line 270
mixed getByPrimaryKey(PrimaryKeyInterface $entity)

Find entity by primary key

Parameters

PrimaryKeyInterface $entity

Return Value

mixed

Exceptions

NoResultException
NonUniqueResultException

in TranslatableRepository at line 291
QueryBuilder getById(int $id)

Find entity by id

Parameters

int $id

Return Value

QueryBuilder

Exceptions

NoResultException
NonUniqueResultException

in TranslatableRepository at line 307
QueryBuilder|array getGroupFromDB(array $array)

Find group od entities

Parameters

array $array Objects

Return Value

QueryBuilder|array

in TranslatableRepository at line 332
EntityManager getManager()

Singleton

Return Value

EntityManager

in TranslatableRepository at line 352
mixed saveCollection(array $array)

Persist collection

Parameters

array $array

Return Value

mixed

Exceptions

Exception

at line 192
array getLanguagesForIds(array $ids)

Find all distinct locale from declarations that match provided ids

Parameters

array $ids

Return Value

array

in TranslatableRepository at line 396
protected Query getTranslatedQuery(QueryBuilder $qb, string $locale = null)

Returns translated Doctrine query instance

Parameters

QueryBuilder $qb A Doctrine query builder instance
string $locale A locale name

Return Value

Query

in TranslatableRepository at line 404
protected startTransaction()

Begins transaction over database

in TranslatableRepository at line 412
protected commitTransaction()

Commit transaction over database

in TranslatableRepository at line 420
protected rollbackTransaction()

Rollback transaction over database

at line 285
string getAlias()

Return Value

string

in JQGridTrait at line 27
jQGridJoinFields(QueryBuilder $qb, JQGridWrapper $jqGridWrapper)

All joins used in select.

Override in the repository class if needed. Should do nothing otherwise

Parameters

QueryBuilder $qb
JQGridWrapper $jqGridWrapper

in JQGridTrait at line 42
jQGridGroupByFields(QueryBuilder $qb, JQGridWrapper $jqGridWrapper)

Should contain group by which jqgrid uses.

Override in the repository class if needed. Should do nothing otherwise

Parameters

QueryBuilder $qb
JQGridWrapper $jqGridWrapper

in JQGridTrait at line 61
array findAllForJQGRID(int $page, int $offset, array $sortParams, array $additionalParams, JQGridWrapper $jqGridWrapper)

JQGrid function

Parameters

int $page
int $offset
array $sortParams
array $additionalParams
JQGridWrapper $jqGridWrapper

Return Value

array

in JQGridTrait at line 94
array searchForJQGRID(array $searchParams, array $sortParams, bool $isCountSearch = false, array $additionalParams = array(), JQGridWrapper $jqGridWrapper = null)

JQGrid function

Parameters

array $searchParams
array $sortParams
bool $isCountSearch
array $additionalParams
JQGridWrapper $jqGridWrapper

Return Value

array

at line 55
array findOneByIdCustom(int $id)

Find declaration(as array) by id

Parameters

int $id

Return Value

array

at line 86
stdClass saveItem(Declaration $item)

Persist new Declaration

Parameters

Declaration $item

Return Value

stdClass Containing persisted entity, response code, status and message

at line 116
stdClass editItem(Declaration $declaration)

Updating existed Declaration

Parameters

Declaration $declaration

Return Value

stdClass Containing persisted entity, response code, status and message

at line 148
array getAllItems(array $itemsId)

Find all declarations(as object) that match provided ids. If empty array return all declarations

Parameters

array $itemsId

Return Value

array

at line 170
array deleteItems(array $entities)

Remove all declarations that match provided ids

Parameters

array $entities

Return Value

array

Exceptions

ORMException
OptimisticLockException

at line 212
array getEntitiesForBlockElementsExtension(array $ids)

Get entities from database by ids Tis method is used to for block elements extension Make sure you order data by ids - ids is array of elements and it is sorted by priority - so add this to select -> ' FIELD('.$this->getAlias().'.id'.', '.implode(', ', $ids).') AS sort_col'); - and order by this field Also make sure you cache this data -> qb->useQueryCache(true)->useResultCache(true, 3600)

Parameters

array $ids

Return Value

array

at line 240
array getEntityNamesForIds(array $ids)

Get id and name (field must be name so change it in select) of entity Used in event for block element edit Make sure you order data by ids - ids is array of elements and it is sorted by priority - so add this to select -> ' FIELD('.$this->getAlias().'.id'.', '.implode(', ', $ids).') AS sort_col'); - and order by this field

Parameters

array $ids

Return Value

array

at line 258
deleteResultCaches()

Delete all cached results

at line 271
array searchDeclarationsByName(string $searchTerm, array $params)

Find declaration(as array) with provided name

Parameters

string $searchTerm
array $params Array that contains offset and page

Return Value

array