PHP Класс SectionDAO, ojs

Наследование: extends PKPSectionDAO
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$cache

Открытые методы

Метод Описание
__construct ( )
_cacheMiss ( $cache, $id )
_fromRow ( $row ) : Section Internal function to return a Section object from a row.
_getCache ( )
customSectionOrderingExists ( $issueId ) : boolean Check if an issue has custom section ordering.
deleteById ( $sectionId, $contextId = null ) Delete a section by ID.
deleteByJournalId ( $journalId ) Delete sections by journal ID NOTE: This does not delete dependent entries EXCEPT from section_editors. It is intended to be called only when deleting a journal.
deleteCustomSection ( $issueId, $sectionId ) Delete a section from the custom section order table.
deleteCustomSectionOrdering ( $issueId ) Delete the custom ordering of an issue's sections.
getAll ( $rangeInfo = null ) : DAOResultFactory Retrieve all sections.
getByAbbrev ( $sectionAbbrev, $journalId, $locale = null ) : Section Retrieve a section by abbreviation.
getByContextId ( $journalId, $rangeInfo = null ) : DAOResultFactory Retrieve all sections for a journal.
getById ( $sectionId, $journalId = null, $useCache = false ) : Section Retrieve a section by ID.
getByIssueId ( $issueId ) : array Retrieve all sections in which articles are currently published in the given issue.
getByJournalId ( $journalId, $rangeInfo = null ) : DAOResultFactory Retrieve all sections for a journal.
getByTitle ( $sectionTitle, $journalId, $locale = null ) : Section Retrieve a section by title.
getCustomSectionOrder ( $issueId, $sectionId ) : integer Get the custom section order of a section.
getEditorSections ( $journalId ) : array Retrieve an array associating all section editor IDs with arrays containing the sections they edit.
getEmptyByJournalId ( $journalId ) : array Retrieve all empty (without articles) section ids for a journal.
getInsertId ( ) : integer Get the ID of the last inserted section.
getLocaleFieldNames ( ) : array Get the list of fields for which data can be localized.
getTitles ( $journalId, $submittableOnly = false ) : array Retrieve the IDs and titles of the sections for a journal in an associative array.
insertCustomSectionOrder ( $issueId, $sectionId, $seq ) INTERNAL USE ONLY: Insert a custom section ordering
insertObject ( $section ) Insert a new section.
newDataObject ( ) Return a new data object.
resequenceCustomSectionOrders ( $issueId ) Sequentially renumber custom section orderings in their sequence order.
resequenceSections ( $journalId ) Sequentially renumber sections in their sequence order.
sectionExists ( $sectionId, $journalId ) : boolean Check if a section exists with the specified ID.
setDefaultCustomSectionOrders ( $issueId ) Import the current section orders into the specified issue as custom issue orderings.
updateCustomSectionOrder ( $issueId, $sectionId, $seq ) Update a custom section ordering
updateLocaleFields ( $section ) Update the localized fields for this table
updateObject ( $section ) Update an existing section.

Описание методов

__construct() публичный Метод

public __construct ( )

_cacheMiss() публичный Метод

public _cacheMiss ( $cache, $id )

_fromRow() публичный Метод

Internal function to return a Section object from a row.
public _fromRow ( $row ) : Section
$row array
Результат Section

_getCache() публичный Метод

public _getCache ( )

customSectionOrderingExists() публичный Метод

Check if an issue has custom section ordering.
public customSectionOrderingExists ( $issueId ) : boolean
$issueId int
Результат boolean

deleteById() публичный Метод

Delete a section by ID.
public deleteById ( $sectionId, $contextId = null )
$sectionId int
$contextId int optional

deleteByJournalId() публичный Метод

Delete sections by journal ID NOTE: This does not delete dependent entries EXCEPT from section_editors. It is intended to be called only when deleting a journal.
public deleteByJournalId ( $journalId )
$journalId int

deleteCustomSection() публичный Метод

Delete a section from the custom section order table.
public deleteCustomSection ( $issueId, $sectionId )
$issueId int
$sectionId int

deleteCustomSectionOrdering() публичный Метод

Delete the custom ordering of an issue's sections.
public deleteCustomSectionOrdering ( $issueId )
$issueId int

getAll() публичный Метод

Retrieve all sections.
public getAll ( $rangeInfo = null ) : DAOResultFactory
Результат DAOResultFactory containing Sections ordered by journal ID and sequence

getByAbbrev() публичный Метод

Retrieve a section by abbreviation.
public getByAbbrev ( $sectionAbbrev, $journalId, $locale = null ) : Section
$sectionAbbrev string
$locale string optional
Результат Section

getByContextId() публичный Метод

Retrieve all sections for a journal.
public getByContextId ( $journalId, $rangeInfo = null ) : DAOResultFactory
$journalId int Journal ID
$rangeInfo Object
Результат DAOResultFactory containing Sections ordered by sequence

getById() публичный Метод

Retrieve a section by ID.
public getById ( $sectionId, $journalId = null, $useCache = false ) : Section
$sectionId int
$journalId int optional
$useCache boolean optional
Результат Section

getByIssueId() публичный Метод

Retrieve all sections in which articles are currently published in the given issue.
public getByIssueId ( $issueId ) : array
Результат array

getByJournalId() публичный Метод

Retrieve all sections for a journal.
public getByJournalId ( $journalId, $rangeInfo = null ) : DAOResultFactory
Результат DAOResultFactory containing Sections ordered by sequence

getByTitle() публичный Метод

Retrieve a section by title.
public getByTitle ( $sectionTitle, $journalId, $locale = null ) : Section
$sectionTitle string
Результат Section

getCustomSectionOrder() публичный Метод

Get the custom section order of a section.
public getCustomSectionOrder ( $issueId, $sectionId ) : integer
$issueId int
$sectionId int
Результат integer

getEditorSections() публичный Метод

Retrieve an array associating all section editor IDs with arrays containing the sections they edit.
public getEditorSections ( $journalId ) : array
Результат array editorId => array(sections they edit)

getEmptyByJournalId() публичный Метод

Retrieve all empty (without articles) section ids for a journal.
public getEmptyByJournalId ( $journalId ) : array
Результат array

getInsertId() публичный Метод

Get the ID of the last inserted section.
public getInsertId ( ) : integer
Результат integer

getLocaleFieldNames() публичный Метод

Get the list of fields for which data can be localized.
public getLocaleFieldNames ( ) : array
Результат array

getTitles() публичный Метод

Retrieve the IDs and titles of the sections for a journal in an associative array.
public getTitles ( $journalId, $submittableOnly = false ) : array
Результат array

insertCustomSectionOrder() публичный Метод

INTERNAL USE ONLY: Insert a custom section ordering
public insertCustomSectionOrder ( $issueId, $sectionId, $seq )
$issueId int
$sectionId int
$seq int

insertObject() публичный Метод

Insert a new section.
public insertObject ( $section )
$section Section

newDataObject() публичный Метод

Return a new data object.
public newDataObject ( )

resequenceCustomSectionOrders() публичный Метод

Sequentially renumber custom section orderings in their sequence order.
public resequenceCustomSectionOrders ( $issueId )
$issueId int

resequenceSections() публичный Метод

Sequentially renumber sections in their sequence order.
public resequenceSections ( $journalId )
$journalId int

sectionExists() публичный Метод

Check if a section exists with the specified ID.
public sectionExists ( $sectionId, $journalId ) : boolean
$sectionId int
$journalId int
Результат boolean

setDefaultCustomSectionOrders() публичный Метод

Import the current section orders into the specified issue as custom issue orderings.
public setDefaultCustomSectionOrders ( $issueId )
$issueId int

updateCustomSectionOrder() публичный Метод

Update a custom section ordering
public updateCustomSectionOrder ( $issueId, $sectionId, $seq )
$issueId int
$sectionId int
$seq int

updateLocaleFields() публичный Метод

Update the localized fields for this table
public updateLocaleFields ( $section )
$section object

updateObject() публичный Метод

Update an existing section.
public updateObject ( $section )
$section Section

Описание свойств

$cache публичное свойство

public $cache