Method |
Description |
|
ArticleType ( string $p_articleType ) |
An article type is a dynamic table that is created for an article
to allow different publications to display their content in different
ways. |
|
GetArticleTypes ( boolean $p_includeHidden = false ) : array |
Get all article types that currently exist. |
|
IsValidFieldName ( string $p_name ) : boolean |
Static function. Returns TRUE if the given name
is valid as an article type name. |
|
SetTypeFilter ( $p_article_type, $p_filter_value ) : boolean |
Action for setting article type filtering. |
|
__getPreviewTableName ( $p_table ) : string |
Creates a preview table of PreviewNTablename, where N is a unique integer. |
|
commentsEnabled ( ) : boolean |
Return TRUE if comments are enabled for this article type. |
|
create ( ) : boolean |
Create a new Article Type. Creates a new table in the database. |
|
delete ( ) |
Delete the article type. This will delete the entire table
in the database. Not recommended unless there is no article
data in the table. |
|
exists ( ) : boolean |
Return TRUE if the Article Type exists. |
|
getArticlesArray ( ) : array |
For the preview of merge; this grabs an array of the article numbers
for calculating next, previous and current. |
|
getDisplayName ( $p_lang ) : string |
Gets the translation for a given language; default language is the
session language. If no translation is set for that language, we
return the dbTableName. |
|
getDisplayNameLanguageCode ( $p_lang ) : string |
Gets the language code of the current translation language; or none
if there is no translation. |
|
getFilterStatus ( ) : boolean |
Returns whether articles of this type should be filtered out by default at listings. |
|
getMaxSize ( ) : integer |
Gets the maximum size of a article type |
|
getMetadata ( ) : array |
Return an associative array of the metadata in ArticleFieldMetadata. |
|
getNumArticles ( ) : integer |
Returns the number of articles associated with this type. |
|
getPhraseId ( ) : -1 |
Returns the phrase id of the AT. |
|
getPreviewArticleData ( ) : object |
Returns an ArticleData object of the first found article of this type. |
|
getStatus ( ) : string |
Returns 'hidden' if the article type should not be visible,
and 'shown' if it should be. |
|
getTableName ( ) : string |
|
|
getTranslations ( ) : array |
Parses m_metadata for phrase_ids and returns an array of language_id => translation_text |
|
getTypeName ( ) : string |
|
|
getUserDefinedColumns ( $p_fieldName = null, $p_selectHidden = true, $p_skipCache = false ) : array |
Return an array of ArticleTypeField objects. |
|
merge ( $p_src, $p_dest, $p_rules ) : boolean |
Does the merge or a preview of the merge. |
|
rename ( $p_newName ) |
Rename the article type. This will move the entire table in the
database and update ArticleTypeMetadata. Usually, one wants to
just rename the Display Name, which is done via SetDisplayName |
|
setCommentsEnabled ( boolean $p_value ) |
Return TRUE if comments are enabled for this article type. |
|
setName ( integer $p_languageId, string $p_value ) : boolean |
Set the type name for the given language. A new entry in
the database will be created if the language does not exist. |
|
setStatus ( $p_status ) |
Sets whether the article type should be visible
or hidden. |
|
translationExists ( $p_languageId ) |
A quick lookup to see if the current language was already translated
for this article type: used by delete and update in setName. |
|