Design_Area_Edit_Fns Class Reference

Inheritance diagram for Design_Area_Edit_Fns:

Public Member Functions
	__construct ()
	paintIdName (Design_Area $asset, Backend_Outputter $o, $prefix)
	_parseString ($file_contents)
	_processContents (Design_Area $asset, Array $contents)
Public Member Functions inherited from Asset_Edit_Fns
	Asset_Edit_Fns ()
	paintPaths (&$asset, &$o, $prefix)
	paintEditRemapURLs (&$asset, &$o, $prefix)
	processPaths (&$asset, &$o, $prefix)
	processEditRemapURLs (&$asset, &$o, $prefix)
	paintURLs (&$asset, &$o, $prefix)
	paintAddRemapURLs (&$asset, &$o, $prefix)
	processAddRemapURLs (&$asset, &$o, $prefix)
	isWorkflowComplete (&$asset)
	paintNoticeLinkedAsset (&$asset, $link_value, $type_codes=Array(), $field_name='', $multiple=FALSE)
	processNoticeLinkedAsset (&$asset, $link_value, $field_name='', $multiple=FALSE)
	isSearchInstalled (&$asset, $prefix)
	isBeingCreated (&$asset)
	isNotBeingCreated (&$asset)
	paintAutomaticRemapSetting (&$asset, &$o, $prefix)
	paintCreateLink (&$asset, &$o, $prefix)
Public Member Functions inherited from MySource_Object
	MySource_Object ()
	__sleep ()
	__wakeup ()

Data Fields
	$tag_name = 'MySource'
Data Fields inherited from Asset_Edit_Fns
	$static_screens
Data Fields inherited from MySource_Object
	$_tmp

Protected Member Functions
	_parseStringContents (&$file_contents, &$cur_pos, &$nest_level)
	_tagToParse (&$file_contents, &$cur_pos)
	_parseOpenTag (&$file_contents, &$cur_pos)
	_parseTerminateTag (&$file_contents, &$cur_pos)
	_isWhitespace ($str)
	_setVariables (Design_Area &$asset, Array &$contents)
	_removeFileRoot ($str)
	_getDefaultContents (Design_Area $asset, $content_type)

Detailed Description

Definition at line 31 of file design_area_edit_fns.inc.

Constructor & Destructor Documentation

__construct

(

)

Contructor

Definition at line 45 of file design_area_edit_fns.inc.

Member Function Documentation

_getDefaultContents ( Design_Area  $asset,   $content_type  )

protected

Returns a default contents for the passed type

Can be used when there is no contents supplied in parse file

Parameters

Design_Area	$asset	the asset to which we belong
string	$content_type	the name that forms the filename 'default_'.$content_type.'_contents.html' in the asset types directory

Returns

array private

See Also

_parseString()

_processContents()

Definition at line 569 of file design_area_edit_fns.inc.

_isWhitespace (   $str )

protected

Return TRUE if the whole string is whitespace of some kind

Parameters

string

$str

The string to check

Returns

boolean private

Definition at line 406 of file design_area_edit_fns.inc.

_parseOpenTag ( &  $file_contents, &  $cur_pos  )

protected

Parse all the info from the start of the open tag until its end

Also assigns any attributes that the tag may have contained

Parameters

string	&$file_contents	the raw contents to parse file
int	&$cur_pos	the current position in $file_contents that we are

Returns

array private

Definition at line 271 of file design_area_edit_fns.inc.

_parseString

(

$file_contents

)

Parse the string into an array recursively cut up into html and tag pieces

Parameters

string

$file_contents

the contents to parse

Returns

array public

Definition at line 79 of file design_area_edit_fns.inc.

_parseStringContents ( &  $file_contents, &  $cur_pos, &  $nest_level  )

protected

Take the raw contents passed in and create individual elements for each section of the contents (HTML or this->tag_name tag) if code is nested between open and terminate tags this function is called recursivley

Parameters

string	&$file_contents	the raw contents to parse file
int	&$cur_pos	the current position in $file_contents that we are
int	&$nest_level	the current position in $file_contents that we are

Returns

array private

Definition at line 128 of file design_area_edit_fns.inc.

_parseTerminateTag ( &  $file_contents, &  $cur_pos  )

protected

Keep counting the characters until we hit a close bracket

Parameters

string	&$file_contents	the raw contents to parse file
int	&$cur_pos	the current position in $file_contents that we are

Returns

void private

Definition at line 387 of file design_area_edit_fns.inc.

_processContents	(	Design_Area	$asset,
		Array	$contents
	)

Loop through the contents array and create the necessary objects

Parameters

Design_Area	$asset	the asset to which we belong
array	$contents	the contents array we generated with _parseString()

Returns

boolean private

Definition at line 422 of file design_area_edit_fns.inc.

_removeFileRoot (   $str )

protected

Remove any image roots from the front of the string

Replace any './[folder/filename]' with '[folder/filename]'

Parameters

string

$str

the string to remove any image root from

Returns

string private

Definition at line 549 of file design_area_edit_fns.inc.

_setVariables ( Design_Area &  $asset, Array &  $contents  )

protected

Takes the reference to the tag array passed into created by _parseStringContents() and sets both the attributes and sets operation tags into values the set tags are then removed from the array

Also anything with 'image' contained in it will have the file root removed from its value

Parameters

Design_Area	$asset	the asset to which we belong
array	&$contents	the contents array from _parseString

Returns

boolean private

Definition at line 448 of file design_area_edit_fns.inc.

_tagToParse ( &  $file_contents, &  $cur_pos  )

protected

Figure out which type of tag (open or terminate) comes next in the text

Returns the type and sets the current position to the start of the tag

Parameters

string	&$file_contents	the raw contents to parse file
int	&$cur_pos	the current position in $file_contents that we are

Returns

string private

Definition at line 230 of file design_area_edit_fns.inc.

paintIdName	(	Design_Area	$asset,
		Backend_Outputter	$o,
			$prefix
	)

Echo the Design Area's ID name

Parameters

Design_Area	$asset	the asset whose interface we are painting
Backend_Outputter	$o	the outputter class
string	$prefix	prefix for the form element

Returns

void public

Definition at line 63 of file design_area_edit_fns.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/core/assets/designs/design_area/design_area_edit_fns.inc