Class BasePubauthor

Base class that represents a row from the 'pubauthor' table.

BaseObject

cli_db\propel\om\BasePubauthor implements Persistent

Direct known subclasses

Abstract
Namespace: cli_db\propel\om
Package: propel\generator\cli\db\om
Located at src/cli/db/propel-classes/cli_db/om/BasePubauthor.php

Methods summary
`public`	# `applyDefaultValues( )` Applies default values to this object. This method should be called from the object's constructor (or equivalent initialization method). Applies default values to this object. This method should be called from the object's constructor (or equivalent initialization method). See `cli_db\propel\om\BasePubauthor::__construct()`
`public`	# `__construct( )` Initializes internal state of BasePubauthor object. Initializes internal state of BasePubauthor object. See applyDefaults()
`public integer`	# `getPubauthorId( )` Get the [pubauthor_id] column value. Get the [pubauthor_id] column value. Returns `integer`
`public integer`	# `getPubId( )` Get the [pub_id] column value. Get the [pub_id] column value. Returns `integer`
`public integer`	# `getRank( )` Get the [rank] column value. Get the [rank] column value. Returns `integer`
`public boolean`	# `getEditor( )` Get the [editor] column value. Get the [editor] column value. Returns `boolean`
`public string`	# `getSurname( )` Get the [surname] column value. Get the [surname] column value. Returns `string`
`public string`	# `getGivennames( )` Get the [givennames] column value. Get the [givennames] column value. Returns `string`
`public string`	# `getSuffix( )` Get the [suffix] column value. Get the [suffix] column value. Returns `string`
`public cli_db\propel\Pubauthor`	# `setPubauthorId( integer $v )` Set the value of [pubauthor_id] column. Set the value of [pubauthor_id] column. Parameters `$v` `integer` $v new value Returns `cli_db\propel\Pubauthor` The current object (for fluent API support)
`public cli_db\propel\Pubauthor`	# `setPubId( integer $v )` Set the value of [pub_id] column. Set the value of [pub_id] column. Parameters `$v` `integer` $v new value Returns `cli_db\propel\Pubauthor` The current object (for fluent API support)
`public cli_db\propel\Pubauthor`	# `setRank( integer $v )` Set the value of [rank] column. Set the value of [rank] column. Parameters `$v` `integer` $v new value Returns `cli_db\propel\Pubauthor` The current object (for fluent API support)
`public cli_db\propel\Pubauthor`	# `setEditor( boolean\|integer\|string $v )` Sets the value of the [editor] column. Non-boolean arguments are converted using the following rules: * 1, '1', 'true', 'on', and 'yes' are converted to boolean true * 0, '0', 'false', 'off', and 'no' are converted to boolean false Check on string values is case insensitive (so 'FaLsE' is seen as 'false'). Sets the value of the [editor] column. Non-boolean arguments are converted using the following rules: * 1, '1', 'true', 'on', and 'yes' are converted to boolean true * 0, '0', 'false', 'off', and 'no' are converted to boolean false Check on string values is case insensitive (so 'FaLsE' is seen as 'false'). Parameters `$v` `boolean\|integer\|string` $v The new value Returns `cli_db\propel\Pubauthor` The current object (for fluent API support)
`public cli_db\propel\Pubauthor`	# `setSurname( string $v )` Set the value of [surname] column. Set the value of [surname] column. Parameters `$v` `string` $v new value Returns `cli_db\propel\Pubauthor` The current object (for fluent API support)
`public cli_db\propel\Pubauthor`	# `setGivennames( string $v )` Set the value of [givennames] column. Set the value of [givennames] column. Parameters `$v` `string` $v new value Returns `cli_db\propel\Pubauthor` The current object (for fluent API support)
`public cli_db\propel\Pubauthor`	# `setSuffix( string $v )` Set the value of [suffix] column. Set the value of [suffix] column. Parameters `$v` `string` $v new value Returns `cli_db\propel\Pubauthor` The current object (for fluent API support)
`public boolean`	# `hasOnlyDefaultValues( )` Indicates whether the columns in this object are only set to default values. Indicates whether the columns in this object are only set to default values. This method can be used in conjunction with isModified() to indicate whether an object is both modified _and_ has some values set which are non-default. Returns `boolean` Whether the columns in this object are only been set with default values.
`public integer`	# `hydrate( array $row, integer $startcol = 0, boolean $rehydrate = false )` Hydrates (populates) the object variables with values from the database resultset. Hydrates (populates) the object variables with values from the database resultset. An offset (0-based "start column") is specified so that objects can be hydrated with a subset of the columns in the resultset rows. This is needed, for example, for results of JOIN queries where the resultset row includes columns from two or more tables. Parameters `$row` `array` $row The row returned by PDOStatement->fetch(PDO::FETCH_NUM) `$startcol` `integer` $startcol 0-based offset column which indicates which restultset column to start with. `$rehydrate` `boolean` $rehydrate Whether this object is being re-hydrated from the database. Returns `integer` next starting column Throws `PropelException` - Any caught Exception will be rewrapped as a PropelException.
`public`	# `ensureConsistency( )` Checks and repairs the internal consistency of the object. Checks and repairs the internal consistency of the object. This method is executed after an already-instantiated object is re-hydrated from the database. It exists to check any foreign keys to make sure that the objects related to the current object are correct based on foreign key. You can override this method in the stub class, but you should always invoke the base method from the overridden method (i.e. parent::ensureConsistency()), in case your model changes. Throws `PropelException`
`public`	# `reload( boolean $deep = false, PropelPDO $con = null )` Reloads this object from datastore based on primary key and (optionally) resets all associated objects. Reloads this object from datastore based on primary key and (optionally) resets all associated objects. This will only work if the object has been saved and has a valid primary key set. Parameters `$deep` `boolean` $deep (optional) Whether to also de-associated any related objects. `$con` `PropelPDO` $con (optional) The PropelPDO connection to use. Throws `PropelException` - if this object is deleted, unsaved or doesn't have pk match in db
`public`	# `delete( PropelPDO $con = null )` Removes this object from datastore and sets delete attribute. Removes this object from datastore and sets delete attribute. Parameters `$con` `PropelPDO` $con Throws `PropelException` `Exception` See BaseObject::setDeleted() BaseObject::isDeleted()
`public integer`	# `save( PropelPDO $con = null )` Persists this object to the database. Persists this object to the database. If the object is new, it inserts it; otherwise an update is performed. All modified related objects will also be persisted in the doSave() method. This method wraps all precipitate database operations in a single transaction. Parameters `$con` `PropelPDO` $con Returns `integer` The number of rows affected by this insert/update and any referring fk objects' save() operations. Throws `PropelException` `Exception` See `cli_db\propel\om\BasePubauthor::doSave()`
`protected integer`	# `doSave( PropelPDO $con )` Performs the work of inserting or updating the row in the database. Performs the work of inserting or updating the row in the database. If the object is new, it inserts it; otherwise an update is performed. All related objects are also updated in this method. Parameters `$con` `PropelPDO` $con Returns `integer` The number of rows affected by this insert/update and any referring fk objects' save() operations. Throws `PropelException` See `cli_db\propel\om\BasePubauthor::save()`
`protected`	# `doInsert( PropelPDO $con )` Insert the row in the database. Insert the row in the database. Parameters `$con` `PropelPDO` $con Throws `PropelException` See `cli_db\propel\om\BasePubauthor::doSave()`
`protected`	# `doUpdate( PropelPDO $con )` Update the row in the database. Update the row in the database. Parameters `$con` `PropelPDO` $con See `cli_db\propel\om\BasePubauthor::doSave()`
`public array`	# `getValidationFailures( )` Gets any ValidationFailed objects that resulted from last call to validate(). Gets any ValidationFailed objects that resulted from last call to validate(). Returns `array` ValidationFailed[] See `cli_db\propel\om\BasePubauthor::validate()`
`public boolean`	# `validate( mixed $columns = null )` Validates the objects modified field values and all objects related to this table. Validates the objects modified field values and all objects related to this table. If $columns is either a column name or an array of column names only those columns are validated. Parameters `$columns` `mixed` $columns Column name or an array of column names. Returns `boolean` Whether all columns pass validation. See `cli_db\propel\om\BasePubauthor::doValidate()` `cli_db\propel\om\BasePubauthor::getValidationFailures()`
`protected mixed`	# `doValidate( array $columns = null )` This function performs the validation work for complex object models. This function performs the validation work for complex object models. In addition to checking the current object, all related objects will also be validated. If all pass then `<span class="php-keyword1">true</span>` is returned; otherwise an aggreagated array of ValidationFailed objects will be returned. Parameters `$columns` `array` $columns Array of column names to validate. Returns `mixed` `<span class="php-keyword1">true</span>` if all validations pass; array of `ValidationFailed` objets otherwise.
`public mixed`	# `getByName( string $name, string $type = cli_db\propel\om\BasePeer::TYPE_PHPNAME )` Retrieves a field from the object by name passed in as a string. Retrieves a field from the object by name passed in as a string. Parameters `$name` `string` $name name `$type` `string` $type The type of fieldname the $name is of: one of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM. Defaults to BasePeer::TYPE_PHPNAME Returns `mixed` Value of field.
`public mixed`	# `getByPosition( integer $pos )` Retrieves a field from the object by Position as specified in the xml schema. Zero-based. Retrieves a field from the object by Position as specified in the xml schema. Zero-based. Parameters `$pos` `integer` $pos position in xml schema Returns `mixed` Value of field at $pos
`public array`	# `toArray( string $keyType = cli_db\propel\om\BasePeer::TYPE_PHPNAME, boolean $includeLazyLoadColumns = true, array $alreadyDumpedObjects = array(), boolean $includeForeignObjects = false )` Exports the object as an array. Exports the object as an array. You can specify the key type of the array by passing one of the class type constants. Parameters `$keyType` `string` $keyType (optional) One of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME, BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM. Defaults to BasePeer::TYPE_PHPNAME. `$includeLazyLoadColumns` `boolean` $includeLazyLoadColumns (optional) Whether to include lazy loaded columns. Defaults to true. `$alreadyDumpedObjects` `array` $alreadyDumpedObjects List of objects to skip to avoid recursion `$includeForeignObjects` `boolean` $includeForeignObjects (optional) Whether to include hydrated related objects. Default to FALSE. Returns `array` an associative array containing the field names (as keys) and field values
`public`	# `setByName( string $name, mixed $value, string $type = cli_db\propel\om\BasePeer::TYPE_PHPNAME )` Sets a field from the object by name passed in as a string. Sets a field from the object by name passed in as a string. Parameters `$name` `string` $name peer name `$value` `mixed` $value field value `$type` `string` $type The type of fieldname the $name is of: one of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM. Defaults to BasePeer::TYPE_PHPNAME
`public`	# `setByPosition( integer $pos, mixed $value )` Sets a field from the object by Position as specified in the xml schema. Zero-based. Sets a field from the object by Position as specified in the xml schema. Zero-based. Parameters `$pos` `integer` $pos position in xml schema `$value` `mixed` $value field value
`public`	# `fromArray( array $arr, string $keyType = cli_db\propel\om\BasePeer::TYPE_PHPNAME )` Populates the object using an array. Populates the object using an array. This is particularly useful when populating an object from one of the request arrays (e.g. $_POST). This method goes through the column names, checking to see whether a matching key exists in populated array. If so the setByName() method is called for that column. You can specify the key type of the array by additionally passing one of the class type constants BasePeer::TYPE_PHPNAME, BasePeer::TYPE_STUDLYPHPNAME, BasePeer::TYPE_COLNAME, BasePeer::TYPE_FIELDNAME, BasePeer::TYPE_NUM. The default key type is the column's BasePeer::TYPE_PHPNAME Parameters `$arr` `array` $arr An array to populate the object from. `$keyType` `string` $keyType The type of keys the array uses.
`public Criteria`	# `buildCriteria( )` Build a Criteria object containing the values of all modified columns in this object. Build a Criteria object containing the values of all modified columns in this object. Returns `Criteria` The Criteria object containing all modified values.
`public Criteria`	# `buildPkeyCriteria( )` Builds a Criteria object containing the primary key for this object. Builds a Criteria object containing the primary key for this object. Unlike buildCriteria() this method includes the primary key values regardless of whether or not they have been modified. Returns `Criteria` The Criteria object containing value(s) for primary key(s).
`public integer`	# `getPrimaryKey( )` Returns the primary key for this object (row). Returns the primary key for this object (row). Returns `integer`
`public`	# `setPrimaryKey( integer $key )` Generic method to set the primary key (pubauthor_id column). Generic method to set the primary key (pubauthor_id column). Parameters `$key` `integer` $key Primary key.
`public boolean`	# `isPrimaryKeyNull( )` Returns true if the primary key for this object is null. Returns true if the primary key for this object is null. Returns `boolean`
`public`	# `copyInto( object $copyObj, boolean $deepCopy = false, boolean $makeNew = true )` Sets contents of passed object to values from current object. Sets contents of passed object to values from current object. If desired, this method can also make copies of all associated (fkey referrers) objects. Parameters `$copyObj` `object` $copyObj An object of Pubauthor (or compatible) type. `$deepCopy` `boolean` $deepCopy Whether to also copy all rows that refer (by fkey) to the current row. `$makeNew` `boolean` $makeNew Whether to reset autoincrement PKs and make the object new. Throws `PropelException`
`public cli_db\propel\Pubauthor`	# `copy( boolean $deepCopy = false )` Makes a copy of this object that will be inserted as a new row in table when saved. It creates a new object filling in the simple attributes, but skipping any primary keys that are defined for the table. Makes a copy of this object that will be inserted as a new row in table when saved. It creates a new object filling in the simple attributes, but skipping any primary keys that are defined for the table. If desired, this method can also make copies of all associated (fkey referrers) objects. Parameters `$deepCopy` `boolean` $deepCopy Whether to also copy all rows that refer (by fkey) to the current row. Returns `cli_db\propel\Pubauthor` Clone of current object. Throws `PropelException`
`public cli_db\propel\PubauthorPeer`	# `getPeer( )` Returns a peer instance associated with this om. Returns a peer instance associated with this om. Since Peer classes are not to have any instance attributes, this method returns the same instance for all member of this class. The method could therefore be static, but this would prevent one from overriding the behavior. Returns `cli_db\propel\PubauthorPeer`
`public cli_db\propel\Pubauthor`	# `setPub( cli_db\propel\Pub $v = null )` Declares an association between this object and a Pub object. Declares an association between this object and a Pub object. Parameters `$v` `cli_db\propel\Pub` $v Returns `cli_db\propel\Pubauthor` The current object (for fluent API support) Throws `PropelException`
`public cli_db\propel\Pub`	# `getPub( PropelPDO $con = null, mixed $doQuery = true )` Get the associated Pub object Get the associated Pub object Parameters `$con` `PropelPDO` $con Optional Connection object. `$doQuery` `mixed` $doQuery Executes a query to get the object if required Returns `cli_db\propel\Pub` The associated Pub object. Throws `PropelException`
`public`	# `clear( )` Clears the current object and sets all attributes to their default values Clears the current object and sets all attributes to their default values
`public`	# `clearAllReferences( boolean $deep = false )` Resets all references to other model objects or collections of model objects. Resets all references to other model objects or collections of model objects. This method is a user-space workaround for PHP's inability to garbage collect objects with circular references (even in PHP 5.3). This is currently necessary when using Propel in certain daemon or large-volumne/high-memory operations. Parameters `$deep` `boolean` $deep Whether to also clear the references on all referrer objects.
`public string`	# `__toString( )` return the string representation of this object return the string representation of this object Returns `string`
`public boolean`	# `isAlreadyInSave( )` return true is the object is in saving state return true is the object is in saving state Returns `boolean`

Constants summary
`string`	`PEER`	`'cli_db\\propel\\PubauthorPeer'`	# Peer class name Peer class name

Properties summary
`protected static cli_db\propel\PubauthorPeer`	`$peer`		# The Peer class. Instance provides a convenient way of calling static methods on a class that calling code may not be able to identify. The Peer class. Instance provides a convenient way of calling static methods on a class that calling code may not be able to identify.
`protected boolean`	`$startCopy`	`false`	# The flag var to prevent infinit loop in deep copy The flag var to prevent infinit loop in deep copy
`protected integer`	`$pubauthor_id`		# The value for the pubauthor_id field. The value for the pubauthor_id field.
`protected integer`	`$pub_id`		# The value for the pub_id field. The value for the pub_id field.
`protected integer`	`$rank`		# The value for the rank field. The value for the rank field.
`protected boolean`	`$editor`		# The value for the editor field. Note: this column has a database default value of: false The value for the editor field. Note: this column has a database default value of: false
`protected string`	`$surname`		# The value for the surname field. The value for the surname field.
`protected string`	`$givennames`		# The value for the givennames field. The value for the givennames field.
`protected string`	`$suffix`		# The value for the suffix field. The value for the suffix field.
`protected cli_db\propel\Pub`	`$aPub`		#
`protected boolean`	`$alreadyInSave`	`false`	# Flag to prevent endless save loop, if this object is referenced by another object which falls in this transaction. Flag to prevent endless save loop, if this object is referenced by another object which falls in this transaction.
`protected boolean`	`$alreadyInValidation`	`false`	# Flag to prevent endless validation loop, if this object is referenced by another object which falls in this transaction. Flag to prevent endless validation loop, if this object is referenced by another object which falls in this transaction.
`protected boolean`	`$alreadyInClearAllReferencesDeep`	`false`	# Flag to prevent endless clearAllReferences($deep=true) loop, if this object is referenced Flag to prevent endless clearAllReferences($deep=true) loop, if this object is referenced
`protected array`	`$validationFailures`	`array()`	# Array of ValidationFailed objects. Array of ValidationFailed objects.

Namespaces

Classes

Class BasePubauthor

Direct known subclasses

See

See

Returns

Returns

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Throws

Throws

Parameters

Throws

Parameters

Throws

See

Parameters

Returns

Throws

See

Parameters

Returns

Throws

See

Parameters

Throws

See

Parameters

See

Returns

See

Parameters

Returns

See

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Throws

Parameters

Returns

Throws

Returns

Parameters

Returns

Throws