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

Class: Community_BlogCommentStatus

Source Location: /community_classes/blogcommentstatus.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]

Community_BlogCommentStatus __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 addBlogCommentStatus [line 85]

int addBlogCommentStatus( array $sqlData)

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



Tags:

return:  Insert id
throws:  Community_BlogCommentStatusException
access:  public


Parameters:

array   $sqlData   Row data

[ Top ]

method blogCommentStatusBelongsToCurrentProject [line 439]

int blogCommentStatusBelongsToCurrentProject( int $blog_comment_status)

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



Tags:

return:  bool
throws:  Community_BlogCommentStatusException
access:  public


Parameters:

int   $blog_comment_status   Blog commen status id

[ Top ]

method blogCommentStatusBelongsToCurrentUser [line 485]

bool blogCommentStatusBelongsToCurrentUser( int $blog_comment_status)

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



Tags:

throws:  Community_Blogcommenstatus
access:  public


Parameters:

int   $blog_comment_status   Blog comment status id

[ Top ]

method countBlogCommentStatuses [line 328]

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

Method to count the existing blog comment statuses. Takes key=>value array with count params as first argument. Returns array.

List of supported params:

No params supported.




Tags:

throws:  Community_BlogCommentStatusException
access:  public


Parameters:

array   $params   Count params

[ Top ]

method deleteBlogCommentStatus [line 162]

int deleteBlogCommentStatus( int $id)

Removes blog comment status from the blog comment statuses table. Takes the blog comment status id as first argument. Returns amount of affected rows.



Tags:

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


Parameters:

int   $id   Blog comment status id

[ Top ]

method selectBlogCommentStatus [line 200]

array selectBlogCommentStatus( int $id)

Selects one blog comment status. Takes the blog comment status id as first argument. Returns array with blog comment status information.



Tags:

throws:  Community_BlogCommentStatusException
access:  public


Parameters:

int   $id   Blog comment status id

[ Top ]

method selectBlogCommentStatuses [line 256]

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

Method to select one or more blog comment statuses. 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:  Community_BlogCommentStatusException
access:  public


Parameters:

array   $params   Select params

[ Top ]

method testForUniqueName [line 381]

bool testForUniqueName( string $name, [int $id = null])

Tests given blog comment status name for uniqueness. Takes the blog comment status name as first argument and an optional blog comment status id as second argument.

If the blog comment status id is given, this blog comment status won't be considered when checking for uniqueness (useful for updates). Returns boolean true if blog comment status name is unique.




Tags:

throws:  Community_BlogCommentStatusException
access:  public


Parameters:

string   $name   Blog comment status name
int   $id   Blog comment status id

[ Top ]

method updateBlogCommentStatus [line 119]

int updateBlogCommentStatus( int $id, array $sqlData)

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

Returns amount of affected rows.




Tags:

return:  Affected rows
throws:  Community_BlogCommentStatusException
access:  public


Parameters:

int   $id   Blog comment status id
array   $sqlData   Row data

[ Top ]


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