Class Article
An article class for the CMS.
- Alpha\Model\ActiveRecord
-
Alpha\Model\Article
Copyright:
Copyright (c) 2018, John Collins (founder of Alpha Framework). All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the Alpha Framework nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License: The BSD License
Author: John Collins dev@alphaframework.org
Since: 1.0
Located at Model/Article.php
Methods summary
public
|
|
protected
|
#
after_save_callback( )
After creating a new Article, tokenize the description field to form a set of automated tags and save them. |
protected
|
#
after_loadByAttribute_callback( )
Set up the transient URL attributes for the artcile after it has loaded. |
protected
|
|
public
array
|
#
loadRecentWithLimit( integer $limit )
Gets an array of the IDs of the most recent articles added to the system (by date), from the newest article to the amount specified by the $limit. |
public
string
|
|
public
string
|
|
public
|
#
getAttachmentSecureURL( string $filename )
Generates a secure URL for downloading an attachment file via the ViewAttachment controller. |
public
|
|
public
string
|
|
public
array
|
|
public
boolean
|
|
public
array
|
|
public
|
#
loadContentFromFile( string $filePath )
Loads the content of the ArticleObject from the specified file path. |
public
boolean
|
#
isLoadedFromFile( )
Returns true if the article content was loaded from a .text file, false otherwise. |
public
string
|
#
getContentFileDate( )
Returns the timestamp of when the content .text file for this article was last modified. |
protected
|
Methods inherited from Alpha\Model\ActiveRecord
__wakeup()
,
addProperty()
,
addToCache()
,
backupDatabase()
,
begin()
,
cast()
,
checkDatabaseExists()
,
checkRecordExists()
,
checkRecordTableExists()
,
checkTableExists()
,
checkTableNeedsUpdate()
,
commit()
,
createDatabase()
,
createForeignIndex()
,
createUniqueIndex()
,
delete()
,
deleteAllByAttribute()
,
disconnect()
,
dropDatabase()
,
dropTable()
,
findMissingFields()
,
get()
,
getCount()
,
getCreateTS()
,
getCreatorId()
,
getDataLabel()
,
getDataLabels()
,
getDefaultAttributes()
,
getFriendlyClassName()
,
getHistoryCount()
,
getID()
,
getIndexes()
,
getLastQuery()
,
getMAX()
,
getMaintainHistory()
,
getPersistentAttributes()
,
getPropObject()
,
getRecordClassNames()
,
getTableName()
,
getTaggedAttributes()
,
getTransientAttributes()
,
getUniqueAttributes()
,
getUpdateTS()
,
getUpdatorId()
,
getVersion()
,
getVersionNumber()
,
hasAttribute()
,
isInstalled()
,
isTableOverloaded()
,
isTagged()
,
isTransient()
,
load()
,
loadAll()
,
loadAllByAttribute()
,
loadAllByAttributes()
,
loadAllByDayUpdated()
,
loadAllFieldValuesByAttribute()
,
loadAllOldVersions()
,
loadByAttribute()
,
loadClassDef()
,
loadFromCache()
,
makeHistoryTable()
,
makeTable()
,
markPersistent()
,
markTransient()
,
markUnique()
,
populateFromArray()
,
query()
,
rebuildTable()
,
reload()
,
removeFromCache()
,
rollback()
,
save()
,
saveAttribute()
,
saveHistory()
,
saveRelations()
,
set()
,
setDataLabels()
,
setEnumOptions()
,
setID()
,
setLastQuery()
,
setMaintainHistory()
,
toArray()
,
validate()
Constants summary
string |
TABLE_NAME
The name of the database table for the class. |
#
'Article'
|
Properties summary
protected
|
$title
The article title. |
|
protected
|
$description
The description of the article. |
|
protected
|
$bodyOnload
Optional custom body onload Javascript. |
|
protected
|
$headerContent
Any custom HTML header content (e.g. Javascript) for the article. |
|
protected
|
$content
The article content. |
|
protected
|
$author
The author of the article. |
|
protected
|
$published
A boolean to control whether the artcile is publically accessible or not. |
|
protected
|
$comments
A Relation containing all of the comments on this article. |
|
protected
|
$votes
A Relation containing all of the votes on this article. |
|
protected
|
$tags
A Relation containing all of the tags on this article. |
|
protected
array
|
$taggedAttributes
An array of all of the attributes on this Record which are tagged. |
#
array('title', 'description', 'content')
|
protected
array
|
$dataLabels
An array of data display labels for the class properties. |
#
array('ID' => 'Article ID#', 'title' => 'Title', 'description' => 'Description', 'bodyOnload' => 'Body onload Javascript', 'content' => 'Content', 'headerContent' => 'HTML Header Content', 'author' => 'Author', 'created_ts' => 'Date Added', 'updated_ts' => 'Date of last Update', 'published' => 'Published', 'URL' => 'URL', 'printURL' => 'Printer version URL', 'comments' => 'Comments', 'votes' => 'Votes', 'tags' => 'Tags')
|
protected
string
|
$URL
The URL for this article (transient). |
|
protected
string
|
$printURL
The print URL for this article (transient). |
Properties inherited from Alpha\Model\ActiveRecord
$ID
,
$created_by
,
$created_ts
,
$defaultAttributes
,
$lastQuery
,
$transientAttributes
,
$uniqueAttributes
,
$updated_by
,
$updated_ts
,
$version_num