CSERDreview Class Reference
[CSERD Model Objects]
Model class for review entity.
More...
Public Member Functions | |
| __construct ($constraints=null, $multi=false) | |
| Constructs new CSERDreview object. | |
| addcomment ($owner, $author, $comment= '', $timestamp= '') | |
| Add new CSERDcomment object connected to this object. | |
| addresponse ($question, $response= '') | |
| Add new CSERDresponse object connected to this object. | |
| addreviewSubject ($subject) | |
| Add new CSERDreviewSubject object connected to this object. | |
| getParentAuthor () | |
| Retrieves parent object of this object. | |
| getParentAuthorMulti ($depth=1) | |
| Retrieves parent object of this object with foreign objects. | |
| getParentOwner () | |
| Retrieves parent object of this object. | |
| getParentOwnerMulti ($depth=1) | |
| Retrieves parent object of this object with foreign objects. | |
| listcomments ($constraints=array(), $limit=array(), $order=array(), $count=false) | |
| Retrieves list of children CSERDcomment objects. | |
| listcommentsMulti ($constraints=array(), $limit=array(), $order=array(), $count=false, $depth=1) | |
| Retrieves list of children CSERDcomment objects using joins. | |
| listresponses ($constraints=array(), $limit=array(), $order=array(), $count=false) | |
| Retrieves list of children CSERDresponse objects. | |
| listresponsesMulti ($constraints=array(), $limit=array(), $order=array(), $count=false, $depth=1) | |
| Retrieves list of children CSERDresponse objects using joins. | |
| listreviewSubjects ($constraints=array(), $limit=array(), $order=array(), $count=false) | |
| Retrieves list of children CSERDreviewSubject objects. | |
| listreviewSubjectsMulti ($constraints=array(), $limit=array(), $order=array(), $count=false, $depth=1) | |
| Retrieves list of children CSERDreviewSubject objects using joins. | |
Static Public Member Functions | |
| static | exists ($constraints=array()) |
| Checks to see if object exists according to constraints. | |
| static | existsMulti ($constraints=array()) |
| Checks to see if object-set exists according to constraints. | |
| static | getAttributesStatic () |
| Retrieves attributes and information about them. | |
| static | getList ($constraints=array(), $limit=array(), $order=array(), $count=false) |
| Retrieves list of CSERDreview objects. | |
| static | getListMulti ($constraints=array(), $limit=array(), $order=array(), $count=false, $depth=1) |
| Retrieves list of CSERDreview objects using joins. | |
| static | getTableNameStatic () |
| Retrieves name of table represented by this class. | |
| static | retrieve ($constraints=array(), $checkOnly=false) |
| Retrieves a single object of this type, given the constraints. | |
| static | retrieveMulti ($constraints=array(), $checkOnly=false, $depth=1) |
| Retrieves a single object of this type, given the constraints, grabbing foreign objects. | |
Protected Attributes | |
| $questionnaire | |
| Attributes for this entity and information about them. | |
Detailed Description
Model class for review entity.INSERT DESCRIPTION HERE
Constructor & Destructor Documentation
| CSERDreview::__construct | ( | $ | constraints = null, |
|
| $ | multi = false | |||
| ) |
Constructs new CSERDreview object.
This method will only populate the object if a constraints array is passed in, to use for selecting the information for the object from the database (see Guide to Database Constraints).
- Parameters:
-
$constraints [array]: constraints array for populating $multi [boolean]: if true, use joins when populating
Member Function Documentation
| CSERDreview::addcomment | ( | $ | owner, | |
| $ | author, | |||
| $ | comment = '', |
|||
| $ | timestamp = '' | |||
| ) |
Add new CSERDcomment object connected to this object.
This method creates a new CSERDcomment and makes sure that relevant foreign keys in that object point to this object and any other necessary objects as passed in as parameters to this method. For parameters that request another model object, you may either pass in the model object itself, or the id value for that object, as would be used in the foreign key of the new CSERDcomment object. For example, if the new object needs to point to both this object and, say, a user object, then you can either pass in a user object, or a user ID.
- Parameters:
-
$owner [CSERDuser]: Can also be foreign key value. INSERT DESCRIPTION HERE $author [CSERDuser]: Can also be foreign key value. INSERT DESCRIPTION HERE $comment [string]: INSERT DESCRIPTION HERE $timestamp [time]: INSERT DESCRIPTION HERE
- Returns:
- [CSERDcomment]: new object (already committed) or null on failure
| CSERDreview::addresponse | ( | $ | question, | |
| $ | response = '' | |||
| ) |
Add new CSERDresponse object connected to this object.
This method creates a new CSERDresponse and makes sure that relevant foreign keys in that object point to this object and any other necessary objects as passed in as parameters to this method. For parameters that request another model object, you may either pass in the model object itself, or the id value for that object, as would be used in the foreign key of the new CSERDresponse object. For example, if the new object needs to point to both this object and, say, a user object, then you can either pass in a user object, or a user ID.
- Parameters:
-
$question [CSERDquestion]: Can also be foreign key value. INSERT DESCRIPTION HERE $response [string]: INSERT DESCRIPTION HERE
- Returns:
- [CSERDresponse]: new object (already committed) or null on failure
| CSERDreview::addreviewSubject | ( | $ | subject | ) |
Add new CSERDreviewSubject object connected to this object.
This method creates a new CSERDreviewSubject and makes sure that relevant foreign keys in that object point to this object and any other necessary objects as passed in as parameters to this method. For parameters that request another model object, you may either pass in the model object itself, or the id value for that object, as would be used in the foreign key of the new CSERDreviewSubject object. For example, if the new object needs to point to both this object and, say, a user object, then you can either pass in a user object, or a user ID.
- Parameters:
-
$subject [CSERDsubject]: Can also be foreign key value. INSERT DESCRIPTION HERE
- Returns:
- [CSERDreviewSubject]: new object (already committed) or null on failure
| static CSERDreview::exists | ( | $ | constraints = array() |
) | [static] |
Checks to see if object exists according to constraints.
This is simply an alias for retrieve($constraints, true);
- Parameters:
-
$constraints [array]: constraints used to check for existence of object
- Returns:
- [boolean]: whether object exists in DB
| static CSERDreview::existsMulti | ( | $ | constraints = array() |
) | [static] |
Checks to see if object-set exists according to constraints.
This is simply an alias for retrieveMulti($constraints, true);
- Parameters:
-
$constraints [array]: constraints used to check for existence of object
- Returns:
- [boolean]: whether object exists in DB
| static CSERDreview::getAttributesStatic | ( | ) | [static] |
Retrieves attributes and information about them.
This method is needed because there is no generic way to get at the $ATTRIBUTES static member variable without this kind of method. If you do not need to generically grab the attributes of a model class, just use ModelClass::$ATTRIBUTES or $obj->getAttributes().
- Returns:
- [array]: contents of static $ATTRIBUTES array
| static CSERDreview::getList | ( | $ | constraints = array(), |
|
| $ | limit = array(), |
|||
| $ | order = array(), |
|||
| $ | count = false | |||
| ) | [static] |
Retrieves list of CSERDreview objects.
See Guide to Database Constraints for more on how to construct constraint and other arrays for this method.
- Parameters:
-
$constraints [array]: limit results by criteria $limit [array]: limit results by count $order [array]: change ordering of results $count [boolean]: if true, return the number of objects that would have been returned, rather than the objects themselves
- Returns:
- [array of CSERDreview]: list of objects matching the criteria, if any, or null on error
| static CSERDreview::getListMulti | ( | $ | constraints = array(), |
|
| $ | limit = array(), |
|||
| $ | order = array(), |
|||
| $ | count = false, |
|||
| $ | depth = 1 | |||
| ) | [static] |
Retrieves list of CSERDreview objects using joins.
See Guide to Database Constraints for more on how to construct constraint and other arrays for this method. This method differs from getList() in that it initializes the objects with joins, so that their child objects are included as well. Everything else is the same
- Parameters:
-
$constraints [array]: limit results by criteria $limit [array]: limit results by count $order [array]: change ordering of results $count [boolean]: if true, return the number of objects that would have been returned, rather than the objects themselves $depth [int]: how deep to traverse dependencies when doing joins
- Returns:
- [array of CSERDreview]: list of objects matching the criteria, if any, or null on error
| CSERDreview::getParentAuthor | ( | ) |
Retrieves parent object of this object.
The parent object of a CSERDreview is a CSERDuser, related by the fact that CSERDuser's userId has the same value as our authorId field.
- Returns:
- [CSERDuser]: parent object, or null on error
| CSERDreview::getParentAuthorMulti | ( | $ | depth = 1 |
) |
Retrieves parent object of this object with foreign objects.
The parent object of a CSERDreview is a CSERDuser, related by the fact that CSERDuser's userId has the same value as our authorId field.
- Parameters:
-
$depth [int]: how deep to traverse dependencies when doing joins
- Returns:
- [CSERDuser]: parent object, or null on error
| CSERDreview::getParentOwner | ( | ) |
Retrieves parent object of this object.
The parent object of a CSERDreview is a CSERDuser, related by the fact that CSERDuser's userId has the same value as our ownerId field.
- Returns:
- [CSERDuser]: parent object, or null on error
| CSERDreview::getParentOwnerMulti | ( | $ | depth = 1 |
) |
Retrieves parent object of this object with foreign objects.
The parent object of a CSERDreview is a CSERDuser, related by the fact that CSERDuser's userId has the same value as our ownerId field.
- Parameters:
-
$depth [int]: how deep to traverse dependencies when doing joins
- Returns:
- [CSERDuser]: parent object, or null on error
| static CSERDreview::getTableNameStatic | ( | ) | [static] |
Retrieves name of table represented by this class.
- Returns:
- [string]: table name
| CSERDreview::listcomments | ( | $ | constraints = array(), |
|
| $ | limit = array(), |
|||
| $ | order = array(), |
|||
| $ | count = false | |||
| ) |
Retrieves list of children CSERDcomment objects.
This method retrieves objects of type CSERDcomment which have their reviewId field equal to the value of this object's reviewId field. The constraints, limit and order parameters can be used to trim down and order the results. See Guide to Database Constraints for more on using database constraints with DBI2/SModel2.
- Parameters:
-
$constraints [array]: constraints array to further limit results $limit [array]: limit array to control how many and which results are returned $order [array]: order array to control the ordering of the returned results $count [boolean]: if true, only return the count of how many objects would be returned, rather than the objects themselves
- Returns:
- [CSERDcomment]: array of child objects, or an integer if
$countis true, or null on error
| CSERDreview::listcommentsMulti | ( | $ | constraints = array(), |
|
| $ | limit = array(), |
|||
| $ | order = array(), |
|||
| $ | count = false, |
|||
| $ | depth = 1 | |||
| ) |
Retrieves list of children CSERDcomment objects using joins.
This method retrieves objects of type CSERDcomment which have their reviewId field equal to the value of this object's reviewId field. The constraints, limit and order parameters can be used to trim down and order the results. See Guide to Database Constraints for more on using database constraints with DBI2/SModel2. Unlike listcomments(), this method joins the child objects with their parent objects.
- Parameters:
-
$constraints [array]: constraints array to further limit results $limit [array]: limit array to control how many and which results are returned $order [array]: order array to control the ordering of the returned results $count [boolean]: if true, only return the count of how many objects would be returned, rather than the objects themselves $depth [int]: how deep to traverse dependencies when doing joins
- Returns:
- [CSERDcomment]: array of child objects, or an integer if
$countis true, or null on error
| CSERDreview::listresponses | ( | $ | constraints = array(), |
|
| $ | limit = array(), |
|||
| $ | order = array(), |
|||
| $ | count = false | |||
| ) |
Retrieves list of children CSERDresponse objects.
This method retrieves objects of type CSERDresponse which have their reviewId field equal to the value of this object's reviewId field. The constraints, limit and order parameters can be used to trim down and order the results. See Guide to Database Constraints for more on using database constraints with DBI2/SModel2.
- Parameters:
-
$constraints [array]: constraints array to further limit results $limit [array]: limit array to control how many and which results are returned $order [array]: order array to control the ordering of the returned results $count [boolean]: if true, only return the count of how many objects would be returned, rather than the objects themselves
- Returns:
- [CSERDresponse]: array of child objects, or an integer if
$countis true, or null on error
| CSERDreview::listresponsesMulti | ( | $ | constraints = array(), |
|
| $ | limit = array(), |
|||
| $ | order = array(), |
|||
| $ | count = false, |
|||
| $ | depth = 1 | |||
| ) |
Retrieves list of children CSERDresponse objects using joins.
This method retrieves objects of type CSERDresponse which have their reviewId field equal to the value of this object's reviewId field. The constraints, limit and order parameters can be used to trim down and order the results. See Guide to Database Constraints for more on using database constraints with DBI2/SModel2. Unlike listresponses(), this method joins the child objects with their parent objects.
- Parameters:
-
$constraints [array]: constraints array to further limit results $limit [array]: limit array to control how many and which results are returned $order [array]: order array to control the ordering of the returned results $count [boolean]: if true, only return the count of how many objects would be returned, rather than the objects themselves $depth [int]: how deep to traverse dependencies when doing joins
- Returns:
- [CSERDresponse]: array of child objects, or an integer if
$countis true, or null on error
| CSERDreview::listreviewSubjects | ( | $ | constraints = array(), |
|
| $ | limit = array(), |
|||
| $ | order = array(), |
|||
| $ | count = false | |||
| ) |
Retrieves list of children CSERDreviewSubject objects.
This method retrieves objects of type CSERDreviewSubject which have their reviewId field equal to the value of this object's reviewId field. The constraints, limit and order parameters can be used to trim down and order the results. See Guide to Database Constraints for more on using database constraints with DBI2/SModel2.
- Parameters:
-
$constraints [array]: constraints array to further limit results $limit [array]: limit array to control how many and which results are returned $order [array]: order array to control the ordering of the returned results $count [boolean]: if true, only return the count of how many objects would be returned, rather than the objects themselves
- Returns:
- [CSERDreviewSubject]: array of child objects, or an integer if
$countis true, or null on error
| CSERDreview::listreviewSubjectsMulti | ( | $ | constraints = array(), |
|
| $ | limit = array(), |
|||
| $ | order = array(), |
|||
| $ | count = false, |
|||
| $ | depth = 1 | |||
| ) |
Retrieves list of children CSERDreviewSubject objects using joins.
This method retrieves objects of type CSERDreviewSubject which have their reviewId field equal to the value of this object's reviewId field. The constraints, limit and order parameters can be used to trim down and order the results. See Guide to Database Constraints for more on using database constraints with DBI2/SModel2. Unlike listreviewSubjects(), this method joins the child objects with their parent objects.
- Parameters:
-
$constraints [array]: constraints array to further limit results $limit [array]: limit array to control how many and which results are returned $order [array]: order array to control the ordering of the returned results $count [boolean]: if true, only return the count of how many objects would be returned, rather than the objects themselves $depth [int]: how deep to traverse dependencies when doing joins
- Returns:
- [CSERDreviewSubject]: array of child objects, or an integer if
$countis true, or null on error
| static CSERDreview::retrieve | ( | $ | constraints = array(), |
|
| $ | checkOnly = false | |||
| ) | [static] |
Retrieves a single object of this type, given the constraints.
Use this method instead of the constructor since the constructor cannot return error conditions properly.
- Parameters:
-
$constraints [array]: constraints to use when retrieving object $checkOnly [boolean]: if true, just return whether the row exists in the DB
- Returns:
- [CSERDreview]: retrieved object, or null on error or object does not exist (or true/false if $checkOnly is true, to indicate whether the row exists in the DB)
| static CSERDreview::retrieveMulti | ( | $ | constraints = array(), |
|
| $ | checkOnly = false, |
|||
| $ | depth = 1 | |||
| ) | [static] |
Retrieves a single object of this type, given the constraints, grabbing foreign objects.
Use this method instead of the constructor since the constructor cannot return error conditions properly. This method uses getListMulti() instead of getList() to grab the object.
- Parameters:
-
$constraints [array]: constraints to use when retrieving object $checkOnly [boolean]: if true, just return whether the row exists in the DB $depth [int]: how deep to traverse dependencies when doing joins
- Returns:
- [CSERDreview]: retrieved object, or null on error or object does not exist (or true/false if $checkOnly is true, to indicate whether the row exists in the DB)
The documentation for this class was generated from the following file:
- models/CSERDmodel/CSERDreview.php5
