| alpha--model

# Element index for package alpha--model ### Package indexes alpha--controller alpha--controller--front alpha--exceptions alpha--model--types alpha--service alpha--tests alpha--util alpha--util--convertors alpha--util--feeds alpha--util--filters alpha--util--graphs alpha--util--helpers alpha--util--metrics alpha--view alpha--view--widgets [ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ l ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ u ] [ v ] [ _ ] _ [Top] ## _ __construct in file PersonObject.inc, method PersonObject::__construct() Constructor for the class that populates all of the complex types with default values __construct in file RightsObject.inc, method RightsObject::__construct() Constructor __construct in file TagObject.inc, method TagObject::__construct() The constructor __construct in file BlacklistedClientObject.inc, method BlacklistedClientObject::__construct() Constructor for the class __construct in file BadRequestObject.inc, method BadRequestObject::__construct() Constructor for the class __construct in file ArticleCommentObject.inc, method ArticleCommentObject::__construct() constructor for the class __construct in file ArticleObject.inc, method ArticleObject::__construct() The constructor which sets up some housekeeping attributes __construct in file ArticleVoteObject.inc, method ArticleVoteObject::__construct() Constructor for the class __construct in file AlphaDAO.inc, method AlphaDAO::__construct() The constructor which sets up some housekeeping attributes a [Top] ## a $articleOID in file ArticleCommentObject.inc, variable ArticleCommentObject::$articleOID The article this comment belongs to $articleOID in file ArticleVoteObject.inc, variable ArticleVoteObject::$articleOID The article this comment belongs to $author in file ArticleObject.inc, variable ArticleObject::$author The author of the article addProperty in file AlphaDAO.inc, method AlphaDAO::addProperty() Adds in a new class property without loosing existing data (does an ALTER TABLE query on the database). after_checkIndexes_callback in file TagObject.inc, method TagObject::after_checkIndexes_callback() Use this callback to create the tclass_toid__tcontent unique table index after_loadByAttribute_callback in file ArticleObject.inc, method ArticleObject::after_loadByAttribute_callback() Set up the transient URL attributes for the artcile after it has loaded after_loadByAttribute_callback in file PersonObject.inc, method PersonObject::after_loadByAttribute_callback() Set up the transient attributes for the site after it has loaded after_loadByAttribute_callback in file RightsObject.inc, method RightsObject::after_loadByAttribute_callback() Set up the transient attributes for the rights group after it has loaded after_load_callback in file RightsObject.inc, method RightsObject::after_load_callback() Set up the transient attributes for the rights group after it has loaded after_load_callback in file PersonObject.inc, method PersonObject::after_load_callback() Set up the transient attributes for the rights group after it has loaded after_load_callback in file ArticleObject.inc, method ArticleObject::after_load_callback() Set up the transient URL attributes for the article after it has loaded after_save_callback in file ArticleObject.inc, method ArticleObject::after_save_callback() After creating a new ArticleObject, tokenize the description field to form a set of automated tags and save them. after_save_callback in file PersonObject.inc, method PersonObject::after_save_callback() Looks up the OID for the Standard rights group, then relates the new person to that group if they are not in it already. If that group does not exist it will be recreated! AlphaDAO in file AlphaDAO.inc, class AlphaDAO Base business object class definition ArticleCommentObject in file ArticleCommentObject.inc, class ArticleCommentObject An article comment class for user comments ArticleObject in file ArticleObject.inc, class ArticleObject An article class for the CMS ArticleVoteObject in file ArticleVoteObject.inc, class ArticleVoteObject An article vote class for user ratings AlphaDAO.inc procedural page AlphaDAO.inc ArticleCommentObject.inc procedural page ArticleCommentObject.inc ArticleObject.inc procedural page ArticleObject.inc ArticleVoteObject.inc procedural page ArticleVoteObject.inc b [Top] ## b $bodyOnload in file ArticleObject.inc, variable ArticleObject::$bodyOnload Optional custom body onload Javascript BadRequestObject in file BadRequestObject.inc, class BadRequestObject A HTTP request that resulted in a 404 response. The class is only used when the sysEnableClientTempBlacklistFiler setting is set to true to enable the filter. before_populateFromPost_callback in file PersonObject.inc, method PersonObject::before_populateFromPost_callback() Encrypts any fields called 'password' posted for the PersonObject begin in file AlphaDAO.inc, method AlphaDAO::begin() Starts a new database transaction. bindParams in file AlphaDAO.inc, method AlphaDAO::bindParams() Dynamically binds all of the attributes for the current BO to the supplied prepared statement parameters. If arrays of attribute names and values are provided, only those will be bound to the supplied statement. bindResult in file AlphaDAO.inc, method AlphaDAO::bindResult() Dynamically binds the result of the supplied prepared statement to a 2d array, where each element in the array is another array representing a database row. BlacklistedClientObject in file BlacklistedClientObject.inc, class BlacklistedClientObject A HTTP client that is blacklisted from accessing this application BadRequestObject.inc procedural page BadRequestObject.inc BlacklistedClientObject.inc procedural page BlacklistedClientObject.inc c [Top] ## c $client in file BlacklistedClientObject.inc, variable BlacklistedClientObject::$client The (unique) client string this is blocked $client in file BadRequestObject.inc, variable BadRequestObject::$client The HTTP user-agent client string $comments in file ArticleObject.inc, variable ArticleObject::$comments A Relation containing all of the comments on this article $content in file ArticleObject.inc, variable ArticleObject::$content The article content $content in file TagObject.inc, variable TagObject::$content The content of the tag $content in file ArticleCommentObject.inc, variable ArticleCommentObject::$content The content of the comment posted by the user $created_by in file AlphaDAO.inc, variable AlphaDAO::$created_by The OID of the person who created this BO $created_ts in file AlphaDAO.inc, variable AlphaDAO::$created_ts The timestamp of creation cast in file AlphaDAO.inc, method AlphaDAO::cast() Cast a BO to another type of BO. A new BO will be returned with the same OID and version_num as the old BO, so this is NOT a true cast but is a copy. All attribute values will be copied accross. checkBOTableExists in file AlphaDAO.inc, method AlphaDAO::checkBOTableExists() Static method to check the database and see if the table for the indicated BO class name exists (assumes table name will be $BOClassName less "Object"). checkClassDefExists in file AlphaDAO.inc, method AlphaDAO::checkClassDefExists() Checks if the definition for the BO class name provided exists on the file system. checkIndexes in file AlphaDAO.inc, method AlphaDAO::checkIndexes() Checks to see if all of the indexes are in place for the BO's table, creates those that are missing. checkRecordExists in file AlphaDAO.inc, method AlphaDAO::checkRecordExists() Checks that a record exists for the BO in the database. checkTableExists in file AlphaDAO.inc, method AlphaDAO::checkTableExists() Checks to see if the table exists in the database for the current business class. checkTableNeedsUpdate in file AlphaDAO.inc, method AlphaDAO::checkTableNeedsUpdate() Checks to see if the table in the database matches (for fields) the business class definition, i.e. if the database table is in sync with the class definition. checkUserVoted in file ArticleObject.inc, method ArticleObject::checkUserVoted() Method to determine if the logged-in user has already voted for this article cleanTagContent in file TagObject.inc, method TagObject::cleanTagContent() Cleans tag content by remocing white spaces and converting to lowercase. commit in file AlphaDAO.inc, method AlphaDAO::commit() Commits the current database transaction. createAttachmentsFolder in file ArticleObject.inc, method ArticleObject::createAttachmentsFolder() Creates the attachment folder for the article on the server. createForeignIndex in file AlphaDAO.inc, method AlphaDAO::createForeignIndex() Creates a foreign key constraint (index) in the database on the given attribute. createUniqueIndex in file AlphaDAO.inc, method AlphaDAO::createUniqueIndex() Creates a unique index in the database on the given attribute(s). d [Top] ## d $dataLabels in file BadRequestObject.inc, variable BadRequestObject::$dataLabels An array of data display labels for the class properties $dataLabels in file ArticleVoteObject.inc, variable ArticleVoteObject::$dataLabels An array of data display labels for the class properties $dataLabels in file BlacklistedClientObject.inc, variable BlacklistedClientObject::$dataLabels An array of data display labels for the class properties $dataLabels in file PersonObject.inc, variable PersonObject::$dataLabels An array of data display labels for the class properties $dataLabels in file TagObject.inc, variable TagObject::$dataLabels An array of data display labels for the class properties $dataLabels in file RightsObject.inc, variable RightsObject::$dataLabels An array of data display labels for the class properties $dataLabels in file AlphaDAO.inc, variable AlphaDAO::$dataLabels An array of the data labels used for displaying class attributes $dataLabels in file ArticleObject.inc, variable ArticleObject::$dataLabels An array of data display labels for the class properties $dataLabels in file ArticleCommentObject.inc, variable ArticleCommentObject::$dataLabels An array of data display labels for the class properties $defaultAttributes in file AlphaDAO.inc, variable AlphaDAO::$defaultAttributes An array of the names of all of the default attributes of a persistent BO defined in this class $description in file ArticleObject.inc, variable ArticleObject::$description The description of the article $displayName in file PersonObject.inc, variable PersonObject::$displayName The forum display name of the person delete in file AlphaDAO.inc, method AlphaDAO::delete() Deletes the current object from the database. deleteAllByAttribute in file AlphaDAO.inc, method AlphaDAO::deleteAllByAttribute() Delete all object instances from the database by the specified attribute matching the value provided. disconnect in file AlphaDAO.inc, method AlphaDAO::disconnect() Disconnects the current database connection if one exists (self::$connection is set) dropTable in file AlphaDAO.inc, method AlphaDAO::dropTable() Drops the table if the model requirements have changed. All data is lost! e [Top] ## e $email in file PersonObject.inc, variable PersonObject::$email The email address for the person f [Top] ## f findMissingFields in file AlphaDAO.inc, method AlphaDAO::findMissingFields() Returns an array containing any properties on the class which have not been created on the database table yet. findOffendingValue in file AlphaDAO.inc, method AlphaDAO::findOffendingValue() Parses a MySQL error for the value that violated a unique constraint. g [Top] ## g generatePassword in file PersonObject.inc, method PersonObject::generatePassword() Generates a random password for the user get in file AlphaDAO.inc, method AlphaDAO::get() Generic getter method for accessing class properties. Will use the method get.ucfirst($prop) instead if that method exists at a child level (by default). Set $noChildMethods to true if you don't want to use any get.ucfirst($prop) method even if it exists, false otherwise (default). getArticleComments in file ArticleObject.inc, method ArticleObject::getArticleComments() Method for fetching all of the comments for this article getArticleScore in file ArticleObject.inc, method ArticleObject::getArticleScore() Method for returning the calculated score for this article getArticleVotes in file ArticleObject.inc, method ArticleObject::getArticleVotes() Method for fetching all of the votes for this article getAttachmentSecureURL in file ArticleObject.inc, method ArticleObject::getAttachmentSecureURL() Generates a secure URL for downloading an attachment file via the ViewAttachment controller getAttachmentsLocation in file ArticleObject.inc, method ArticleObject::getAttachmentsLocation() Generates the location of the attachments folder for this article getAttachmentsURL in file ArticleObject.inc, method ArticleObject::getAttachmentsURL() Generates the URL of the attachments folder for this article getBadRequestCount in file BadRequestObject.inc, method BadRequestObject::getBadRequestCount() Gets the count of bad requests for the client with this IP and client string in the past configurable period (sysTempBlacklistFilerPeriod) getBOClassNames in file AlphaDAO.inc, method AlphaDAO::getBOClassNames() Loops over the core and custom BO directories and builds an array of all of the BO class names in the system. getCommentCount in file PersonObject.inc, method PersonObject::getCommentCount() Method for getting a count of the amount of article comments posted by the user getConnection in file AlphaDAO.inc, method AlphaDAO::getConnection() Gets the current connection singleton, or creates a new one if none exists getContentFileDate in file ArticleObject.inc, method ArticleObject::getContentFileDate() Returns the timestamp of when the content .text file for this article was last modified. getCount in file AlphaDAO.inc, method AlphaDAO::getCount() Gets the count from the database for the amount of objects of this class. getCreateTS in file AlphaDAO.inc, method AlphaDAO::getCreateTS() Method for getting the date/time of when the BO was created. getCreatorId in file AlphaDAO.inc, method AlphaDAO::getCreatorId() Method for getting the OID of the person who created this BO. getDataLabel in file AlphaDAO.inc, method AlphaDAO::getDataLabel() Gets the data label for the given attribute name. getDataLabels in file AlphaDAO.inc, method AlphaDAO::getDataLabels() Gets the data labels array. getDefaultAttributes in file AlphaDAO.inc, method AlphaDAO::getDefaultAttributes() Get the array of default attribute names. getDisplayName in file PersonObject.inc, method PersonObject::getDisplayName() Getter for displayName getFriendlyClassName in file AlphaDAO.inc, method AlphaDAO::getFriendlyClassName() Converts "BusinessObject" to "Business" and returns. getID in file AlphaDAO.inc, method AlphaDAO::getID() Gets the OID for the object in zero-padded format (same as getOID()). This version is designed to be overridden in case you want to do something different with the ID of your objects outside of the standard 11 digit OID sequence used internally in Alpha. getIndexes in file AlphaDAO.inc, method AlphaDAO::getIndexes() Gets an array of all of the names of the active database indexes for this class. getLastQuery in file AlphaDAO.inc, method AlphaDAO::getLastQuery() Get the last database query run on this object. getMAX in file AlphaDAO.inc, method AlphaDAO::getMAX() Gets the maximum OID value from the database for this class type. getMembers in file RightsObject.inc, method RightsObject::getMembers() Get the group members Relation getOID in file AlphaDAO.inc, method AlphaDAO::getOID() Gets the OID for the object in zero-padded format (same as getID()). This version is final so cannot be overridden. getPersistentAttributes in file AlphaDAO.inc, method AlphaDAO::getPersistentAttributes() Get the array of persistent attribute names, i.e. those that are saved in the database. getPopularTagsArray in file TagObject.inc, method TagObject::getPopularTagsArray() Returns a hash array of the most popular tags based on their occurence in the database, ordered by alphabet and restricted to the a count matching the $limit supplied. The returned has array uses the tag content as a key and the database value as a value. getPropObject in file AlphaDAO.inc, method AlphaDAO::getPropObject() Gets the property object rather than the value for complex attributes. Returns false if the property exists but is private. getTableName in file AlphaDAO.inc, method AlphaDAO::getTableName() Getter for the TABLE_NAME, which should be set by a child of this class. getTransientAttributes in file AlphaDAO.inc, method AlphaDAO::getTransientAttributes() Get the array of transient attribute names. getUpdateTS in file AlphaDAO.inc, method AlphaDAO::getUpdateTS() Method for getting the date/time of when the BO was last updated. getUpdatorId in file AlphaDAO.inc, method AlphaDAO::getUpdatorId() Method for getting the OID of the person who updated this BO. getVersion in file AlphaDAO.inc, method AlphaDAO::getVersion() Gets the version_num of the object from the database (returns 0 if the BO is not saved yet). getVersionNumber in file AlphaDAO.inc, method AlphaDAO::getVersionNumber() Method for getting version number of the object. h [Top] ## h $headerContent in file ArticleObject.inc, variable ArticleObject::$headerContent Any custom HTML header content (e.g. Javascript) for the article hasAttribute in file AlphaDAO.inc, method AlphaDAO::hasAttribute() Check to see if an attribute exists on the BO. i [Top] ## i $IP in file BadRequestObject.inc, variable BadRequestObject::$IP The IP of the client inGroup in file PersonObject.inc, method PersonObject::inGroup() Checks to see if the person is in the rights group specified isInstalled in file AlphaDAO.inc, method AlphaDAO::isInstalled() Static method that tries to determine if the system database has been installed or not. isLoadedFromFile in file ArticleObject.inc, method ArticleObject::isLoadedFromFile() Returns true if the article content was loaded from a .text file, false otherwise. isTableOverloaded in file AlphaDAO.inc, method AlphaDAO::isTableOverloaded() Checks to see if the table name matches the classname, and if not if the table name matches the classname name of another BO, i.e. the table is used to store multiple types of BOs. isTagged in file AlphaDAO.inc, method AlphaDAO::isTagged() Returns true if the BO has a Relation property called tags, false otherwise. isTransient in file AlphaDAO.inc, method AlphaDAO::isTransient() Inspector to see if the business object is transient (not presently stored in the database). l [Top] ## l $lastQuery in file AlphaDAO.inc, variable AlphaDAO::$lastQuery The last database query run by this object. Useful for tracing an error. load in file AlphaDAO.inc, method AlphaDAO::load() Populates the child object with the properties retrived from the database for the object $OID. loadAll in file AlphaDAO.inc, method AlphaDAO::loadAll() Loads all of the objects of this class into an array which is returned. loadAllByAttribute in file AlphaDAO.inc, method AlphaDAO::loadAllByAttribute() Loads all of the objects of this class by the specified attribute into an array which is returned. loadAllByAttributes in file AlphaDAO.inc, method AlphaDAO::loadAllByAttributes() Loads all of the objects of this class by the specified attributes into an array which is returned. loadAllByDayUpdated in file AlphaDAO.inc, method AlphaDAO::loadAllByDayUpdated() Loads all of the objects of this class that where updated (updated_ts value) on the date indicated. loadAllFieldValuesByAttribute in file AlphaDAO.inc, method AlphaDAO::loadAllFieldValuesByAttribute() Loads all of the specified attribute values of this class by the specified attribute into an array which is returned. loadByAttribute in file AlphaDAO.inc, method AlphaDAO::loadByAttribute() Populates the child object from the database table by the given attribute value. loadClassDef in file AlphaDAO.inc, method AlphaDAO::loadClassDef() Loads the definition from the file system for the BO class name provided. loadContentFromFile in file ArticleObject.inc, method ArticleObject::loadContentFromFile() Loads the content of the ArticleObject from the specified file path loadRecentWithLimit in file ArticleObject.inc, method ArticleObject::loadRecentWithLimit() Gets an array of the OIDs of the most recent articles added to the system (by date), from the newest article to the amount specified by the $limit loadTags in file TagObject.inc, method TagObject::loadTags() Returns an array of TagObjects matching the class and OID provided m [Top] ## m $members in file RightsObject.inc, variable RightsObject::$members A Relation containing all of the PersonObjects that have these rights makeTable in file AlphaDAO.inc, method AlphaDAO::makeTable() Builds a new database table for the BO class. markPersistent in file AlphaDAO.inc, method AlphaDAO::markPersistent() Removes the name of the attribute provided from the list of transient (non-saved) attributes for this BO, ensuring that it will be saved on the next attempt. markTransient in file AlphaDAO.inc, method AlphaDAO::markTransient() Adds the name of the attribute provided to the list of transient (non-saved) attributes for this BO. markUnique in file AlphaDAO.inc, method AlphaDAO::markUnique() Adds the name of the attribute(s) provided to the list of unique (constrained) attributes for this BO. n [Top] ## n $name in file RightsObject.inc, variable RightsObject::$name The name of the rights o [Top] ## o $OID in file AlphaDAO.inc, variable AlphaDAO::$OID The object ID p [Top] ## p $password in file PersonObject.inc, variable PersonObject::$password The password for the person $personOID in file ArticleVoteObject.inc, variable ArticleVoteObject::$personOID The person who cast the vote $printURL in file ArticleObject.inc, variable ArticleObject::$printURL The print URL for this article (transient) $published in file ArticleObject.inc, variable ArticleObject::$published A boolean to control whether the artcile is publically accessible or not PersonObject.inc procedural page PersonObject.inc PersonObject in file PersonObject.inc, class PersonObject The main person/user class for the site populateFromPost in file AlphaDAO.inc, method AlphaDAO::populateFromPost() Populates the current business object from global POST data. r [Top] ## r $requestedResource in file BadRequestObject.inc, variable BadRequestObject::$requestedResource The non-existant resource that the client requested $rights in file PersonObject.inc, variable PersonObject::$rights A Relation containing all of the rights groups that this person belongs to RightsObject.inc procedural page RightsObject.inc rebuildTable in file AlphaDAO.inc, method AlphaDAO::rebuildTable() Re-builds the table if the model requirements have changed. All data is lost! reload in file AlphaDAO.inc, method AlphaDAO::reload() Reloads the object from the database, overwritting any attribute values in memory. RightsObject in file RightsObject.inc, class RightsObject The group level rights object for the application permissions rollback in file AlphaDAO.inc, method AlphaDAO::rollback() Aborts the current database transaction. s [Top] ## s $score in file ArticleVoteObject.inc, variable ArticleVoteObject::$score The actual vote score (default 1-10) $section in file ArticleObject.inc, variable ArticleObject::$section The article site section $state in file PersonObject.inc, variable PersonObject::$state The state of the person (account status) save in file AlphaDAO.inc, method AlphaDAO::save() Saves the object. If $this->OID is empty or null it will INSERT, otherwise UPDATE. saveAttribute in file AlphaDAO.inc, method AlphaDAO::saveAttribute() Saves the field specified with the value supplied. Only works for persistent BOs. Note that no Alpha type validation is performed with this method! sendMail in file PersonObject.inc, method PersonObject::sendMail() A generic method for mailing a person set in file AlphaDAO.inc, method AlphaDAO::set() Generic setter method for setting class properties. Will use the method set.ucfirst($prop) instead if that method exists at a child level (by default). Set $noChildMethods to true if you don't want to use any get.ucfirst($prop) method even if it exists, false otherwise (default). setDisplayName in file PersonObject.inc, method PersonObject::setDisplayName() Setter for displayName setEnumOptions in file AlphaDAO.inc, method AlphaDAO::setEnumOptions() Populate all of the enum options for this object from the database. setupRels in file PersonObject.inc, method PersonObject::setupRels() Sets up the Relation definitions on this BO t [Top] ## t $taggedAttributes in file ArticleObject.inc, variable ArticleObject::$taggedAttributes An array of all of the attributes on this BO which are tagged $taggedClass in file TagObject.inc, variable TagObject::$taggedClass The name of the class of the object which is tagged $taggedOID in file TagObject.inc, variable TagObject::$taggedOID The OID of the object which is tagged $tags in file ArticleObject.inc, variable ArticleObject::$tags A Relation containing all of the tags on this article $title in file ArticleObject.inc, variable ArticleObject::$title The article title $transientAttributes in file AlphaDAO.inc, variable AlphaDAO::$transientAttributes An array of the names of all of the transient attributes of a persistent BO which are not saved to the DB TagObject.inc procedural page TagObject.inc TABLE_NAME in file TagObject.inc, class constant TagObject::TABLE_NAME The name of the database table for the class TABLE_NAME in file RightsObject.inc, class constant RightsObject::TABLE_NAME The name of the database table for the class TABLE_NAME in file BlacklistedClientObject.inc, class constant BlacklistedClientObject::TABLE_NAME The name of the database table for the class TABLE_NAME in file ArticleObject.inc, class constant ArticleObject::TABLE_NAME The name of the database table for the class TABLE_NAME in file ArticleCommentObject.inc, class constant ArticleCommentObject::TABLE_NAME The name of the database table for the class TABLE_NAME in file PersonObject.inc, class constant PersonObject::TABLE_NAME The name of the database table for the class TABLE_NAME in file ArticleVoteObject.inc, class constant ArticleVoteObject::TABLE_NAME The name of the database table for the class TABLE_NAME in file BadRequestObject.inc, class constant BadRequestObject::TABLE_NAME The name of the database table for the class TagObject in file TagObject.inc, class TagObject The tag class used in tag clouds and search tokenize in file TagObject.inc, method TagObject::tokenize() Splits the passed content by spaces, filters (removes) stop words from stopwords.ini, and returns an array of TagObject instances. u [Top] ## u $uniqueAttributes in file AlphaDAO.inc, variable AlphaDAO::$uniqueAttributes An array of the uniquely-constained attributes of this persistent BO $updated_by in file AlphaDAO.inc, variable AlphaDAO::$updated_by The OID of the person who last updated this BO $updated_ts in file AlphaDAO.inc, variable AlphaDAO::$updated_ts The timestamp of the last update $URL in file PersonObject.inc, variable PersonObject::$URL The website URL of the person $URL in file ArticleObject.inc, variable ArticleObject::$URL The URL for this article (transient) v [Top] ## v $version_num in file AlphaDAO.inc, variable AlphaDAO::$version_num The version number of the object, used for locking mechanism $votes in file ArticleObject.inc, variable ArticleObject::$votes A Relation containing all of the votes on this article validate in file AlphaDAO.inc, method AlphaDAO::validate() Validates the object to be saved. Documentation generated on Thu, 17 Mar 2011 16:43:03 +0000 by phpDocumentor 1.4.3