ILIAS
release_6 Revision v6.24-5-g0c8bfefb3b8
|
Class ActiveRecord. More...
Public Member Functions | |
getArConnector () | |
getArFieldList () | |
getConnectorContainerName () | |
setConnectorContainerName ($connector_container_name) | |
getPrimaryFieldValue () | |
setPrimaryFieldValue ($value) | |
__construct ($primary_key=0, arConnector $connector=null) | |
storeObjectToCache () | |
__getConvertedDateFieldsAsArray ($format=null) | |
__asCsv ($separator=';', $header=false) | |
__asArray () | |
__asStdClass () | |
__asSerializedObject () | |
buildFromArray (array $array) | |
fixDateField ($field_name, $value) | |
sleep ($field_name) | |
wakeUp ($field_name, $field_value) | |
getArrayForDb () | |
getArrayForConnector () | |
installConnector () | |
store () | |
save () | |
create () | |
copy ($new_id=0) | |
afterObjectLoad () | |
read () | |
update () | |
delete () | |
__call ($name, $arguments) | |
Static Public Member Functions | |
static | returnDbTableName () |
static | installDB () |
static | renameDBField ($old_name, $new_name) |
static | tableExists () |
static | fieldExists ($field_name) |
static | removeDBField ($field_name) |
static | updateDB () |
static | resetDB () |
static | truncateDB () |
static | flushDB () |
static | preloadObjects () |
static | additionalParams (array $additional_params) |
static | findOrFail ($primary_key, array $add_constructor_args=array()) |
Tries to find the object and throws an Exception if object is not found, instead of returning null. More... | |
static | findOrGetInstance ($primary_key, array $add_constructor_args=array()) |
static | where ($where, $operator=null) |
static | innerjoinAR (ActiveRecord $ar, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false) |
static | innerjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false) |
static | leftjoin ($tablename, $on_this, $on_external, $fields=array(' *'), $operator='=', $both_external=false) |
static | orderBy ($orderBy, $orderDirection='ASC') |
static | dateFormat ($date_format='d.m.Y - H:i:s') |
static | limit ($start, $end) |
static | affectedRows () |
static | count () |
static | get () |
static | debug () |
static | first () |
static | getCollection () |
static | last () |
static | getFirstFromLastQuery () |
static | connector (arConnector $connector) |
static | raw ($set_raw=true) |
static | getArray ($key=null, $values=null) |
static | _toCamelCase ($str, $capitalise_first_char=false) |
Data Fields | |
const | ACTIVE_RECORD_VERSION = '2.0.7' |
Protected Member Functions | |
serializeToCSV ($field) | |
This method is called for every field of your instance if you use __asCsv. More... | |
installDatabase () | |
Static Protected Member Functions | |
static | getCalledClass () |
static | fromCamelCase ($str) |
Protected Attributes | |
$ar_safe_read = true | |
$connector_container_name = '' | |
ActiveRecord::__construct | ( | $primary_key = 0 , |
|
arConnector | $connector = null |
||
) |
int | $primary_key | |
arConnector | $connector |
Reimplemented in CachedActiveRecord.
Definition at line 117 of file class.ActiveRecord.php.
References arFieldCache\get(), and read().
ActiveRecord::__asArray | ( | ) |
Definition at line 211 of file class.ActiveRecord.php.
References getArFieldList().
Referenced by __asCsv().
ActiveRecord::__asCsv | ( | $separator = ';' , |
|
$header = false |
|||
) |
string | $separator | |
bool | $header |
Definition at line 172 of file class.ActiveRecord.php.
References __asArray(), getArFieldList(), and serializeToCSV().
ActiveRecord::__asSerializedObject | ( | ) |
Definition at line 241 of file class.ActiveRecord.php.
ActiveRecord::__asStdClass | ( | ) |
Definition at line 226 of file class.ActiveRecord.php.
References getArFieldList().
Referenced by arConnectorSession\create(), and arConnectorCache\storeActiveRecordInCache().
ActiveRecord::__call | ( | $name, | |
$arguments | |||
) |
$name | |
$arguments |
Definition at line 924 of file class.ActiveRecord.php.
References $name.
ActiveRecord::__getConvertedDateFieldsAsArray | ( | $format = null | ) |
string | $format |
Definition at line 145 of file class.ActiveRecord.php.
References $format, $name, and getArFieldList().
|
static |
string | $str | |
bool | $capitalise_first_char |
Definition at line 946 of file class.ActiveRecord.php.
References Vendor\Package\$c.
Referenced by arViewField\__construct().
|
static |
array | $additional_params |
Definition at line 595 of file class.ActiveRecord.php.
|
static |
Definition at line 792 of file class.ActiveRecord.php.
ActiveRecord::afterObjectLoad | ( | ) |
Reimplemented in ilDclFieldProperty, ilOrgUnitPosition, ilOrgUnitPermission, and CachedActiveRecord.
Definition at line 535 of file class.ActiveRecord.php.
ActiveRecord::buildFromArray | ( | array | $array | ) |
array | $array |
Reimplemented in ilAccessibilityDocument, CachedActiveRecord, and ilTermsOfServiceDocument.
Definition at line 252 of file class.ActiveRecord.php.
References arObjectCache\get(), arObjectCache\isCached(), and arObjectCache\store().
|
static |
arConnector | $connector |
Reimplemented in CachedActiveRecord.
Definition at line 881 of file class.ActiveRecord.php.
ActiveRecord::copy | ( | $new_id = 0 | ) |
int | $new_id |
arException |
Reimplemented in CachedActiveRecord.
Definition at line 523 of file class.ActiveRecord.php.
References arException\COPY_DESTINATION_ID_EXISTS.
|
static |
Definition at line 803 of file class.ActiveRecord.php.
Referenced by ilAccessibilityDocument\detachCriterion(), ilTermsOfServiceDocument\detachCriterion(), and ilOrgUnitPosition\storeAuthorities().
ActiveRecord::create | ( | ) |
Reimplemented in ilDclFieldProperty, ilOrgUnitPosition, ilOrgUnitOperation, ilOrgUnitOperationContext, ilOrgUnitPermission, ilOrgUnitUserAssignment, ilAccessibilityDocumentCriterionAssignment, CachedActiveRecord, arStorage, ilMMItemStorage, and ilTermsOfServiceDocumentCriterionAssignment.
Definition at line 505 of file class.ActiveRecord.php.
References arFieldCache\getPrimaryFieldName(), and arObjectCache\store().
Referenced by ilDclTableView\cloneStructure(), ilDclTableViewFieldSetting\cloneStructure(), and ilOrgUnitPathStorage\store().
|
static |
string | $date_format |
Definition at line 765 of file class.ActiveRecord.php.
|
static |
Definition at line 823 of file class.ActiveRecord.php.
ActiveRecord::delete | ( | ) |
Reimplemented in ilDclTableView, ilOrgUnitPosition, ilOrgUnitPermission, ilOrgUnitUserAssignment, and CachedActiveRecord.
Definition at line 570 of file class.ActiveRecord.php.
References arObjectCache\purge().
Referenced by arObjectCache\purge().
|
staticfinal |
$field_name |
Definition at line 407 of file class.ActiveRecord.php.
|
static |
Tries to find the object and throws an Exception if object is not found, instead of returning null.
$primary_key | ||
array | $add_constructor_args |
arException |
Definition at line 645 of file class.ActiveRecord.php.
References arException\RECORD_NOT_FOUND.
Referenced by ilBiblLibraryFactory\findById(), ilBiblFieldFilterFactory\findById(), ilBiblTranslationFactory\findById(), ilOrgUnitOperationQueries\findById(), and ilObjDefReader\handlerBeginTag().
|
static |
$primary_key | ||
array | $add_constructor_args |
@description Returns an existing Object with given primary-key or a new Instance with given primary-key set but not yet created
Definition at line 664 of file class.ActiveRecord.php.
Referenced by ilDclTableViewGUI\executeCommand().
|
static |
Definition at line 834 of file class.ActiveRecord.php.
Referenced by ilDclTableView\createOrGetStandardView(), and ilDclTableViewFieldSetting\getInstance().
ActiveRecord::fixDateField | ( | $field_name, | |
$value | |||
) |
$field_name | |
$value |
Definition at line 276 of file class.ActiveRecord.php.
|
staticfinal |
Definition at line 478 of file class.ActiveRecord.php.
Referenced by ilMMTopItemGUI\restore().
|
staticprotected |
string | $str |
Definition at line 963 of file class.ActiveRecord.php.
References Vendor\Package\$c.
|
static |
Reimplemented in ilOrgUnitPosition.
Definition at line 812 of file class.ActiveRecord.php.
Referenced by ilBiblLibraryFactory\getAll().
ActiveRecord::getArConnector | ( | ) |
Definition at line 40 of file class.ActiveRecord.php.
References arConnectorMap\get().
Referenced by arWhere\asSQLStatement().
ActiveRecord::getArFieldList | ( | ) |
Definition at line 49 of file class.ActiveRecord.php.
References arFieldCache\get().
Referenced by __asArray(), __asCsv(), __asStdClass(), __getConvertedDateFieldsAsArray(), arWhere\asSQLStatement(), CachedActiveRecord\buildHash(), CachedActiveRecord\getCacheIdentifier(), arConnectorDB\installDatabase(), arConnectorDB\updateDatabase(), and arConnectorDB\updateIndices().
|
static |
null | $key | |
null | $values |
Definition at line 908 of file class.ActiveRecord.php.
Referenced by ilMMItemInformation\__construct(), ilMMAbstractBaseTypeHandlerAction\__construct(), ilOrgUnitPositionTableGUI\buildData(), ilOrgUnitPathStorage\getTextRepresentationOfOrgUnits(), ilOrgUnitUserAssignmentGUI\index(), ilOrgUnitPositionFormGUI\initFormElements(), ilMemcacheServerTableGUI\parseData(), ILIAS\OrgUnit\Webservices\SOAP\PositionIds\run(), and ilPermissionGUI\savePositionsPermissions().
|
final |
Definition at line 322 of file class.ActiveRecord.php.
References $data.
Referenced by arConnectorDB\create(), and arConnectorDB\update().
|
final |
Definition at line 313 of file class.ActiveRecord.php.
|
staticprotected |
@description Returns an instance of the instatiated calling active record (needs to be done in static methods) @TODO : This should be cached somehow
Definition at line 348 of file class.ActiveRecord.php.
References arCalledClassCache\get().
Referenced by getConnectorContainerName().
|
static |
Definition at line 845 of file class.ActiveRecord.php.
Referenced by ilBiblFieldFactory\getCollectionForFilter().
ActiveRecord::getConnectorContainerName | ( | ) |
Reimplemented in ilBiblLibrary, ilBiblAttribute, ilBiblData, ilBiblEntry, ilBiblField, ilBiblFieldFilter, ilBiblOverviewModel, ilBiblTranslation, ilOrgUnitPathStorage, ilADTActiveRecordWrapper, ILIAS\MainMenu\Storage\Information\Repository\ARInformation, ILIAS\MainMenu\Storage\Resource\Repository\ARResource, and ILIAS\MainMenu\Storage\Revision\Repository\ARRevision.
Definition at line 69 of file class.ActiveRecord.php.
References $connector_container_name, and getCalledClass().
Referenced by arWhere\asSQLStatement(), arJoin\asStatementText(), arConnectorDB\checkFieldExists(), arConnectorDB\checkTableExists(), arConnectorDB\create(), CachedActiveRecord\getCacheIdentifier(), innerjoinAR(), ActiveRecordList\innerjoinAR(), arConnectorDB\installDatabase(), arConnectorDB\nextID(), arConnectorCache\read(), arConnectorDB\read(), arConnectorDB\removeField(), arConnectorDB\renameField(), arConnectorDB\resetDatabase(), arConnectorCache\storeActiveRecordInCache(), arConnectorDB\truncateDatabase(), arConnectorDB\update(), arConnectorDB\updateDatabase(), and arConnectorDB\updateIndices().
|
static |
Definition at line 868 of file class.ActiveRecord.php.
ActiveRecord::getPrimaryFieldValue | ( | ) |
Reimplemented in ilADTActiveRecordWrapper.
Definition at line 94 of file class.ActiveRecord.php.
References arFieldCache\getPrimaryFieldName().
Referenced by arConnectorSession\create(), CachedActiveRecord\getCacheIdentifier(), arObjectCache\purge(), arConnectorCache\read(), arConnectorDB\read(), arConnectorSession\read(), arObjectCache\store(), arConnectorCache\storeActiveRecordInCache(), and arConnectorDB\update().
|
static |
$tablename | ||
$on_this | ||
$on_external | ||
array | $fields | |
string | $operator |
Definition at line 720 of file class.ActiveRecord.php.
Referenced by ilMStListCertificatesGUI\getActions(), ilMStListCompetencesGUI\getActions(), ilMStListCoursesGUI\getActions(), and ilMStShowUserCoursesGUI\getActions().
|
static |
ActiveRecord | $ar | |
$on_this | ||
$on_external | ||
array | $fields | |
string | $operator |
Definition at line 705 of file class.ActiveRecord.php.
References getConnectorContainerName().
ActiveRecord::installConnector | ( | ) |
Definition at line 375 of file class.ActiveRecord.php.
|
finalprotected |
Definition at line 427 of file class.ActiveRecord.php.
|
staticfinal |
$arBuilder = new arBuilder(new ilYourARBasedClass()); $arBuilder->generateDBUpdateForInstallation();
Definition at line 364 of file class.ActiveRecord.php.
Referenced by arConnectorDB\resetDatabase().
|
static |
Definition at line 856 of file class.ActiveRecord.php.
|
static |
$tablename | ||
$on_this | ||
$on_external | ||
array | $fields | |
string | $operator |
Definition at line 737 of file class.ActiveRecord.php.
|
static |
$start | |
$end |
Definition at line 780 of file class.ActiveRecord.php.
|
static |
$orderBy | ||
string | $orderDirection |
Definition at line 751 of file class.ActiveRecord.php.
Referenced by ilDclTableView\createOrGetStandardView(), ilAccessibilityDocumentTableDataProvider\getList(), ilTermsOfServiceDocumentTableDataProvider\getList(), ilOrgUnitPathStorage\getTextRepresentationOfOrgUnits(), ilDclSelectionOption\getValues(), ilInitialisation\initAccessibilityControlConcept(), and ilInitialisation\initTermsOfService().
|
static |
Definition at line 584 of file class.ActiveRecord.php.
References ILIAS\GlobalScreen\get().
|
static |
bool | $set_raw |
Definition at line 894 of file class.ActiveRecord.php.
ActiveRecord::read | ( | ) |
arException |
Reimplemented in ilAccessibilityDocument, CachedActiveRecord, arStorage, and ilTermsOfServiceDocument.
Definition at line 543 of file class.ActiveRecord.php.
References arException\RECORD_NOT_FOUND.
Referenced by __construct().
|
staticfinal |
$field_name |
Definition at line 418 of file class.ActiveRecord.php.
|
staticfinal |
$old_name | |
$new_name |
Definition at line 387 of file class.ActiveRecord.php.
|
staticfinal |
|
static |
Reimplemented in ilBiblLibrary, ilBiblAttribute, ilBiblData, ilBiblEntry, ilBiblField, ilBiblFieldFilter, ilBiblOverviewModel, ilBiblTranslation, ilDclFieldProperty, ilDclSelectionOption, ilDclTableFieldSetting, ilDclTableView, ilDclTableViewFieldSetting, ilExAssWikiTeamAR, ilItemGroupAR, ilOrgUnitAuthority, ilOrgUnitPosition, ilOrgUnitOperation, ilOrgUnitOperationContext, ilOrgUnitPermission, ilOrgUnitUserAssignment, ilAccessibilityDocumentCriterionAssignment, ilAccessibilityDocument, ilADTActiveRecordWrapper, ilMemcacheServer, ilTermsOfServiceDocumentCriterionAssignment, ilTermsOfServiceDocument, ilWACSecurePath, ILIAS\BackgroundTasks\Implementation\Persistence\BucketContainer, ILIAS\BackgroundTasks\Implementation\Persistence\TaskContainer, ILIAS\BackgroundTasks\Implementation\Persistence\ValueContainer, and ILIAS\BackgroundTasks\Implementation\Persistence\ValueToTaskContainer.
Definition at line 59 of file class.ActiveRecord.php.
References arException\UNKNONWN_EXCEPTION.
ActiveRecord::save | ( | ) |
Reimplemented in CachedActiveRecord.
Definition at line 499 of file class.ActiveRecord.php.
|
protected |
This method is called for every field of your instance if you use __asCsv.
You can use it to customize your export into csv. (e.g. serialize an array).
$field | string |
Definition at line 202 of file class.ActiveRecord.php.
Referenced by __asCsv().
ActiveRecord::setConnectorContainerName | ( | $connector_container_name | ) |
string | $connector_container_name |
Definition at line 85 of file class.ActiveRecord.php.
References $connector_container_name.
ActiveRecord::setPrimaryFieldValue | ( | $value | ) |
$value |
Definition at line 105 of file class.ActiveRecord.php.
References arFieldCache\getPrimaryFieldName().
ActiveRecord::sleep | ( | $field_name | ) |
$field_name |
Reimplemented in ilDclTableView, ilDclTableViewFieldSetting, ilOrgUnitPermission, and ilADTActiveRecordWrapper.
Definition at line 291 of file class.ActiveRecord.php.
ActiveRecord::store | ( | ) |
Reimplemented in ilOrgUnitPathStorage, and CachedActiveRecord.
Definition at line 486 of file class.ActiveRecord.php.
References arFieldCache\getPrimaryFieldName().
ActiveRecord::storeObjectToCache | ( | ) |
Reimplemented in CachedActiveRecord.
Definition at line 134 of file class.ActiveRecord.php.
References arObjectCache\store().
|
staticfinal |
|
staticfinal |
ActiveRecord::update | ( | ) |
Reimplemented in ilDclFieldProperty, ilOrgUnitPosition, ilOrgUnitPermission, ilAccessibilityDocumentCriterionAssignment, CachedActiveRecord, arStorage, and ilTermsOfServiceDocumentCriterionAssignment.
Definition at line 563 of file class.ActiveRecord.php.
References arObjectCache\store().
Referenced by ilAccessibilityDocumentGUI\detachCriterionAssignment(), ilTermsOfServiceDocumentGUI\detachCriterionAssignment(), and ilOrgUnitPathStorage\store().
|
staticfinal |
Definition at line 445 of file class.ActiveRecord.php.
ActiveRecord::wakeUp | ( | $field_name, | |
$field_value | |||
) |
$field_name | |
$field_value |
Reimplemented in ilDclTableView, ilDclTableViewFieldSetting, ilOrgUnitPermission, and ilADTActiveRecordWrapper.
Definition at line 303 of file class.ActiveRecord.php.
|
static |
$where | ||
null | $operator |
Definition at line 687 of file class.ActiveRecord.php.
Referenced by ilOrgUnitPosition\afterObjectLoad(), ilDclTableView\createFieldSetting(), ilObjOrgUnit\delete(), ilMMAbstractItemFacade\deleteAssociatedTranslations(), ilBiblEntryFactory\deleteEntryById(), ilObjBibliographic\doRead(), ilBiblFieldFilterFactory\filterItemsForTable(), ilBiblFieldFilterFactory\findByFieldId(), ilBiblEntryFactory\findByIdAndTypeString(), ilOrgUnitOperationContextQueries\findByName(), ilOrgUnitOperationQueries\findByOperationString(), ilOrgUnitUserAssignment\findOrCreateAssignment(), ilBiblFieldFactory\findOrCreateFieldOfAttribute(), ILIAS\MainMenu\Storage\Revision\Repository\RevisionARRepository\get(), ilBiblEntryFactory\getAllAttributesByEntryId(), ilBiblEntryFactory\getAllEntries(), ilDclSelectionOption\getAllForField(), ilBiblFieldFilterFactory\getAllForObjectId(), ilDclTableView\getAllForTableId(), ilBiblEntryFactory\getARInstance(), ilBiblFieldFactory\getARInstance(), ilObjOrgUnitTree\getAssignements(), ilOrgUnitUserAssignmentQueries\getAssignmentOrFail(), OrgUnit\Positions\UserAssignment\ilOrgUnitUserAssignmentRepository\getAssignmentOrFail(), ilOrgUnitUserAssignmentQueries\getAssignmentsOfUserId(), OrgUnit\Positions\UserAssignment\ilOrgUnitUserAssignmentRepository\getAssignmentsOfUserId(), ilOrgUnitUserAssignmentQueries\getAssignmentsOfUserIdAndPosition(), ilBiblAttributeFactory\getAttributesForEntry(), ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\getBucketIdsByState(), ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\getBucketIdsOfUser(), ILIAS\BackgroundTasks\Implementation\Persistence\BasicPersistence\getBucketMetaOfUser(), ilBiblFieldFilterFactory\getByObjectIdAndField(), ilBiblTranslationFactory\getCollectionOfTranslationsForField(), ilOrgUnitPosition\getCorePosition(), ilDclTableView\getCountForTableId(), ilOrgUnitPosition\getDependentAuthorities(), ilAccessibilityDocumentGUI\getDocumentsByServerRequest(), ilTermsOfServiceDocumentGUI\getDocumentsByServerRequest(), ilBiblEntryFactory\getEntryById(), ilDclCache\getFieldProperties(), ilDclBaseFieldModel\getFieldSettings(), ilDclTableView\getFieldSettings(), ilDclTableView\getFilterableFieldSettings(), ilBiblDataFactory\getIlBiblDataById(), ilDclTableFieldSetting\getInstance(), ilOrgUnitUserAssignmentQueries\getOrgUnitIdsOfUsersPosition(), OrgUnit\Positions\UserAssignment\ilOrgUnitUserAssignmentRepository\getOrgUnitIdsOfUsersPosition(), ilDclTableHelper\getStandardViewsByVisibleTables(), ilOrgUnitPermissionQueries\getTemplateSetForContextName(), ilMMItemRepository\getTopItems(), ilOrgUnitUserAssignmentQueries\getUserAssignmentsOfPosition(), OrgUnit\Positions\UserAssignment\ilOrgUnitUserAssignmentRepository\getUserAssignmentsOfPosition(), ilOrgUnitUserAssignmentQueries\getUserIdsOfOrgUnit(), OrgUnit\Positions\UserAssignment\ilOrgUnitUserAssignmentRepository\getUserIdsOfOrgUnit(), ilOrgUnitUserAssignmentQueries\getUserIdsOfOrgUnits(), OrgUnit\Positions\UserAssignment\ilOrgUnitUserAssignmentRepository\getUserIdsOfOrgUnits(), ilOrgUnitUserAssignmentQueries\getUserIdsOfOrgUnitsInPosition(), OrgUnit\Positions\UserAssignment\ilOrgUnitUserAssignmentRepository\getUserIdsOfOrgUnitsInPosition(), ilOrgUnitUserAssignmentQueries\getUserIdsOfOrgUnitsOfUsersPosition(), OrgUnit\Positions\UserAssignment\ilOrgUnitUserAssignmentRepository\getUserIdsOfOrgUnitsOfUsersPosition(), ilOrgUnitUserAssignmentQueries\getUserIdsOfPosition(), OrgUnit\Positions\UserAssignment\ilOrgUnitUserAssignmentRepository\getUserIdsOfPosition(), ilOrgUnitUserAssignmentQueries\getUserIdsOfUsersOrgUnitsInPosition(), OrgUnit\Positions\UserAssignment\ilOrgUnitUserAssignmentRepository\getUserIdsOfUsersOrgUnitsInPosition(), ilDclTableView\getVisibleFields(), ilOrgUnitPermissionQueries\hasLocalSet(), ilBiblEntryFactory\loadParsedAttributesByEntryId(), ilMMItemTranslationTableGUI\parseData(), ilDclCache\preloadFieldProperties(), ILIAS\OrgUnit\Webservices\SOAP\RemoveUserIdFromPositionInOrgUnit\run(), ilTermsOfServiceSettingsFormGUI\saveObject(), ilObjTermsOfServiceGUI\showMissingDocuments(), ilOrgUnitSimpleUserImport\simpleUserImportElement(), and ilOrgUnitPosition\storeAuthorities().
|
protected |
Definition at line 30 of file class.ActiveRecord.php.
|
protected |
Definition at line 34 of file class.ActiveRecord.php.
Referenced by getConnectorContainerName(), and setConnectorContainerName().
const ActiveRecord::ACTIVE_RECORD_VERSION = '2.0.7' |
Definition at line 26 of file class.ActiveRecord.php.