ILIAS
release_4-3 Revision
|
A dataset contains in data in a common structure that can be shared and transformed for different purposes easily, examples. More...
Public Member Functions | |
__construct () | |
Constructor. | |
init ($a_entity, $a_schema_version) | |
Init. | |
getSupportedVersions () | |
Get supported version. | |
readData ($a_entity, $a_version, $a_ids) | |
Read data from DB. | |
setExportDirectories ($a_relative, $a_absolute) | |
Set export directories. | |
setImportDirectory ($a_val) | |
Set import directory. | |
getImportDirectory () | |
Get import directory. | |
setDSPrefix ($a_val) | |
Set XML dataset namespace prefix. | |
getDSPrefix () | |
Get XML dataset namespace prefix. | |
getDSPrefixString () | |
getDirectDataFromQuery ($a_query, $a_convert_to_leading_upper=true) | |
Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields. | |
convertToLeadingUpper ($a_str) | |
Make xyz_abc a XyzAbc string. | |
getJsonRepresentation () | |
Get json representation. | |
getXmlRepresentation ($a_entity, $a_schema_version, $a_ids, $a_field="", $a_omit_header=false, $a_omit_types=false) | |
Get xml representation <dataset install_id="123" install_url="..."> <types entity="table_name" version="4.0.1"> <ftype name="field_1" type="text"> <ftype name="field_2" type="date"> <ftype name="field_3" type="integer"> </types> <types ...> ... | |
addRecordsXml ($a_writer, $a_prefixes, $a_entity, $a_schema_version, $a_ids, $a_field="") | |
Add records xml. | |
afterXmlRecordWriting ($a_entity, $a_version, $a_set) | |
After xml record writing hook record. | |
getNamespaces (&$namespaces, $a_entity, $a_schema_version) | |
Get xml namespaces. | |
getXmlRecord ($a_entity, $a_version, $a_set) | |
Get xml record for version. | |
getJsonRecord ($a_set) | |
Get json record for version. | |
getXmlTypes ($a_entity, $a_version) | |
Get xml types. | |
getJsonTypes ($a_entity, $a_version) | |
Get json types. | |
getXMLEntityName ($a_entity, $a_version) | |
Get entity name for xml (may be overwritten) | |
getXMLEntityTag ($a_entity, $a_schema_version) | |
Get entity tag. | |
getJsonEntityName ($a_entity, $a_version) | |
Get entity name for json (may be overwritten) | |
setImport ($a_val) | |
Set import object. | |
getImport () | |
Get import object. |
Data Fields | |
$dircnt | |
const | EXPORT_NO_INST_ID = 1 |
const | EXPORT_ID_ILIAS_LOCAL = 2 |
const | EXPORT_ID_ILIAS_LOCAL_INVALID = 3 |
const | EXPORT_ID_ILIAS_REMOTE = 4 |
const | EXPORT_ID_ILIAS_REMOTE_INVALID = 5 |
const | EXPORT_ID = 6 |
const | EXPORT_ID_INVALID = 7 |
Protected Member Functions | |
getTypes ($a_entity, $a_version) | |
Get (abstract) types for (abstract) field names. | |
getXmlNamespace ($a_entity, $a_schema_version) | |
Get xml namespace. | |
createObjectExportId ($a_type, $a_id) | |
Build ilias export id. | |
parseObjectExportId ($a_id, $a_fallback_id=NULL) | |
Parse export id. |
Private Member Functions | |
addTypesXml ($a_writer, $a_entity, $a_schema_version) | |
Add types to xml writer. |
A dataset contains in data in a common structure that can be shared and transformed for different purposes easily, examples.
The general structure is:
Definition at line 24 of file class.ilDataSet.php.
ilDataSet::__construct | ( | ) |
ilDataSet::addRecordsXml | ( | $a_writer, | |
$a_prefixes, | |||
$a_entity, | |||
$a_schema_version, | |||
$a_ids, | |||
$a_field = "" |
|||
) |
Add records xml.
@return |
Definition at line 308 of file class.ilDataSet.php.
References $d, $dircnt, afterXmlRecordWriting(), getDSPrefixString(), getXmlRecord(), getXmlTypes(), ilUtil\makeDirParents(), ilUtil\rCopy(), and readData().
Referenced by getXmlRepresentation().
|
private |
Add types to xml writer.
Definition at line 391 of file class.ilDataSet.php.
References $t, getDSPrefixString(), and getXmlTypes().
Referenced by getXmlRepresentation().
ilDataSet::afterXmlRecordWriting | ( | $a_entity, | |
$a_version, | |||
$a_set | |||
) |
After xml record writing hook record.
@return |
Reimplemented in ilUserDataSet.
Definition at line 382 of file class.ilDataSet.php.
Referenced by addRecordsXml().
ilDataSet::convertToLeadingUpper | ( | $a_str | ) |
Make xyz_abc a XyzAbc string.
@return |
Definition at line 190 of file class.ilDataSet.php.
Referenced by getDirectDataFromQuery(), getXMLEntityTag(), and ilUserDataSet\importRecord().
|
protected |
Build ilias export id.
string | $a_type | |
int | $a_id |
Definition at line 546 of file class.ilDataSet.php.
Referenced by ilBlogDataSet\readData().
ilDataSet::getDirectDataFromQuery | ( | $a_query, | |
$a_convert_to_leading_upper = true |
|||
) |
Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields.
@return |
Definition at line 161 of file class.ilDataSet.php.
References convertToLeadingUpper().
Referenced by ilExternalFeedDataSet\readData(), ilHTMLLearningModuleDataSet\readData(), ilMediaCastDataSet\readData(), ilRatingDataSet\readData(), ilCOPageDataSet\readData(), ilNotesDataSet\readData(), ilNewsDataSet\readData(), ilItemGroupDataSet\readData(), ilPollDataSet\readData(), ilBookmarkDataSet\readData(), ilHelpDataSet\readData(), ilExerciseDataSet\readData(), ilBlogDataSet\readData(), ilSessionDataSet\readData(), ilMediaPoolDataSet\readData(), ilWikiDataSet\readData(), ilTaxonomyDataSet\readData(), ilCalendarDataSet\readData(), ilMediaObjectDataSet\readData(), and ilUserDataSet\readData().
ilDataSet::getDSPrefix | ( | ) |
Get XML dataset namespace prefix.
Definition at line 141 of file class.ilDataSet.php.
Referenced by getDSPrefixString().
ilDataSet::getDSPrefixString | ( | ) |
Definition at line 146 of file class.ilDataSet.php.
References getDSPrefix().
Referenced by addRecordsXml(), addTypesXml(), and getXmlRepresentation().
ilDataSet::getImport | ( | ) |
Get import object.
Definition at line 534 of file class.ilDataSet.php.
ilDataSet::getImportDirectory | ( | ) |
Get import directory.
Definition at line 121 of file class.ilDataSet.php.
Referenced by ilHTMLLearningModuleDataSet\importRecord(), ilPollDataSet\importRecord(), ilBlogDataSet\importRecord(), ilExerciseDataSet\importRecord(), ilUserDataSet\importRecord(), and ilMediaObjectDataSet\importRecord().
ilDataSet::getJsonEntityName | ( | $a_entity, | |
$a_version | |||
) |
Get entity name for json (may be overwritten)
Definition at line 514 of file class.ilDataSet.php.
Referenced by getJsonRepresentation().
ilDataSet::getJsonRecord | ( | $a_set | ) |
Get json record for version.
array | abstract data record |
Definition at line 463 of file class.ilDataSet.php.
Referenced by getJsonRepresentation().
|
final |
Get json representation.
Definition at line 206 of file class.ilDataSet.php.
References $d, ilJsonUtil\encode(), getJsonEntityName(), getJsonRecord(), and getJsonTypes().
ilDataSet::getJsonTypes | ( | $a_entity, | |
$a_version | |||
) |
Get json types.
Definition at line 483 of file class.ilDataSet.php.
References getTypes().
Referenced by getJsonRepresentation().
ilDataSet::getNamespaces | ( | & | $namespaces, |
$a_entity, | |||
$a_schema_version | |||
) |
Get xml namespaces.
array | namespaces per entity |
string | entity |
string | target release |
Definition at line 428 of file class.ilDataSet.php.
References getXmlNamespace().
Referenced by getXmlRepresentation().
|
abstract |
Get supported version.
Reimplemented in ilCOPageDataSet, ilMediaObjectDataSet, ilTaxonomyDataSet, ilMediaPoolDataSet, ilWikiDataSet, ilBlogDataSet, ilPollDataSet, ilRatingDataSet, ilNotesDataSet, ilUserDataSet, ilHelpDataSet, ilExerciseDataSet, ilExternalFeedDataSet, ilHTMLLearningModuleDataSet, ilItemGroupDataSet, ilMediaCastDataSet, ilSessionDataSet, ilBookmarkDataSet, ilCalendarDataSet, and ilNewsDataSet.
|
abstractprotected |
Get (abstract) types for (abstract) field names.
Please note that the abstract fields/types only depend on the version! Not on a choosen representation!
Reimplemented in ilCOPageDataSet, ilMediaObjectDataSet, ilTaxonomyDataSet, ilMediaPoolDataSet, ilWikiDataSet, ilRatingDataSet, ilNotesDataSet, ilUserDataSet, ilHelpDataSet, ilExerciseDataSet, ilExternalFeedDataSet, ilHTMLLearningModuleDataSet, ilItemGroupDataSet, ilMediaCastDataSet, ilSessionDataSet, ilBookmarkDataSet, ilCalendarDataSet, ilNewsDataSet, ilBlogDataSet, and ilPollDataSet.
Referenced by getJsonTypes(), and getXmlTypes().
ilDataSet::getXMLEntityName | ( | $a_entity, | |
$a_version | |||
) |
Get entity name for xml (may be overwritten)
Definition at line 494 of file class.ilDataSet.php.
ilDataSet::getXMLEntityTag | ( | $a_entity, | |
$a_schema_version | |||
) |
Get entity tag.
@return |
Definition at line 505 of file class.ilDataSet.php.
References convertToLeadingUpper().
|
abstractprotected |
Get xml namespace.
Reimplemented in ilCOPageDataSet, ilMediaObjectDataSet, ilTaxonomyDataSet, ilMediaPoolDataSet, ilWikiDataSet, ilRatingDataSet, ilNotesDataSet, ilUserDataSet, ilHelpDataSet, ilBlogDataSet, ilExerciseDataSet, ilExternalFeedDataSet, ilHTMLLearningModuleDataSet, ilItemGroupDataSet, ilMediaCastDataSet, ilPollDataSet, ilSessionDataSet, ilBookmarkDataSet, ilCalendarDataSet, and ilNewsDataSet.
Referenced by getNamespaces().
ilDataSet::getXmlRecord | ( | $a_entity, | |
$a_version, | |||
$a_set | |||
) |
Get xml record for version.
array | abstract data record |
Reimplemented in ilMediaObjectDataSet, ilBlogDataSet, ilPollDataSet, ilSessionDataSet, ilExerciseDataSet, ilItemGroupDataSet, ilUserDataSet, and ilHTMLLearningModuleDataSet.
Definition at line 452 of file class.ilDataSet.php.
Referenced by addRecordsXml().
|
final |
Get xml representation <dataset install_id="123" install_url="..."> <types entity="table_name" version="4.0.1"> <ftype name="field_1" type="text"> <ftype name="field_2" type="date"> <ftype name="field_3" type="integer"> </types> <types ...> ...
</types> <set entity="table_name"> <rec> <field_1>content</field_1> <field_2>my_date</field_2> <field_3>my_number</field_3> </rec> ... </set> </dataset>
Definition at line 250 of file class.ilDataSet.php.
References addRecordsXml(), addTypesXml(), getDSPrefixString(), and getNamespaces().
ilDataSet::getXmlTypes | ( | $a_entity, | |
$a_version | |||
) |
Get xml types.
Definition at line 473 of file class.ilDataSet.php.
References getTypes().
Referenced by addRecordsXml(), and addTypesXml().
|
final |
Init.
string | (abstract) entity name |
string | version string, always the ILIAS release versions that defined the a structure or made changes to it, never use another version. Example: structure is defined in 4.1.0 and changed in 4.3.0 -> use these values only, not 4.2.0 (ask for the 4.1.0 version in ILIAS 4.2.0) |
Definition at line 56 of file class.ilDataSet.php.
|
protected |
Parse export id.
string | $a_id | |
int | $a_fallback_id |
Definition at line 558 of file class.ilDataSet.php.
References ilObject\_getIdForImportId(), and ilObject\_lookupType().
Referenced by ilBlogDataSet\importRecord().
|
abstract |
Read data from DB.
This should result in the abstract field structure of the version set in the constructor.
array | one or multiple ids |
Referenced by addRecordsXml().
ilDataSet::setDSPrefix | ( | $a_val | ) |
Set XML dataset namespace prefix.
string | XML dataset namespace prefix |
Definition at line 131 of file class.ilDataSet.php.
ilDataSet::setExportDirectories | ( | $a_relative, | |
$a_absolute | |||
) |
Set export directories.
@return |
Definition at line 100 of file class.ilDataSet.php.
ilDataSet::setImport | ( | $a_val | ) |
Set import object.
object | import object |
Definition at line 524 of file class.ilDataSet.php.
ilDataSet::setImportDirectory | ( | $a_val | ) |
Set import directory.
string | import directory |
Definition at line 111 of file class.ilDataSet.php.
ilDataSet::$dircnt |
Definition at line 26 of file class.ilDataSet.php.
Referenced by addRecordsXml().
const ilDataSet::EXPORT_ID = 6 |
Definition at line 33 of file class.ilDataSet.php.
const ilDataSet::EXPORT_ID_ILIAS_LOCAL = 2 |
Definition at line 29 of file class.ilDataSet.php.
const ilDataSet::EXPORT_ID_ILIAS_LOCAL_INVALID = 3 |
Definition at line 30 of file class.ilDataSet.php.
const ilDataSet::EXPORT_ID_ILIAS_REMOTE = 4 |
Definition at line 31 of file class.ilDataSet.php.
const ilDataSet::EXPORT_ID_ILIAS_REMOTE_INVALID = 5 |
Definition at line 32 of file class.ilDataSet.php.
const ilDataSet::EXPORT_ID_INVALID = 7 |
Definition at line 34 of file class.ilDataSet.php.
const ilDataSet::EXPORT_NO_INST_ID = 1 |
Definition at line 28 of file class.ilDataSet.php.