[pLog-svn] r1658 - in plog/trunk/class: . template view view/admin
oscar at devel.plogworld.net
oscar at devel.plogworld.net
Wed Mar 30 21:02:51 GMT 2005
Author: oscar
Date: 2005-03-30 21:02:50 +0000 (Wed, 30 Mar 2005)
New Revision: 1658
Modified:
plog/trunk/class/Doxyfile
plog/trunk/class/template/cachecontrol.class.php
plog/trunk/class/template/templateservice.class.php
plog/trunk/class/view/admin/adminadduserview.class.php
plog/trunk/class/view/admin/adminarticlecategorieslistview.class.php
plog/trunk/class/view/admin/adminarticlecommentslistview.class.php
plog/trunk/class/view/admin/adminarticlereferrersview.class.php
plog/trunk/class/view/admin/adminarticletrackbackslistview.class.php
plog/trunk/class/view/admin/adminblogsettingsview.class.php
plog/trunk/class/view/admin/adminblogtemplatechooserview.class.php
plog/trunk/class/view/admin/adminblogtemplatesetslistview.class.php
plog/trunk/class/view/admin/adminbloguserslistview.class.php
plog/trunk/class/view/admin/admincreateblogview.class.php
plog/trunk/class/view/admin/admincustomfieldslistview.class.php
plog/trunk/class/view/admin/admindashboardview.class.php
plog/trunk/class/view/admin/admindefaultview.class.php
plog/trunk/class/view/admin/admineditlinkview.class.php
plog/trunk/class/view/admin/admineditpostview.class.php
plog/trunk/class/view/admin/admineditresourcealbumview.class.php
plog/trunk/class/view/admin/admineditresourceview.class.php
plog/trunk/class/view/admin/admineditsiteblogview.class.php
plog/trunk/class/view/admin/admineditsiteuserview.class.php
plog/trunk/class/view/admin/adminerrorview.class.php
plog/trunk/class/view/admin/adminglobalsettingslistview.class.php
plog/trunk/class/view/admin/adminlinkcategorieslistview.class.php
plog/trunk/class/view/admin/adminlinkslistview.class.php
plog/trunk/class/view/admin/adminloginview.class.php
plog/trunk/class/view/admin/adminmessageview.class.php
plog/trunk/class/view/admin/adminnewalbumview.class.php
plog/trunk/class/view/admin/adminnewlinkview.class.php
plog/trunk/class/view/admin/adminnewpostview.class.php
plog/trunk/class/view/admin/adminnewresourceview.class.php
plog/trunk/class/view/admin/adminplugintemplatedview.class.php
plog/trunk/class/view/admin/adminpostslistview.class.php
plog/trunk/class/view/admin/adminresourcealbumslistview.class.php
plog/trunk/class/view/admin/adminresourceslistview.class.php
plog/trunk/class/view/admin/adminsimpleerrorview.class.php
plog/trunk/class/view/admin/adminsimplemessageview.class.php
plog/trunk/class/view/admin/adminsimpleresourceslistview.class.php
plog/trunk/class/view/admin/adminsiteblogslistview.class.php
plog/trunk/class/view/admin/adminsitelocaleslistview.class.php
plog/trunk/class/view/admin/adminsitetemplateslistview.class.php
plog/trunk/class/view/admin/adminsiteuserslistview.class.php
plog/trunk/class/view/admin/admintemplatedview.class.php
plog/trunk/class/view/admin/adminuserpictureselectview.class.php
plog/trunk/class/view/admin/adminuserprofileview.class.php
plog/trunk/class/view/admin/adminview.class.php
plog/trunk/class/view/admin/adminxmlview.class.php
plog/trunk/class/view/blogtemplatedview.class.php
plog/trunk/class/view/blogview.class.php
plog/trunk/class/view/defaultview.class.php
plog/trunk/class/view/errorview.class.php
plog/trunk/class/view/plugintemplatedview.class.php
plog/trunk/class/view/resourceserverview.class.php
plog/trunk/class/view/rssview.class.php
plog/trunk/class/view/smartyview.class.php
plog/trunk/class/view/templateview.class.php
plog/trunk/class/view/view.class.php
plog/trunk/class/view/viewarticleview.class.php
Log:
documentation for the "view" module... come on, only a few more modules to go!!!
Modified: plog/trunk/class/Doxyfile
===================================================================
--- plog/trunk/class/Doxyfile 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/Doxyfile 2005-03-30 21:02:50 UTC (rev 1658)
@@ -416,7 +416,7 @@
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = object/ dao/ logger/ gallery/ locale/ config/ file/ database/ data/forms security/ xml/ controller/ mail/ bayesian/ misc/ net/ data/
+INPUT = object/ dao/ logger/ gallery/ locale/ config/ file/ database/ data/forms security/ xml/ controller/ mail/ bayesian/ misc/ net/ data/ view/
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
Modified: plog/trunk/class/template/cachecontrol.class.php
===================================================================
--- plog/trunk/class/template/cachecontrol.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/template/cachecontrol.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,15 +1,12 @@
<?php
- /**
- * @package template
- */
-
-
include_once( PLOG_CLASS_PATH."class/object/object.class.php" );
include_once( PLOG_CLASS_PATH."class/template/cachedtemplate.class.php" );
include_once( PLOG_CLASS_PATH."class/dao/blogs.class.php" );
/**
+ * \ingroup Template
+ *
* Allows to control Smarty's caches in an easier way
*/
class CacheControl extends Object
@@ -42,6 +39,7 @@
* This method is also used when using CacheControl::resetAllCaches()
*
* @see resetAllCaches
+ * @static
*/
function clearSummaryCache()
{
@@ -62,6 +60,7 @@
/**
* alias for clearSummaryCache
* @see clearSummaryCache
+ * @static
*/
function resetSummaryCache()
{
@@ -74,6 +73,7 @@
* @param blogId The id of the blog whose cache we'd like to reset
* @param resetSummary whether the summary cache should also be cleaned up,
* enabled by default
+ * @static
*/
function resetBlogCache( $blogId, $resetSummary = true )
{
@@ -99,4 +99,4 @@
return true;
}
}
-?>
+?>
\ No newline at end of file
Modified: plog/trunk/class/template/templateservice.class.php
===================================================================
--- plog/trunk/class/template/templateservice.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/template/templateservice.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,10 +1,5 @@
<?php
- /**
- * @package template
- */
-
-
include_once( PLOG_CLASS_PATH.'class/object/object.class.php' );
include_once( PLOG_CLASS_PATH.'class/template/template.class.php' );
include_once( PLOG_CLASS_PATH.'class/config/config.class.php' );
Modified: plog/trunk/class/view/admin/adminadduserview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminadduserview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminadduserview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -4,7 +4,11 @@
include_once( PLOG_CLASS_PATH.'class/dao/blogs.class.php' );
include_once( PLOG_CLASS_PATH.'class/dao/userstatus.class.php' );
- /**
+
+ /**
+ * \ingroup View
+ * @private
+ *
* shows a special view to add a user to the site
*/
class AdminAddUserView extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/adminarticlecategorieslistview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminarticlecategorieslistview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminarticlecategorieslistview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,15 +1,13 @@
<?php
- /**
- * @package admin
- */
-
-
include_once( PLOG_CLASS_PATH."class/view/admin/admintemplatedview.class.php" );
include_once( PLOG_CLASS_PATH."class/dao/articlecategories.class.php" );
include_once( PLOG_CLASS_PATH."class/data/pager/pager.class.php" );
/**
+ * \ingroup View
+ * @private
+ *
* Action that shows a form to add a link for the blogroll feature
*/
class AdminArticleCategoriesListView extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/adminarticlecommentslistview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminarticlecommentslistview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminarticlecommentslistview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -6,7 +6,10 @@
include_once( PLOG_CLASS_PATH."class/dao/articles.class.php" );
include_once( PLOG_CLASS_PATH."class/data/pager/pager.class.php" );
- /**
+ /**
+ * \ingroup View
+ * @private
+ *
* shows a list of the comments
*/
class AdminArticleCommentsListView extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/adminarticlereferrersview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminarticlereferrersview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminarticlereferrersview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -4,7 +4,10 @@
include_once( PLOG_CLASS_PATH."class/dao/referers.class.php" );
include_once( PLOG_CLASS_PATH."class/data/pager/pager.class.php" );
- /**
+ /**
+ * \ingroup View
+ * @private
+ *
* shows a list of the referrers collected by this site for a particular post
*/
class AdminArticleReferrersView extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/adminarticletrackbackslistview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminarticletrackbackslistview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminarticletrackbackslistview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -6,7 +6,10 @@
include_once( PLOG_CLASS_PATH."class/dao/trackbacks.class.php" );
include_once( PLOG_CLASS_PATH."class/data/pager/pager.class.php" );
- /**
+ /**
+ * \ingroup View
+ * @private
+ *
* shows a list with all the trackbacks received for a certain article
*/
class AdminArticleTrackbacksListView extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/adminblogsettingsview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminblogsettingsview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminblogsettingsview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -4,7 +4,10 @@
include_once( PLOG_CLASS_PATH."class/template/templatesets/templatesets.class.php" );
include_once( PLOG_CLASS_PATH."class/locale/locales.class.php" );
- /**
+ /**
+ * \ingroup View
+ * @private
+ *
* displays the blog settings
*/
class AdminBlogSettingsView extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/adminblogtemplatechooserview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminblogtemplatechooserview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminblogtemplatechooserview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -3,7 +3,10 @@
include_once( PLOG_CLASS_PATH."class/view/admin/admintemplatedview.class.php" );
include_once( PLOG_CLASS_PATH."class/template/templatesets/templatesets.class.php" );
- /**
+ /**
+ * \ingroup View
+ * @private
+ *
* shows a list with all the template sets that have been added to this blog
*/
class AdminBlogTemplateChooserView extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/adminblogtemplatesetslistview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminblogtemplatesetslistview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminblogtemplatesetslistview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -3,7 +3,10 @@
include_once( PLOG_CLASS_PATH."class/view/admin/admintemplatedview.class.php" );
include_once( PLOG_CLASS_PATH."class/template/templatesets/templatesets.class.php" );
- /**
+ /**
+ * \ingroup View
+ * @private
+ *
* shows a list with all the template sets that have been added to this blog
*/
class AdminBlogTemplateSetsListView extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/adminbloguserslistview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminbloguserslistview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminbloguserslistview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -3,7 +3,10 @@
include_once( PLOG_CLASS_PATH."class/view/admin/admintemplatedview.class.php" );
include_once( PLOG_CLASS_PATH."class/dao/users.class.php" );
- /**
+ /**
+ * \ingroup View
+ * @private
+ *
* shows a list with the users in the blog
*/
class AdminBlogUsersListView extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/admincreateblogview.class.php
===================================================================
--- plog/trunk/class/view/admin/admincreateblogview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/admincreateblogview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -2,7 +2,11 @@
include_once( PLOG_CLASS_PATH."class/view/admin/admintemplatedview.class.php" );
include_once( PLOG_CLASS_PATH."class/dao/users.class.php" );
-
+
+ /**
+ * \ingroup View
+ * @private
+ */
class AdminCreateBlogView extends AdminTemplatedView
{
Modified: plog/trunk/class/view/admin/admincustomfieldslistview.class.php
===================================================================
--- plog/trunk/class/view/admin/admincustomfieldslistview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/admincustomfieldslistview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -4,11 +4,12 @@
include_once( PLOG_CLASS_PATH."class/dao/customfields/customfields.class.php" );
include_once( PLOG_CLASS_PATH."class/data/pager/pager.class.php" );
- /**
+ /**
+ * \ingroup View
+ * @private
+ *
* displays the list of custom fields that have been added
* to the blog, or an empty list of none has been added!
- *
- * @package admin
*/
class AdminCustomFieldsListView extends AdminTemplatedView
{
Modified: plog/trunk/class/view/admin/admindashboardview.class.php
===================================================================
--- plog/trunk/class/view/admin/admindashboardview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/admindashboardview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,9 +1,5 @@
<?php
- /**
- * @package admin
- */
-
include_once( PLOG_CLASS_PATH."class/view/view.class.php" );
include_once( PLOG_CLASS_PATH."class/template/templateservice.class.php" );
include_once( PLOG_CLASS_PATH."class/template/menu/menurenderer.class.php" );
@@ -18,6 +14,9 @@
define( "DASHBOARD_MAX_RECENT_ITEMS", 5 );
/**
+ * \ingroup View
+ * @private
+ *
* Generates the view with the summary
*/
class AdminDashboardView extends View
Modified: plog/trunk/class/view/admin/admindefaultview.class.php
===================================================================
--- plog/trunk/class/view/admin/admindefaultview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/admindefaultview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -14,9 +14,13 @@
define( "DEFAULTADMIN_TEMPLATE", "default" );
/**
- * Sample implementation of the view, which goes attached to SampleAction
+ * \ingroup View
+ * @private
+ *
+ * Default view
*/
- class AdminDefaultView extends View {
+ class AdminDefaultView extends View
+ {
/**
* This initializes the class, but normally we'll only have to initialize the parent
Modified: plog/trunk/class/view/admin/admineditlinkview.class.php
===================================================================
--- plog/trunk/class/view/admin/admineditlinkview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/admineditlinkview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -2,6 +2,10 @@
include_once( PLOG_CLASS_PATH."class/view/admin/adminnewlinkview.class.php" );
+ /**
+ * \ingroup View
+ * @private
+ */
class AdminEditLinkView extends AdminNewLinkView
{
Modified: plog/trunk/class/view/admin/admineditpostview.class.php
===================================================================
--- plog/trunk/class/view/admin/admineditpostview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/admineditpostview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -3,7 +3,10 @@
include_once( PLOG_CLASS_PATH."class/view/admin/adminnewpostview.class.php" );
include_once( PLOG_CLASS_PATH."class/dao/articlenotifications.class.php" );
- /**
+ /**
+ * \ingroup View
+ * @private
+ *
* shows the view that will allow to edit an article
*/
class AdminEditPostView extends AdminNewPostView
Modified: plog/trunk/class/view/admin/admineditresourcealbumview.class.php
===================================================================
--- plog/trunk/class/view/admin/admineditresourcealbumview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/admineditresourcealbumview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -3,7 +3,10 @@
include_once( PLOG_CLASS_PATH."class/view/admin/admintemplatedview.class.php" );
include_once( PLOG_CLASS_PATH."class/gallery/dao/galleryalbums.class.php" );
- /**
+ /**
+ * \ingroup View
+ * @private
+ *
* shows the view that allows to edit an album
*/
class AdminEditResourceAlbumView extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/admineditresourceview.class.php
===================================================================
--- plog/trunk/class/view/admin/admineditresourceview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/admineditresourceview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -4,7 +4,10 @@
include_once( PLOG_CLASS_PATH."class/gallery/dao/galleryalbums.class.php" );
include_once( PLOG_CLASS_PATH."class/view/admin/adminresourceslistview.class.php" );
- /**
+ /**
+ * \ingroup View
+ * @private
+ *
* shows the view that allows to see more information of a resource
*/
class AdminEditResourceView extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/admineditsiteblogview.class.php
===================================================================
--- plog/trunk/class/view/admin/admineditsiteblogview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/admineditsiteblogview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -5,7 +5,10 @@
include_once( PLOG_CLASS_PATH.'class/template/templatesets/templatesets.class.php' );
include_once( PLOG_CLASS_PATH.'class/dao/blogstatus.class.php' );
- /**
+ /**
+ * \ingroup View
+ * @private
+ *
* shows the view to edit a blog from the site
*/
class AdminEditSiteBlogView extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/admineditsiteuserview.class.php
===================================================================
--- plog/trunk/class/view/admin/admineditsiteuserview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/admineditsiteuserview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -5,7 +5,10 @@
include_once( PLOG_CLASS_PATH.'class/dao/users.class.php' );
include_once( PLOG_CLASS_PATH.'class/dao/userstatus.class.php' );
- /**
+ /**
+ * \ingroup View
+ * @private
+ *
* shows the view to edit a user
*/
class AdminEditSiteUserView extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/adminerrorview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminerrorview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminerrorview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,13 +1,11 @@
<?php
- /**
- * @package admin
- */
-
-
include_once( PLOG_CLASS_PATH."class/view/admin/admintemplatedview.class.php" );
/**
+ * \ingroup View
+ * @private
+ *
* Shows an error message to the user
*/
class AdminErrorView extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/adminglobalsettingslistview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminglobalsettingslistview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminglobalsettingslistview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -4,7 +4,10 @@
include_once( PLOG_CLASS_PATH."class/config/config.class.php" );
include_once( PLOG_CLASS_PATH."class/dao/blogs.class.php" );
- /**
+ /**
+ * \ingroup View
+ * @private
+ *
* shows a list with all the global parameters
*/
class AdminGlobalSettingsListView extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/adminlinkcategorieslistview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminlinkcategorieslistview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminlinkcategorieslistview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -4,7 +4,10 @@
include_once( PLOG_CLASS_PATH."class/dao/mylinkscategories.class.php" );
include_once( PLOG_CLASS_PATH."class/data/pager/pager.class.php" );
- /**
+ /**
+ * \ingroup View
+ * @private
+ *
* shows a list of link categories
*/
class AdminLinkCategoriesListView extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/adminlinkslistview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminlinkslistview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminlinkslistview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,16 +1,14 @@
<?php
- /**
- * @package admin
- */
-
-
include_once( PLOG_CLASS_PATH."class/view/admin/admintemplatedview.class.php" );
include_once( PLOG_CLASS_PATH."class/dao/mylinks.class.php" );
include_once( PLOG_CLASS_PATH."class/dao/mylinkscategories.class.php" );
include_once( PLOG_CLASS_PATH."class/data/pager/pager.class.php" );
/**
+ * \ingroup View
+ * @private
+ *
* Shows a list with all the links in the site, also filtering by category
*/
class AdminLinksListview extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/adminloginview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminloginview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminloginview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,9 +1,5 @@
<?php
- /**
- * @package admin
- */
-
include_once( PLOG_CLASS_PATH."class/view/view.class.php" );
include_once( PLOG_CLASS_PATH."class/template/templateservice.class.php" );
include_once( PLOG_CLASS_PATH."class/template/template.class.php" );
@@ -12,6 +8,9 @@
define( "ADMINLOGIN_TEMPLATE", "chooseblog" );
/**
+ * \ingroup View
+ * @private
+ *
* Generates the view shown just after filling in the login form
*/
class AdminLoginView extends View
Modified: plog/trunk/class/view/admin/adminmessageview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminmessageview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminmessageview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,13 +1,11 @@
<?php
- /**
- * @package admin
- */
-
-
include_once( PLOG_CLASS_PATH."class/view/admin/admintemplatedview.class.php" );
/**
+ * \ingroup View
+ * @private
+ *
* Shows a message to the user
*/
class AdminMessageView extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/adminnewalbumview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminnewalbumview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminnewalbumview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -3,6 +3,10 @@
include_once( PLOG_CLASS_PATH."class/view/admin/admintemplatedview.class.php" );
include_once( PLOG_CLASS_PATH."class/gallery/dao/galleryalbums.class.php" );
+ /**
+ * \ingroup View
+ * @private
+ */
class AdminNewAlbumView extends AdminTemplatedView
{
Modified: plog/trunk/class/view/admin/adminnewlinkview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminnewlinkview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminnewlinkview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,15 +1,13 @@
<?php
- /**
- * @package admin
- */
-
-
include_once( PLOG_CLASS_PATH."class/view/admin/admintemplatedview.class.php" );
include_once( PLOG_CLASS_PATH."class/dao/mylinkscategories.class.php" );
/**
+ * \ingroup View
+ * @private
+ *
* shows the view to add a new link
*/
class AdminNewLinkView extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/adminnewpostview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminnewpostview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminnewpostview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -5,7 +5,11 @@
include_once( PLOG_CLASS_PATH."class/dao/articlecategories.class.php" );
include_once( PLOG_CLASS_PATH."class/dao/customfields/customfields.class.php" );
include_once( PLOG_CLASS_PATH."class/config/config.class.php" );
-
+
+ /**
+ * \ingroup View
+ * @private
+ */
class AdminNewPostView extends AdminTemplatedView
{
Modified: plog/trunk/class/view/admin/adminnewresourceview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminnewresourceview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminnewresourceview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -2,7 +2,10 @@
include_once( PLOG_CLASS_PATH."class/view/admin/admintemplatedview.class.php" );
include_once( PLOG_CLASS_PATH."class/gallery/dao/galleryalbums.class.php" );
-
+ /**
+ * \ingroup View
+ * @private
+ */
class AdminNewResourceView extends AdminTemplatedView
{
Modified: plog/trunk/class/view/admin/adminplugintemplatedview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminplugintemplatedview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminplugintemplatedview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,14 +1,11 @@
<?php
- /**
- * @package admin
- */
-
-
include_once( PLOG_CLASS_PATH.'class/view/admin/adminview.class.php' );
include_once( PLOG_CLASS_PATH.'class/template/templateservice.class.php' );
/**
+ * \ingroup View
+ *
* Loads template files from the plugins/ folder
*/
class AdminPluginTemplatedView extends AdminView
Modified: plog/trunk/class/view/admin/adminpostslistview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminpostslistview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminpostslistview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -8,6 +8,9 @@
include_once( PLOG_CLASS_PATH."class/data/pager/pager.class.php" );
/**
+ * \ingroup View
+ * @private
+ *
* shows a list of posts
*/
class AdminPostsListView extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/adminresourcealbumslistview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminresourcealbumslistview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminresourcealbumslistview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -2,7 +2,10 @@
include_once( PLOG_CLASS_PATH."class/view/admin/admintemplatedview.class.php" );
include_once( PLOG_CLASS_PATH."class/gallery/dao/galleryalbums.class.php" );
-
+ /**
+ * \ingroup View
+ * @private
+ */
class AdminResourceAlbumsListView extends AdminTemplatedView
{
var $_albumId;
Modified: plog/trunk/class/view/admin/adminresourceslistview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminresourceslistview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminresourceslistview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -8,7 +8,10 @@
define( "ROOT_ALBUM_ID", 0 );
- /**
+ /**
+ * \ingroup View
+ * @private
+ *
* lists the resources
*/
class AdminResourcesListView extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/adminsimpleerrorview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminsimpleerrorview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminsimpleerrorview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,16 +1,14 @@
<?php
- /**
- * @package admin
- */
-
-
include_once( PLOG_CLASS_PATH."class/view/view.class.php" );
include_once( PLOG_CLASS_PATH."class/locale/locales.class.php" );
define( "ADMINSIMPLEERROR_TEMPLATE", "simpleerror" );
/**
+ * \ingroup View
+ * @private
+ *
* The ErrorView class takes care of showing error messages
*/
class AdminSimpleErrorView extends View
Modified: plog/trunk/class/view/admin/adminsimplemessageview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminsimplemessageview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminsimplemessageview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,16 +1,14 @@
<?php
- /**
- * @package admin
- */
-
-
include_once( PLOG_CLASS_PATH."class/view/view.class.php" );
include_once( PLOG_CLASS_PATH."class/locale/locales.class.php" );
define( "ADMINSIMPLEMESSAGE_TEMPLATE", "simplemessage" );
/**
+ * \ingroup View
+ * @private
+ *
* The SimpleMessageView class shows messages, but the template does not
* include the header or the footer.
*/
Modified: plog/trunk/class/view/admin/adminsimpleresourceslistview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminsimpleresourceslistview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminsimpleresourceslistview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -3,6 +3,10 @@
include_once( PLOG_CLASS_PATH."class/view/admin/adminresourceslistview.class.php" );
include_once( PLOG_CLASS_PATH."class/data/stringutils.class.php" );
+ /**
+ * \ingroup View
+ * @private
+ */
class AdminSimpleResourcesListView extends AdminResourcesListView
{
Modified: plog/trunk/class/view/admin/adminsiteblogslistview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminsiteblogslistview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminsiteblogslistview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -4,7 +4,10 @@
include_once( PLOG_CLASS_PATH."class/data/pager/pager.class.php" );
include_once( PLOG_CLASS_PATH."class/dao/blogs.class.php" );
- /**
+ /**
+ * \ingroup View
+ * @private
+ *
* shows a list with all the blogs from the site
*/
class AdminSiteBlogsListView extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/adminsitelocaleslistview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminsitelocaleslistview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminsitelocaleslistview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -2,7 +2,11 @@
include_once( PLOG_CLASS_PATH."class/view/admin/admintemplatedview.class.php" );
include_once( PLOG_CLASS_PATH."class/locale/locales.class.php" );
-
+
+ /**
+ * \ingroup View
+ * @private
+ */
class AdminSiteLocalesListView extends AdminTemplatedView
{
Modified: plog/trunk/class/view/admin/adminsitetemplateslistview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminsitetemplateslistview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminsitetemplateslistview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -2,7 +2,11 @@
include_once( PLOG_CLASS_PATH."class/view/admin/admintemplatedview.class.php" );
include_once( PLOG_CLASS_PATH."class/template/templatesets/templatesets.class.php" );
-
+
+ /**
+ * \ingroup View
+ * @private
+ */
class AdminSiteTemplatesListView extends AdminTemplatedView
{
Modified: plog/trunk/class/view/admin/adminsiteuserslistview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminsiteuserslistview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminsiteuserslistview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -4,7 +4,10 @@
include_once( PLOG_CLASS_PATH."class/dao/users.class.php" );
include_once( PLOG_CLASS_PATH."class/data/pager/pager.class.php" );
- /**
+ /**
+ * \ingroup View
+ * @private
+ *
* shows a list with the users in the blog
*/
class AdminSiteUsersListView extends AdminTemplatedView
Modified: plog/trunk/class/view/admin/admintemplatedview.class.php
===================================================================
--- plog/trunk/class/view/admin/admintemplatedview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/admintemplatedview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,14 +1,12 @@
<?php
- /**
- * @package admin
- */
-
-
include_once( PLOG_CLASS_PATH."class/view/admin/adminview.class.php" );
/**
+ * \ingroup View
+ * @private
+ *
* Generic view to be used by those classes that do not really need a customized view...
* which is almost all of them. This one simply loads a template from disk. The name of the template
* must be the parameter from disk.
Modified: plog/trunk/class/view/admin/adminuserpictureselectview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminuserpictureselectview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminuserpictureselectview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -4,7 +4,10 @@
include_once( PLOG_CLASS_PATH."class/gallery/dao/galleryresource.class.php" );
include_once( PLOG_CLASS_PATH."class/gallery/dao/galleryalbums.class.php" );
- /**
+ /**
+ * \ingroup View
+ * @private
+ *
* we can extend from AdminResourcesListView and we will save a lot of code...
*/
class AdminUserPictureSelectView extends AdminResourcesListView
Modified: plog/trunk/class/view/admin/adminuserprofileview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminuserprofileview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminuserprofileview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -2,6 +2,10 @@
include_once( PLOG_CLASS_PATH."class/view/admin/admintemplatedview.class.php" );
+ /**
+ * \ingroup View
+ * @private
+ */
class AdminUserProfileView extends AdminTemplatedView
{
var $_userInfo;
Modified: plog/trunk/class/view/admin/adminview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,10 +1,5 @@
<?php
- /**
- * @package admin
- */
-
-
include_once( PLOG_CLASS_PATH.'class/view/view.class.php' );
include_once( PLOG_CLASS_PATH.'class/template/templateservice.class.php' );
include_once( PLOG_CLASS_PATH.'class/net/requestgenerator.class.php' );
@@ -12,8 +7,19 @@
include_once( PLOG_CLASS_PATH.'class/template/menu/menurenderer.class.php' );
/**
+ * \ingroup View
+ *
* Extends the View class to add some commont methods and attributes that will be shared
- * by all the views of the administrative interface
+ * by all the views of the administrative interface. This is the main basic view that all
+ * view classes from the admin interface should extend.
+ *
+ * This class has support for loading templates from the templates/admin folder, as well as
+ * being able to use locales and even to throw events if needed.
+ *
+ * The AdminView::render() method implements some logic of its own so it must be called
+ * at some point in our custom classes extending AdminView.
+ *
+ * As of pLog 1.0, AdminView classes do not have support for cached views.
*/
class AdminView extends View
{
@@ -25,6 +31,8 @@
/**
* Calls the parent constructor and initializes the template service used
* to fetch the templates
+ *
+ * @param blogInfo A valid BlogInfo object
*/
function AdminView( $blogInfo )
{
@@ -72,7 +80,7 @@
}
/**
- * call the View::render() method...
+ * call the View::render() method.
*/
function render()
{
Modified: plog/trunk/class/view/admin/adminxmlview.class.php
===================================================================
--- plog/trunk/class/view/admin/adminxmlview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/admin/adminxmlview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,12 +1,11 @@
<?php
- /**
- * @package admin
- */
-
-
include_once( PLOG_CLASS_PATH."class/view/admin/adminview.class.php" );
+ /**
+ * \ingroup View
+ * @private
+ */
class AdminXmlView extends AdminView
{
var $_templateName;
Modified: plog/trunk/class/view/blogtemplatedview.class.php
===================================================================
--- plog/trunk/class/view/blogtemplatedview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/blogtemplatedview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,13 +1,11 @@
<?php
- /**
- * @package view
- */
-
-
include_once( PLOG_CLASS_PATH."class/view/blogview.class.php" );
/**
+ * \ingroup View
+ * @private
+ *
* Generic view for those actions that do not need special customizations
* in the view (like most of them :P)
*/
Modified: plog/trunk/class/view/blogview.class.php
===================================================================
--- plog/trunk/class/view/blogview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/blogview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,10 +1,5 @@
<?php
- /**
- * @package view
- */
-
-
include_once( PLOG_CLASS_PATH.'class/view/smartyview.class.php' );
include_once( PLOG_CLASS_PATH.'class/dao/bloginfo.class.php' );
include_once( PLOG_CLASS_PATH.'class/data/plogcalendar.class.php' );
@@ -19,9 +14,11 @@
include_once( PLOG_CLASS_PATH.'class/xml/rssparser/rssparser.class.php' );
/**
- * Extends the original 'View' class to provide support for common operations, for example
+ * \ingroup View
+ *
+ * Extends the SmartyView class to provide support for common operations, for example
* to automatically add support for locale. It is recommended
- * that all classes that generate a view extend from this unless strictly necessary
+ * that all classes that generate a view extend from this unless strictly necessary.
*/
class BlogView extends SmartyView
{
@@ -51,6 +48,7 @@
*
* @param year
* @param month
+ * @private
*/
function generateCalendar( $year = null, $month = null )
{
@@ -174,7 +172,7 @@
}
/**
- * render the view... in this casae, we leave it all up to the child classes to reimplement
+ * Sets some in this case, we leave it all up to the child classes to reimplement
* this and by default call View::render()
*
* @returns always true
Modified: plog/trunk/class/view/defaultview.class.php
===================================================================
--- plog/trunk/class/view/defaultview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/defaultview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,16 +1,14 @@
<?php
- /**
- * @package view
- */
-
-
include_once( PLOG_CLASS_PATH."class/view/blogview.class.php" );
include_once( PLOG_CLASS_PATH."class/data/textfilter.class.php" );
define( "MAIN_TEMPLATE", "main" );
/**
+ * @private
+ * \ingroup View
+ *
* Main default view that simply shows all the posts in the database
* of a blog
*/
Modified: plog/trunk/class/view/errorview.class.php
===================================================================
--- plog/trunk/class/view/errorview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/errorview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,16 +1,14 @@
<?php
- /**
- * @package view
- */
-
-
include_once( PLOG_CLASS_PATH."class/view/blogview.class.php" );
define( "ERROR_TEMPLATE", "error" );
/**
- * The ErrorView class takes care of showing error messages
+ * \ingroup View
+ *
+ * The ErrorView class takes care of showing error messages. Use this view whenever you need to
+ * show an error message in the public side of the blog.
*/
class ErrorView extends BlogView
{
@@ -37,6 +35,9 @@
return( parent::setErrorMessage( $message ));
}
+ /**
+ * renders the error message
+ */
function render()
{
if(!empty($this->_message))
Modified: plog/trunk/class/view/plugintemplatedview.class.php
===================================================================
--- plog/trunk/class/view/plugintemplatedview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/plugintemplatedview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,17 +1,19 @@
<?php
- /**
- * @package view
- */
-
-
include_once( PLOG_CLASS_PATH."class/view/blogview.class.php" );
include_once( PLOG_CLASS_PATH."class/template/templateservice.class.php" );
include_once( PLOG_CLASS_PATH."class/template/templatesets/templatesets.class.php" );
include_once( PLOG_CLASS_PATH."class/template/templatesets/templatesetstorage.class.php" );
/**
- * Loads template files from the plugins/ folder
+ * \ingroup View
+ *
+ * Loads template files from the plugins/ folder. This is the view class that plugins should use when
+ * creating their own views. It works in exactly the same way as the BlogView class but it knows how
+ * to load custom templates as provided by templates, which are located under
+ * plugins/plugin-name/templates/ instead of templates/template-set-name/
+ *
+ * @see BlogView
*/
class PluginTemplatedView extends BlogView
{
Modified: plog/trunk/class/view/resourceserverview.class.php
===================================================================
--- plog/trunk/class/view/resourceserverview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/resourceserverview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,10 +1,5 @@
<?php
- /**
- * @package view
- */
-
-
include_once( PLOG_CLASS_PATH.'class/view/view.class.php' );
include_once( PLOG_CLASS_PATH.'class/net/http/httpcache.class.php' );
@@ -12,7 +7,11 @@
define( 'RESOURCE_VIEW_MODE_DEFAULT', '' );
define( 'RESOURCE_VIEW_MODE_PREVIEW', 'preview' );
define( 'RESOURCE_VIEW_MODE_MEDIUM', 'medium' );
-
+
+ /**
+ * \ingroup View
+ * @private
+ */
class ResourceServerView extends View
{
Modified: plog/trunk/class/view/rssview.class.php
===================================================================
--- plog/trunk/class/view/rssview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/rssview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,10 +1,5 @@
<?php
- /**
- * @package view
- */
-
-
include_once( PLOG_CLASS_PATH."class/view/blogview.class.php" );
include_once( PLOG_CLASS_PATH."class/template/templatesets/templatesetstorage.class.php" );
include_once( PLOG_CLASS_PATH."class/template/templateservice.class.php" );
@@ -15,6 +10,9 @@
define( 'RSS_VIEW_DEFAULT_PROFILE', 'rss090' );
/**
+ * \ingroup View
+ * @private
+ *
* Provides RSS output.
*
* It works like any other view that extends the BlogView object, except that instead of
Modified: plog/trunk/class/view/smartyview.class.php
===================================================================
--- plog/trunk/class/view/smartyview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/smartyview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,9 +1,5 @@
<?php
- /**
- * @package view
- */
-
include_once( PLOG_CLASS_PATH.'class/view/view.class.php' );
include_once( PLOG_CLASS_PATH.'class/template/templateservice.class.php' );
include_once( PLOG_CLASS_PATH.'class/net/http/httpcache.class.php' );
@@ -16,7 +12,15 @@
define( 'SMARTY_VIEW_CACHE_CHECK', 2 );
/**
- * implementation of views in the plog framework with support for Smarty templates
+ * \ingroup View
+ *
+ * Implementation of views in the plog framework with support for Smarty templates. This is the first
+ * useful class that extends from View that adds some functionality, such as working with BlogInfo objects
+ * and providing support for smarty templates.
+ *
+ * This class uses the TemplateService class for dealing with templates.
+ *
+ * @see BlogView
*/
class SmartyView extends View
{
@@ -28,11 +32,15 @@
var $_viewId;
/**
- * Constructor
+ * Constructor of the class
*
- * @param templateName
- * @param cachingEnabled either SMARTY_VIEW_CACHE_ENABLED, SMARTY_VIEW_CACHED_DISABLED, SMARTY_VIEW_CACHE_CHECK
- * @param data
+ * @param blogInfo A valid BlogInfo object representing the blog to which this View belongs
+ * @param templateName A template name
+ * @param cachingEnabled either SMARTY_VIEW_CACHE_ENABLED, SMARTY_VIEW_CACHED_DISABLED, SMARTY_VIEW_CACHE_CHECK.
+ * If left as SMARTY_VIEW_CACHE_CHECK, the blog settings will checked to determine whether caching is enabled
+ * or not.
+ * @param data Data that will be used to generate a unique id for the cached view (it will be ignored
+ * if caching is not enabled)
*/
function SmartyView( $blogInfo, $templateName, $cachingEnabled = SMARTY_VIEW_CACHE_CHECK, $data = Array())
{
@@ -98,7 +106,8 @@
/**
- * generates a unique identifier for this view
+ * generates a unique identifier for this view. The cache identifier is generated
+ * based on the last parameter passed to the view constructor
*
* @param returns a unique id for this view
*/
@@ -142,9 +151,11 @@
}
/**
- * Renders the view using the Smarty template object that we created in the constructor
+ * Renders the view using the Smarty template object that we created in the constructor. This method
+ * sends data to the client so it should be called as the last bit of code in our custom classes
+ * extending SmartyView.
*
- * It has no parmaters and returns nothing.
+ * It has no paramaters and returns nothing.
*/
function render()
{
Modified: plog/trunk/class/view/templateview.class.php
===================================================================
--- plog/trunk/class/view/templateview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/templateview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,14 +1,12 @@
<?php
- /**
- * @package view
- */
-
-
include_once( PLOG_CLASS_PATH."class/view/blogview.class.php" );
include_once( PLOG_CLASS_PATH."class/template/templatesets/templatesets.class.php" );
/**
+ * \ingroup View
+ * @private
+ *
* Loads the given template. The only difference between this class and all
* the other views is that this one receives as a parameter from the TemplateAction
* class the name of the template to load, and then renders it.
Modified: plog/trunk/class/view/view.class.php
===================================================================
--- plog/trunk/class/view/view.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/view.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -1,10 +1,20 @@
<?php
/**
- * @package view
+ * \defgroup View
+ *
+ * A view is the class in pLog that takes care of rendering the content and sending to the user. In pLog
+ * each Action class must generate a view that can be sent to the client, which is obtained via the method
+ * Action::getView()
+ *
+ * @see View
+ * @see BlogView
+ * @see SmartyView
+ * @see AdminView
+ * @see PluginTemplatedView
+ * @see AdminPluginTemplatedView
*/
-
include_once( PLOG_CLASS_PATH."class/object/object.class.php" );
include_once( PLOG_CLASS_PATH."class/config/properties.class.php" );
include_once( PLOG_CLASS_PATH."class/net/http/phpsniff/phpSniff.class.php" );
@@ -33,8 +43,17 @@
define( "VIEW_DEFAULT_PAGE_PARAMETER", "page" );
/**
- * Methods provided by the View object that every object inheriting from this
- * should implement
+ * \ingroup View
+ *
+ * Base class with basic methods related to views. This class should not be used directly since it does
+ * not know anything about blogs, plugins or templates. New blog classes should either extend
+ * BlogView or PluginTemplatedView, while new admin view classes should extend AdminView or
+ * AdminPluginTemplatedView.
+ *
+ * This base View class does not know anything about cached views either.
+ *
+ * In case it is necessary to create a class extending directly from View, please implement your own rendering
+ * logic in the View::render() method but do not forget to call it at some point in your render() method.
*/
class View extends Object
{
@@ -46,7 +65,7 @@
var $_request;
/**
- * Constructor. By default, does nothing
+ * Constructor. Initializes the view with a default content type, character set, etc.
*/
function View()
{
@@ -69,7 +88,9 @@
}
/**
- * Sets a single parameter
+ * Sets a single parameter for the view. These parameters will be passed to the template layer
+ * once it gets processed.
+ *
* @param name Name of the parameter
* @param value Value of the parameter
*/
@@ -91,7 +112,8 @@
}
/**
- * sets the default content-type of the view
+ * sets the default content-type of the view. The default content type, if none specified, is
+ * text/html
*
* @param contentType The new content type
*/
@@ -101,7 +123,7 @@
}
/**
- * sets the character set
+ * sets the character set. If none is specified, the default content type is ISO-8859-1
*
* @param charset the character set
*/
@@ -128,7 +150,7 @@
* from the values in the array. This will remove ALL the headers
* that have been set so far!
*
- * @headers An array of strings
+ * @param headers An array of strings
* @return always true
* @see addHeaderResponse
*/
@@ -138,8 +160,8 @@
}
/**
- * prints out the content type to the client. It does not check if the
- * current content type is anything valid...
+ * prints out the content type and character set to the client, by setting the
+ * Content-Type HTTP response header
*
* @return always true.
*/
@@ -271,7 +293,9 @@
/**
* Renders the view. Here we would ideally call a template engine, using the
* values in $this->_params to fill the template 'context' and then display
- * everything.
+ * everything. All classes extending the main View class (or any of its child classes
+ * such as BlogView) are advised to call parent::render() as the first thing in their
+ * own render() method.
*
* By default does nothing and it has no parameters
*/
Modified: plog/trunk/class/view/viewarticleview.class.php
===================================================================
--- plog/trunk/class/view/viewarticleview.class.php 2005-03-30 20:25:51 UTC (rev 1657)
+++ plog/trunk/class/view/viewarticleview.class.php 2005-03-30 21:02:50 UTC (rev 1658)
@@ -6,6 +6,9 @@
define( "VIEW_ARTICLE_TEMPLATE", "postandcomments" );
/**
+ * \ingroup View
+ * @private
+ *
* this view renders an article on the screen, with support for caching
*
* @see BlogView
More information about the pLog-svn
mailing list