ilBlogPosting Class Reference

Class ilBlogPosting. More...

Inheritance diagram for ilBlogPosting:

Collaboration diagram for ilBlogPosting:

Public Member Functions
	__construct ($a_id=0, $a_old_nr=0, $a_halt=true)
	Constructor.
	setTitle ($a_title)
	Set title.
	getTitle ()
	Get title.
	setBlogId ($a_id)
	Set blog object id.
	getBlogId ()
	Get blog object id.
	setCreated (ilDateTime $a_date)
	Set creation date.
	getCreated ()
	Get creation date.
	create ()
	Create new blog posting.
	update ($a_validate=true, $a_no_history=false, $a_notify=true)
	Update blog posting.
	read ()
	Read blog posting.
	delete ()
	Delete blog posting and all related data.
	setBlogWspId ($a_id)
	Set blog wsp id (needed for notification)
Public Member Functions inherited from ilPageObject
	ilPageObject ($a_parent_type, $a_id=0, $a_old_nr=0, $a_halt=true)
	Constructor public.
	haltOnError ($a_halt)
	setRenderMd5 ($a_rendermd5)
	Set Render MD5.
	getRenderMd5 ()
	Get Render MD5.
	setRenderedContent ($a_renderedcontent)
	Set Rendered Content.
	getRenderedContent ()
	Get Rendered Content.
	setRenderedTime ($a_renderedtime)
	Set Rendered Time.
	getRenderedTime ()
	Get Rendered Time.
	setLastChange ($a_lastchange)
	Set Last Change.
	getLastChange ()
	Get Last Change.
	setLayoutMode ($a_layout_mode)
	Set Layout Mode.
	getLayoutMode ()
	Get Layout Mode enabled/disabled.
	setLastChangeUser ($a_val)
	Set last change user.
	getLastChangeUser ()
	Get last change user.
	_existsAndNotEmpty ($a_parent_type, $a_id)
	checks whether page exists and is not empty (may return true on some empty pages)
	buildDom ($a_force=false)
	freeDom ()
&	getDom ()
	setId ($a_id)
	set id
	getId ()
	setParentId ($a_id)
	getParentId ()
	setParentType ($a_type)
	getParentType ()
	addUpdateListener (&$a_object, $a_method, $a_parameters="")
	callUpdateListeners ()
	setActive ($a_active)
	set activation
	getActive ($a_check_scheduled_activation=false)
	get activation
	_lookupActive ($a_id, $a_parent_type, $a_check_scheduled_activation=false)
	lookup activation status
	_writeActive ($a_id, $a_parent_type, $a_active, $a_reset_scheduled_activation=true)
	write activation status
	_writeParentId ($a_parent_type, $a_pg_id, $a_par_id)
	Write parent id.
	setActivationStart ($a_activationstart)
	Set Activation Start.
	getActivationStart ()
	Get Activation Start.
	setActivationEnd ($a_activationend)
	Set Activation End.
	getActivationEnd ()
	Get Activation End.
&	getContentObject ($a_hier_id, $a_pc_id="")
	Get a content object of the page.
&	getContentNode ($a_hier_id, $a_pc_id="")
	Get content node from dom.
	checkForTag ($a_content_tag, $a_hier_id, $a_pc_id="")
	Get content node from dom.
	lookforhier ($a_hier_id)
&	getNode ()
	setXMLContent ($a_xml, $a_encoding="UTF-8")
	set xml content of page, start with <PageObject...>, end with </PageObject>, comply with ILIAS DTD, omit MetaData, use utf-8!
	appendXMLContent ($a_xml)
	append xml content to page setXMLContent must be called before and the same encoding must be used
	getXMLContent ($a_incl_head=false)
	get xml content of page
	copyXmlContent ()
	Copy content of page; replace page components with copies where necessary (e.g.
	handleCopiedContent ($a_dom, $a_self_ass=true)
	Handle copied content.
	newIIMCopies ($temp_dom)
	Replaces media objects in interactive images with copies of the interactive images.
	newQuestionCopies (&$temp_dom)
	Replaces existing question content elements with new copies.
	removeQuestions (&$temp_dom)
	Remove questions from document.
	countPageContents ()
	Remove questions from document.
	getXMLFromDom ($a_incl_head=false, $a_append_mobs=false, $a_append_bib=false, $a_append_str="", $a_omit_pageobject_tag=false)
	get xml content of page from dom (use this, if any changes are made to the document)
	getLanguageVariablesXML ()
	get language variables as XML
	appendLangVarXML (&$xml, $var)
	getFirstParagraphText ()
	setParagraphContent ($a_hier_id, $a_content)
	Set content of paragraph.
	setContainsIntLink ($a_contains_link)
	lm parser set this flag to true, if the page contains intern links (this method should only be called by the import parser)
	containsIntLink ()
	returns true, if page was marked as containing an intern link (via setContainsIntLink) (this method should only be called by the import parser)
	needsImportParsing ($a_parse="")
	setContainsQuestion ($a_val)
	Set contains question.
	getContainsQuestion ()
	Get contains question.
	getBibliographyXML ()
	get a xml string that contains all Bibliography elements, that are referenced by any bibitem alias in the page
	collectMediaObjects ($a_inline_only=true)
	get all media objects, that are referenced and used within the page
	getInternalLinks ($a_cnt_multiple=false)
	get all internal links that are used within the page
	collectFileItems ($a_xml="")
	get all file items that are used within the page
	getMultimediaXML ()
	get a xml string that contains all media object elements, that are referenced by any media alias in the page
	getMediaAliasElement ($a_mob_id, $a_nr=1)
	get complete media object (alias) element
	validateDom ()
	Validate the page content agains page DTD.
	addHierIDs ()
	Add hierarchical ID (e.g.
	getHierIds ()
	get all hierarchical ids
	getFirstRowIds ()
	get ids of all first table rows
	getFirstColumnIds ()
	get ids of all first table columns
	getListItemIds ()
	get ids of all list items
	getFileItemIds ()
	get ids of all file items
	stripHierIDs ()
	strip all hierarchical id attributes out of the dom tree
	getHierIdsForPCIds ($a_pc_ids)
	Get hier ids for a set of pc ids.
	addFileSizes ()
	add file sizes
	resolveIntLinks ()
	Resolves all internal link targets of the page, if targets are available (after import)
	resolveMediaAliases ($a_mapping)
	Resolve media aliases (after import)
	resolveIIMMediaAliases ($a_mapping)
	Resolve iim media aliases (in ilContObjParse)
	resolveFileItems ($a_mapping)
	Resolve file items (after import)
	resolveQuestionReferences ($a_mapping)
	Resolve all quesion references (after import)
	moveIntLinks ($a_from_to)
	Move internal links from one destination to another.
	handleImportRepositoryLink ($a_rep_import_id, $a_rep_type, $a_rep_ref_id)
	createFromXML ()
	create new page object with current xml content
	updateFromXML ()
	updates page object with current xml content
	saveMetaKeywords ($a_xml)
	save all keywords
	saveMobUsage ($a_xml, $a_old_nr=0)
	save all usages of media objects (media aliases, media objects, internal links)
	saveFileUsage ($a_xml="", $a_old_nr=0)
	save file usages
	saveContentIncludeUsage ($a_xml="", $a_old_nr=0)
	save content include usages
	collectContentIncludes ($a_xml="")
	get all content includes that are used within the page
	saveSkillUsage ($a_xml="", $a_old_nr=0)
	save content include usages
	collectSkills ($a_xml="")
	get all content includes that are used within the page
	saveStyleUsage ($a_xml, $a_old_nr=0)
	Save all style class/template usages.
	getLastUpdateOfIncludedElements ()
	Get last update of included elements (media objects and files).
	saveInternalLinks ($a_xml)
	save internal links of page
	saveAnchors ($a_xml)
	save anchors
	deleteContent ($a_hid, $a_update=true, $a_pcid="")
	delete content object with hierarchical id $a_hid
	deleteContents ($a_hids, $a_update=true, $a_self_ass=false)
	Delete multiple content objects.
	cutContents ($a_hids)
	Copy contents to clipboard and cut them from the page.
	copyContents ($a_hids)
	Copy contents to clipboard.
	pasteContents ($a_hier_id, $a_self_ass=false)
	Paste contents from pc clipboard.
	switchEnableMultiple ($a_hids, $a_update=true, $a_self_ass=false)
	(De-)activate elements
	deleteContentFromHierId ($a_hid, $a_update=true)
	delete content object with hierarchical id >= $a_hid
	deleteContentBeforeHierId ($a_hid, $a_update=true)
	delete content object with hierarchical id < $a_hid
	_moveContentAfterHierId (&$a_source_page, &$a_target_page, $a_hid)
	move content of hierarchical id >= $a_hid to other page
	insertContent (&$a_cont_obj, $a_pos, $a_mode=IL_INSERT_AFTER, $a_pcid="")
	insert a content node before/after a sibling or as first child of a parent
	insertContentNode (&$a_cont_node, $a_pos, $a_mode=IL_INSERT_AFTER, $a_pcid="")
	insert a content node before/after a sibling or as first child of a parent
	moveContentBefore ($a_source, $a_target, $a_spcid="", $a_tpcid="")
	move content object from position $a_source before position $a_target (both hierarchical content ids)
	moveContentAfter ($a_source, $a_target, $a_spcid="", $a_tpcid="")
	move content object from position $a_source before position $a_target (both hierarchical content ids)
	bbCode2XML (&$a_content)
	transforms bbCode to corresponding xml
	insertInstIntoIDs ($a_inst, $a_res_ref_to_obj_id=true)
	inserts installation id into ids (e.g.
	highlightText ($a_text, $proglang, $autoindent)
	Highligths Text with given ProgLang.
	hasHighlighter ($hfile_ext)
	insertSourceCodeParagraphs ($a_output, $outputmode="presentation")
	depending on the SubCharacteristic and ShowLineNumbers attribute the line numbers and html tags for the syntax highlighting will be inserted using the dom xml functions
	checkPCIds ()
	Check, whether (all) page content hashes are set.
	getAllPCIds ()
	Get all pc ids.
	existsPCId ($a_pc_id)
	existsPCId
	generatePcId ($a_pc_ids=false)
	Generate new pc id.
	insertPCIds ()
	Insert Page Content IDs.
	getPageContentsHashes ()
	Get page contents hashes.
	getQuestionIds ()
	Get question ids.
	send_paragraph ($par_id, $filename)
	getFO ()
	get fo page content
	registerOfflineHandler ($handler)
	_lookupContainsDeactivatedElements ($a_id, $a_parent_type)
	lookup whether page contains deactivated elements
	containsDeactivatedElements ($a_content)
	Check whether content contains deactivated elements.
	getHistoryEntries ()
	Get History Entries.
	getHistoryEntry ($a_old_nr)
	Get History Entry.
	getHistoryInfo ($a_nr)
	Get information about a history entry, its predecessor and its successor.
	addChangeDivClasses ($a_hashes)
	compareVersion ($a_left, $a_right)
	Compares to revisions of the page.
	increaseViewCnt ()
	increase view cnt
	writeRenderedContent ($a_content, $a_md5)
	Write rendered content.
	containsIntLinks ($a_content)
	Check whether content contains internal links.
	performAutomaticModifications ()
	Perform automatic modifications (may be overwritten by sub classes)

Static Public Member Functions
static	deleteAllBlogPostings ($a_blog_id)
	Delete all postings for blog.
static	lookupBlogId ($a_posting_id)
	Lookup blog id.
static	getAllPostings ($a_blog_id, $a_limit=100, $a_offset=0)
	Get all postings of blog.
static	exists ($a_blog_id, $a_posting_id)
	Checks whether a posting exists.
static	getLastPost ($a_blog_id)
	Get newest posting for blog.
Static Public Member Functions inherited from ilPageObject
static	_exists ($a_parent_type, $a_id)
	checks whether page exists
static	_isScheduledActivation ($a_id, $a_parent_type)
	Check whether page is activated by time schedule.
static	lookupParentId ($a_id, $a_type)
	Lookup parent id.
static	_handleImportRepositoryLinks ($a_rep_import_id, $a_rep_type, $a_rep_ref_id)
	Change targest of repository links.
static	_getQuestionIdsForPage ($a_parent_type, $a_page_id)
	Get all questions of a page.
static	_deleteAnchors ($a_parent_type, $a_page_id)
	Delete anchors of a page.
static	_saveAnchor ($a_parent_type, $a_page_id, $a_anchor_name)
	Save an anchor.
static	_readAnchors ($a_parent_type, $a_page_id)
	Read anchors of a page.
static	getRecentChanges ($a_parent_type, $a_parent_id, $a_period=30)
	Get recent pages changes for parent object.
static	getAllPages ($a_parent_type, $a_parent_id)
	Get all pages for parent object.
static	getNewPages ($a_parent_type, $a_parent_id)
	Get new pages.
static	getParentObjectContributors ($a_parent_type, $a_parent_id)
	Get all contributors for parent object.
static	getPageContributors ($a_parent_type, $a_page_id)
	Get all contributors for parent object.
static	getPagesWithLinks ($a_parent_type, $a_parent_id)
	Get all pages for parent object that contain internal links.

Protected Attributes
	$title
	$created
	$blog_wsp_id

Additional Inherited Members
Data Fields inherited from ilPageObject
	$id
	$ilias
	$dom
	$xml
	$encoding
	$node
	$cur_dtd = "ilias_pg_4_2.dtd"
	$contains_int_link
	$needs_parsing
	$parent_type
	$parent_id
	$update_listeners
	$update_listener_cnt
	$offline_handler
	$dom_builded
	$history_saved
	$layout_mode
Static Public Attributes inherited from ilPageObject
static	$exists = array()

Detailed Description

Class ilBlogPosting.

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

Definition at line 14 of file class.ilBlogPosting.php.

Constructor & Destructor Documentation

ilBlogPosting::__construct	(		$a_id = 0,
			$a_old_nr = 0,
			$a_halt = true
	)

Constructor.

Parameters

int	$a_id	blog posting id
int	$a_old_nr	versioning
bool	$a_halt	halt on errors

Returns

ilBlogPosting

Definition at line 28 of file class.ilBlogPosting.php.

        {
                parent::__construct("blp", $a_id, $a_old_nr, $a_halt);
        }

Member Function Documentation

ilBlogPosting::create

(

)

Create new blog posting.

Reimplemented from ilPageObject.

Definition at line 96 of file class.ilBlogPosting.php.

References ilPageObject\$id, $ilDB, $query, getBlogId(), ilPageObject\getId(), getTitle(), ilUtil\now(), and ilPageObject\setId().

        {
                global $ilDB;

                $id = $ilDB->nextId("il_blog_posting");
                $this->setId($id);

                // we are using a separate creation date to enable sorting without JOINs
                
                $query = "INSERT INTO il_blog_posting (id, title, blog_id, created) VALUES (".
                        $ilDB->quote($this->getId(), "integer").",".
                        $ilDB->quote($this->getTitle(), "text").",".
                        $ilDB->quote($this->getBlogId(), "integer").",".
                        $ilDB->quote(ilUtil::now(), "timestamp").")";
                $ilDB->manipulate($query);

                parent::create();
                // $this->saveInternalLinks($this->getXMLContent());
        }

Here is the call graph for this function:

ilBlogPosting::delete

(

)

Delete blog posting and all related data.

Returns

bool

Reimplemented from ilPageObject.

Definition at line 171 of file class.ilBlogPosting.php.

References $ilDB, $query, and ilPageObject\getId().

        {
                global $ilDB;

                $query = "DELETE FROM il_blog_posting".
                        " WHERE id = ".$ilDB->quote($this->getId(), "integer");
                $ilDB->manipulate($query);
                
                parent::delete();

                return true;
        }

Here is the call graph for this function:

static ilBlogPosting::deleteAllBlogPostings (   $a_blog_id )

static

Delete all postings for blog.

Parameters

int

$a_blog_id

Definition at line 189 of file class.ilBlogPosting.php.

References $ilDB, and $query.

Referenced by ilObjBlog\doDelete().

        {
                global $ilDB;
                
                $query = "SELECT * FROM il_blog_posting".
                        " WHERE blog_id = ".$ilDB->quote($a_blog_id, "integer");
                $set = $ilDB->query($query);
                while($rec = $ilDB->fetchAssoc($set))
                {
                        $post = new ilBlogPosting($rec["id"]);
                        $post->delete();
                }
        }

Here is the caller graph for this function:

static ilBlogPosting::exists (   $a_blog_id,   $a_posting_id  )

static

Checks whether a posting exists.

Parameters

int	$a_blog_id
int	$a_posting_id

Returns

bool

Definition at line 267 of file class.ilBlogPosting.php.

References $ilDB, and $query.

        {
                global $ilDB;

                $query = "SELECT id FROM il_blog_posting".
                        " WHERE blog_id = ".$ilDB->quote($a_blog_id, "integer").
                        " AND id = ".$ilDB->quote($a_posting_id, "integer");
                $set = $ilDB->query($query);
                if($rec = $ilDB->fetchAssoc($set))
                {
                        return true;
                }
                return false;
        }

static ilBlogPosting::getAllPostings (   $a_blog_id,   $a_limit = 100,   $a_offset = 0  )

static

Get all postings of blog.

Parameters

int	$a_blog_id
int	$a_limit
int	$a_offset

Returns

array

Definition at line 231 of file class.ilBlogPosting.php.

References $ilDB, $query, ilPageObject\getAllPages(), and IL_CAL_DATETIME.

Referenced by ilObjBlogGUI\buildPostingList(), ilObjBlogGUI\exportHTMLPages(), getLastPost(), and ilPCBlogGUI\initPostingForm().

        {
                global $ilDB;
                
                $pages = parent::getAllPages("blp", $a_blog_id);

                if($limit)
                {
                        $ilDB->setLimit($a_limit, $a_offset);
                }
                
                $query = "SELECT * FROM il_blog_posting".
                        " WHERE blog_id = ".$ilDB->quote($a_blog_id, "integer").
                        " ORDER BY created DESC";
                $set = $ilDB->query($query);
                $post = array();
                while($rec = $ilDB->fetchAssoc($set))
                {
                        if (isset($pages[$rec["id"]]))
                        {
                                $post[$rec["id"]] = $pages[$rec["id"]];
                                $post[$rec["id"]]["title"] = $rec["title"];
                                $post[$rec["id"]]["created"] = new ilDateTime($rec["created"], IL_CAL_DATETIME);
                        }
                }

                return $post;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBlogPosting::getBlogId

(

)

Get blog object id.

Returns

int

Definition at line 68 of file class.ilBlogPosting.php.

References ilPageObject\getParentId().

Referenced by create().

        {
                return $this->getParentId();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBlogPosting::getCreated

(

)

Get creation date.

Returns

ilDateTime

Definition at line 88 of file class.ilBlogPosting.php.

References $created.

        {
                return $this->created;
        }

static ilBlogPosting::getLastPost (   $a_blog_id )

static

Get newest posting for blog.

Parameters

int

$a_blog_id

Returns

int

Definition at line 288 of file class.ilBlogPosting.php.

References $data, and getAllPostings().

        {
                $data = self::getAllPostings($a_blog_id, 1);
                if($data)
                {
                        return array_pop(array_keys($data));
                }
        }

Here is the call graph for this function:

ilBlogPosting::getTitle

(

)

Get title.

Returns

string

Definition at line 48 of file class.ilBlogPosting.php.

References $title.

Referenced by create(), and update().

        {
                return $this->title;
        }

Here is the caller graph for this function:

static ilBlogPosting::lookupBlogId (   $a_posting_id )

static

Lookup blog id.

Parameters

int

$a_posting_id

Returns

int

Definition at line 209 of file class.ilBlogPosting.php.

References $ilDB, and $query.

        {
                global $ilDB;

                $query = "SELECT blog_id FROM il_blog_posting".
                        " WHERE id = ".$ilDB->quote($a_posting_id, "integer");
                $set = $ilDB->query($query);
                if ($rec = $ilDB->fetchAssoc($set))
                {
                        return $rec["blog_id"];
                }
                return false;
        }

ilBlogPosting::read

(

)

Read blog posting.

Reimplemented from ilPageObject.

Definition at line 149 of file class.ilBlogPosting.php.

References $ilDB, $query, ilPageObject\getId(), IL_CAL_DATETIME, setBlogId(), setCreated(), and setTitle().

        {
                global $ilDB;
                
                $query = "SELECT * FROM il_blog_posting".
                        " WHERE id = ".$ilDB->quote($this->getId(), "integer");
                $set = $ilDB->query($query);
                $rec = $ilDB->fetchAssoc($set);

                $this->setTitle($rec["title"]);
                $this->setBlogId($rec["blog_id"]);
                $this->setCreated(new ilDateTime($rec["created"], IL_CAL_DATETIME));
        
                parent::read();
        }

Here is the call graph for this function:

ilBlogPosting::setBlogId

(

$a_id

)

Set blog object id.

Parameters

int

$a_id

Definition at line 58 of file class.ilBlogPosting.php.

References ilPageObject\setParentId().

Referenced by read().

        {
                $this->setParentId($a_id);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilBlogPosting::setBlogWspId

(

$a_id

)

Set blog wsp id (needed for notification)

Parameters

int

$a_id

Definition at line 302 of file class.ilBlogPosting.php.

        {
                $this->blog_wsp_id = (int)$a_id;
        }

ilBlogPosting::setCreated

(

ilDateTime

$a_date

)

Set creation date.

Parameters

ilDateTime

$a_date

Definition at line 78 of file class.ilBlogPosting.php.

Referenced by read().

        {
                $this->created = $a_date;
        }

Here is the caller graph for this function:

ilBlogPosting::setTitle

(

$a_title

)

Set title.

Parameters

string

$a_title

Definition at line 38 of file class.ilBlogPosting.php.

Referenced by read().

        {
                $this->title = $a_title;
        }

Here is the caller graph for this function:

ilBlogPosting::update	(		$a_validate = true,
			$a_no_history = false,
			$a_notify = true
	)

Update blog posting.

Parameters

bool	$a_validate
bool	$a_no_history
bool	$a_notify

Returns

boolean

Reimplemented from ilPageObject.

Definition at line 124 of file class.ilBlogPosting.php.

References $ilDB, $query, ilPageObject\getActive(), ilPageObject\getId(), getTitle(), and ilObjBlog\sendNotification().

        {
                global $ilDB;

                // blog_id and created cannot be changed
                
                $query = "UPDATE il_blog_posting SET".
                        " title = ".$ilDB->quote($this->getTitle(), "text").
                        " WHERE id = ".$ilDB->quote($this->getId(), "integer");
                $ilDB->manipulate($query);
                
                parent::update($a_validate, $a_no_history);
                
                if($a_notify && $this->getActive())
                {
                        include_once "Modules/Blog/classes/class.ilObjBlog.php";
                        ilObjBlog::sendNotification("update", $this->blog_wsp_id, $this->getId());
                }

                return true;
        }

Here is the call graph for this function:

Field Documentation

ilBlogPosting::$blog_wsp_id

protected

Definition at line 18 of file class.ilBlogPosting.php.

ilBlogPosting::$created

protected

Definition at line 17 of file class.ilBlogPosting.php.

Referenced by getCreated().

ilBlogPosting::$title

protected

Definition at line 16 of file class.ilBlogPosting.php.

Referenced by getTitle().

---

The documentation for this class was generated from the following file:

• Modules/Blog/classes/class.ilBlogPosting.php