Open Journal Systems
3.3.0
|
Public Member Functions | |
_fromRow ($row) | |
categoryExistsByPath ($path) | |
deleteByContextId ($contextId) | |
deleteById ($categoryId, $contextId=null) | |
deleteObject ($category) | |
deletePublicationAssignments ($publicationId) | |
getAdditionalFieldNames () | |
getByContextId ($contextId, $rangeInfo=null) | |
getById ($categoryId, $contextId=null, $parentId=null) | |
getByParentId ($parentId, $contextId=null, $rangeInfo=null) | |
getByPath ($path, $contextId) | |
getByPublicationId ($publicationId) | |
getByTitle ($categoryTitle, $contextId, $locale=null) | |
getCountByContextId ($contextId) | |
getInsertId () | |
getLocaleFieldNames () | |
insertObject ($category) | |
insertPublicationAssignment ($categoryId, $publicationId) | |
newDataObject () | |
resequenceCategories ($contextId, $parentCategoryId=null) | |
updateLocaleFields ($category) | |
updateObject ($category) | |
Public Member Functions inherited from DAO | |
__construct ($dataSource=null, $callHooks=true) | |
concat () | |
convertFromDB ($value, $type) | |
convertToDB ($value, &$type) | |
dateFromDB ($d) | |
datetimeFromDB ($dt) | |
datetimeToDB ($dt) | |
dateToDB ($d) | |
flushCache () | |
formatDateToDB ($date, $defaultNumWeeks=null, $acceptPastDate=true) | |
getAffectedRows () | |
getDataObjectSettings ($tableName, $idFieldName, $idFieldValue, $dataObject) | |
getDataSource () | |
getDirectionMapping ($direction) | |
getDriver () | |
getType ($value) | |
handleError ($dataSource, $sql) | |
nullOrInt ($value) | |
replace ($table, $arrFields, $keyCols) | |
& | retrieve ($sql, $params=false, $callHooks=true) |
& | retrieveCached ($sql, $params=false, $secsToCache=3600, $callHooks=true) |
& | retrieveLimit ($sql, $params=false, $numRows=false, $offset=false, $callHooks=true) |
& | retrieveRange ($sql, $params=false, $dbResultRange=null, $callHooks=true) |
setCacheDir () | |
setDataSource ($dataSource) | |
update ($sql, $params=false, $callHooks=true, $dieOnError=true) | |
updateDataObjectSettings ($tableName, $dataObject, $idArray) | |
Additional Inherited Members | |
Static Public Member Functions inherited from DAO | |
static | getDataChangedEvent ($elementId=null, $parentElementId=null, $content='') |
Data Fields inherited from DAO | |
$_dataSource | |
Protected Member Functions inherited from DAO | |
_getInsertId ($table='', $id='') | |
Operations for retrieving and modifying Category objects.
Definition at line 19 of file CategoryDAO.inc.php.
CategoryDAO::_fromRow | ( | $row | ) |
Internal function to return an Category object from a row.
$row | array |
Definition at line 149 of file CategoryDAO.inc.php.
References HookRegistry\call(), DAO\getDataObjectSettings(), and newDataObject().
Referenced by getById(), getByPath(), and getByTitle().
CategoryDAO::categoryExistsByPath | ( | $path | ) |
Check if a category exists with a specified path.
$path | the path for the category |
Definition at line 126 of file CategoryDAO.inc.php.
References DAO\retrieve().
CategoryDAO::deleteByContextId | ( | $contextId | ) |
Delete category by context ID NOTE: This does not delete dependent entries. It is intended to be called only when deleting a context.
$contextId | int |
Definition at line 330 of file CategoryDAO.inc.php.
References deleteObject(), and getByContextId().
CategoryDAO::deleteById | ( | $categoryId, | |
$contextId = null |
|||
) |
Delete an category by ID.
$categoryId | int |
$contextId | int optional |
Definition at line 297 of file CategoryDAO.inc.php.
References DAO\getAffectedRows(), and DAO\update().
Referenced by deleteObject().
CategoryDAO::deleteObject | ( | $category | ) |
Delete an category.
$category | Category |
Definition at line 285 of file CategoryDAO.inc.php.
References deleteById().
Referenced by deleteByContextId().
CategoryDAO::deletePublicationAssignments | ( | $publicationId | ) |
Delete the assignment of a category to a publication
int | $publicationId |
Definition at line 356 of file CategoryDAO.inc.php.
References DAO\update().
CategoryDAO::getAdditionalFieldNames | ( | ) |
Get a list of additional fields.
Reimplemented from DAO.
Definition at line 178 of file CategoryDAO.inc.php.
CategoryDAO::getByContextId | ( | $contextId, | |
$rangeInfo = null |
|||
) |
Retrieve all categories for a context.
$contextId | int Conext ID. |
$rangeInfo | Object Optional range information. |
Definition at line 369 of file CategoryDAO.inc.php.
References DAO\retrieveRange().
Referenced by deleteByContextId().
CategoryDAO::getById | ( | $categoryId, | |
$contextId = null , |
|||
$parentId = null |
|||
) |
Retrieve an category by ID.
$categoryId | int |
$contextId | int optional |
$parentId | int optional |
Definition at line 27 of file CategoryDAO.inc.php.
References _fromRow(), and DAO\retrieve().
CategoryDAO::getByParentId | ( | $parentId, | |
$contextId = null , |
|||
$rangeInfo = null |
|||
) |
Retrieve all categories for a parent category.
$parentId | int Parent category ID. |
$contextId | int Context ID (optional). |
$rangeInfo | Object Range info (optional). |
Definition at line 409 of file CategoryDAO.inc.php.
References DAO\retrieveRange().
CategoryDAO::getByPath | ( | $path, | |
$contextId | |||
) |
Retrieve a category by path.
$path | string |
$contextId | int |
Definition at line 55 of file CategoryDAO.inc.php.
References _fromRow(), and DAO\retrieve().
CategoryDAO::getByPublicationId | ( | $publicationId | ) |
Retrieve categories by publication id
int | $publicationId |
Definition at line 109 of file CategoryDAO.inc.php.
References DAO\retrieve().
CategoryDAO::getByTitle | ( | $categoryTitle, | |
$contextId, | |||
$locale = null |
|||
) |
Retrieve an category by title.
$categoryTitle | string |
$contextId | int |
$locale | string optional |
Definition at line 77 of file CategoryDAO.inc.php.
References _fromRow(), and DAO\retrieve().
CategoryDAO::getCountByContextId | ( | $contextId | ) |
Retrieve the number of categories for a context.
$contextId | int Context ID. |
Definition at line 389 of file CategoryDAO.inc.php.
References DAO\retrieve().
CategoryDAO::getInsertId | ( | ) |
Get the ID of the last inserted category.
Definition at line 428 of file CategoryDAO.inc.php.
References DAO\_getInsertId().
Referenced by insertObject().
CategoryDAO::getLocaleFieldNames | ( | ) |
Get the list of fields for which data can be localized.
Reimplemented from DAO.
Definition at line 170 of file CategoryDAO.inc.php.
CategoryDAO::insertObject | ( | $category | ) |
Insert a new category.
$category | Category |
Definition at line 205 of file CategoryDAO.inc.php.
References getInsertId(), DAO\update(), and updateLocaleFields().
CategoryDAO::insertPublicationAssignment | ( | $categoryId, | |
$publicationId | |||
) |
Assign a publication to a category
int | $categoryId | |
int | $publicationId |
Definition at line 343 of file CategoryDAO.inc.php.
References DAO\update().
CategoryDAO::newDataObject | ( | ) |
Construct a new data object corresponding to this DAO.
Definition at line 140 of file CategoryDAO.inc.php.
Referenced by _fromRow().
CategoryDAO::resequenceCategories | ( | $contextId, | |
$parentCategoryId = null |
|||
) |
Sequentially renumber categories in their sequence order by context ID and optionally parent category ID.
$contextId | int |
$parentCategoryId | int Optional parent category ID |
Definition at line 256 of file CategoryDAO.inc.php.
References DAO\retrieve(), and DAO\update().
CategoryDAO::updateLocaleFields | ( | $category | ) |
Update the localized fields for this table
$category | object |
Definition at line 191 of file CategoryDAO.inc.php.
References DAO\updateDataObjectSettings().
Referenced by insertObject(), and updateObject().
CategoryDAO::updateObject | ( | $category | ) |
Update an existing category.
$category | Category |
Definition at line 229 of file CategoryDAO.inc.php.
References DAO\update(), and updateLocaleFields().