• Home
• ArticleTypeField

PHP Class ArticleTypeField

ファイルを表示 Open project: sourcefabric/newscoop Class Usage Examples

Public Properties

Property	Type	Description
$m_columnNames
$m_dbTableName
$m_keyColumnNames

Public Methods

Method	Description
DatabaseTypes ( $p_numericDigits = null, $p_numericPrecision = null ) : array	Returns an array of valid field data types.
FetchFields ( $p_name = null, $p_articleType = null, $p_dataType = null, $p_negateName = false, $p_negateArticleType = false, $p_negateDataType = false, $p_selectHidden = true, $p_skipCache = false ) : array	Returns an array of fields from all article types that match the given conditions.
SetFieldColor ( $p_article_type, $p_field_name, $p_color_value )
TypesConvertibleFrom ( $p_type )
TypesConvertibleTo ( $p_type ) : array	Returns an array of types compatible with the given field type.
VerboseTypeName ( $p_typeName, $p_languageId = 1, $p_rootTopicId = null ) : string	Get a human-readable representation of the column type.
__construct ( $p_articleTypeName = null, $p_fieldName = null )
create ( string $p_type = null, array $p_params = [] )	Create a column in the table.
delete ( )	Deletes the current article type field.
fetch ( array $p_recordSet = null, $p_forceExists = false ) : boolean	Fetch a single record from the database for the given key.
getArticleType ( ) : string	Returns the article type name.
getColor ( )
getConvertibleFromTypes ( )
getConvertibleToTypes ( )
getDefaultColor ( )
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.
getFilter ( ) : boolean	Returns whether articles of this type should be filtered out by default at listings.
getGenericType ( )	fn getType
getMaxSize ( ) : integer	Gets the maximum size of a article type
getMetadata ( ) : array	Return an associative array of the metadata in ArticleFieldMetadata.
getName ( ) : string
getNextOrder ( ) : integer	Returns the highest weight + 1 or 0 for the starter
getOrders ( ) : array	Get the ordering of all fields; initially, a field has a field_weight of NULL when it is created. if we discover that a field has a field weight of NULL, we give it the MAX+1 field_weight. Returns a NUMERIC array of ORDER => FIELDNAME.
getPhraseId ( ) : -1
getPrintName ( ) : string
getStatus ( ) : string	Returns the is_hidden status of a field. Returns 'hidden' or 'shown'.
getTopicTypeRootElement ( ) : string
getTranslations ( ) : array	Returns an array of translation strings for the field name.
getType ( ) : string
getVerboseTypeName ( $p_languageId = 1 )	fn VerboseTypeName
isContent ( ) : boolean	Returns true if the current field is a content field.
isConvertibleFrom ( $p_type ) : boolean	Returns true if the given type can be converted to the current field type.
isConvertibleTo ( $p_type )
isHidden ( ) : boolean	Returns true if the current field is hidden.
rename ( $p_newName )	Rename the article type field.
reorder ( $move )	Reorders the current field; accepts either "up" or "down"
setColor ( $p_color )
setFilter ( $p_filter ) : boolean	Sets whether articles of this type should be filtered out by default at listings.
setIsContent ( $p_isContent ) : boolean	Sets the content flag. Returns true on success, false otherwise.
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 did not exist.
setOrders ( $orderArray )	Saves the ordering of all the fields. Accepts an NUMERIC array of ORDERRANK => FIELDNAME. (see getOrders)
setShowInEditor ( $p_showInEditor ) : integer	Sets the int for where to show the field
setStatus ( $p_status )
setType ( $p_type )	Changes the type of the field
showInEditor ( ) : integer	Returns int for where to show the field
translationExists ( $p_languageId )	Quick lookup to see if the current language is already translated for this article type: used by delete and update in setName returns 0 if no translation or the phrase_id if there is one.

Method Details

Property Details