Welcompose
[ class tree: Welcompose ] [ index: Welcompose ] [ all elements ]

Class: Content_BlogPodcastCategory

Source Location: /content_classes/blogpodcastcategory.class.php

Class Overview




Variables

Methods



Class Details

[line 38]


[ Top ]


Class Variables

static $instance =  null

[line 45]

Singleton



Tags:

access:  public

Type:   object


[ Top ]

$base =  null

[line 52]

Reference to base class



Tags:

access:  public

Type:   object


[ Top ]



Class Methods


constructor __construct [line 59]

Content_BlogPodcastCategory __construct( )

Start instance of base class, load configuration and establish database connection. Please don't call the constructor direcly, use the singleton pattern instead.



Tags:

access:  public


[ Top ]

method addBlogPodcastCategory [line 85]

int addBlogPodcastCategory( array $sqlData)

Adds blog podcast category to the blog podcast category table. Takes a field=>value array with blog podcast category data as first argument. Returns insert id.



Tags:

return:  Insert id
throws:  Content_BlogPodcastCategoryException
access:  public


Parameters:

array   $sqlData   Row data

[ Top ]

method blogPodcastCategoryBelongsToCurrentProject [line 521]

int blogPodcastCategoryBelongsToCurrentProject( int $blog_podcast_category)

Tests whether given blog podcast category belongs to current project. Takes the blog podcast category id as first argument. Returns bool.



Tags:

return:  bool
throws:  Content_BlogPodcastCategoryException
access:  public


Parameters:

int   $blog_podcast_category   Global blog podcast category id

[ Top ]

method blogPodcastCategoryBelongsToCurrentUser [line 567]

bool blogPodcastCategoryBelongsToCurrentUser( int $blog_podcast_category)

Test whether box belongs to current user or not. Takes the box id as first argument. Returns bool.



Tags:

throws:  Content_BlogPodcastCategoryException
access:  public


Parameters:

int   $blog_podcast_category   box id

[ Top ]

method countBlogPodcastCategories [line 340]

array countBlogPodcastCategories( [array $params = array()])

Method to count blog podcast categories. Takes key=>value array with count params as first argument. Returns int.

List of supported params:

  • none




Tags:

throws:  Content_BlogPodcastCategoryException
access:  public


Parameters:

array   $params   Count params

[ Top ]

method deleteBlogPodcastCategory [line 169]

int deleteBlogPodcastCategory( int $id)

Removes blog podcast category from the blog podcast categorys table. Takes the blog podcast category id as first argument. Returns amount of affected rows.



Tags:

return:  Amount of affected rows
throws:  Content_BlogPodcastCategoryException
access:  public


Parameters:

int   $id   Blog podcast id

[ Top ]

method selectBlogPodcastCategories [line 262]

array selectBlogPodcastCategories( [array $params = array()])

Method to select one or more blog podcast categories. Takes key=>value array with select params as first argument. Returns array.

List of supported params:

  • start, int, optional: row offset
  • limit, int, optional: amount of rows to return




Tags:

throws:  Content_BlogPodcastCategoryException
access:  public


Parameters:

array   $params   Select params

[ Top ]

method selectBlogPodcastCategory [line 206]

array selectBlogPodcastCategory( int $id)

Method to select a blog podcast category. Takes the blog podcast category id as first argument. Returns array.



Tags:

throws:  Content_BlogPodcastCategoryException
access:  public


Parameters:

int   $id   Podcast category id

[ Top ]

method testForUniqueCategoryName [line 395]

bool testForUniqueCategoryName( string $name, [array $params = array()])

Tests given blog podcast category name for uniqueness. Takes the blog podcast category name as first argument and an array with the subcategory name as first element and the optional blog podcast category id as second element.

If the blog podcast category id is given, this blog podcast category won't be considered when checking for uniqueness (useful for updates). Returns boolean true if the combination of blog podcast category and blog podcast category is unique.




Tags:

throws:  Content_BlogPodcastException
access:  public


Parameters:

string   $name   Podcast category name
array   $params   Podcast subcategory name and podcast category id

[ Top ]

method updateBlogPodcastCategory [line 121]

int updateBlogPodcastCategory( int $id, array $sqlData)

Updates blog podcast category. Takes the blog podcast category id as first argument, a field=>value array with the new blog podcast category data as second argument.

Returns amount of affected rows.




Tags:

return:  Affected rows
throws:  Content_BlogPodcastCategoryException
access:  public


Parameters:

int   $id   Blog podcast id
array   $sqlData   Row data

[ Top ]

method updateBlogPodcastCategoryName [line 463]

int updateBlogPodcastCategoryName( int $id)

Updates the blog podcast category name using a combination of category and subcategory name.



Tags:

return:  Affected rows
throws:  Content_BlogPodcastCategoryException
access:  protected


Parameters:

int   $id   Blog podcast category id

[ Top ]


Documentation generated on Sun, 08 Jan 2012 17:51:42 +0100 by phpDocumentor 1.4.3