com.arcadiangarden.ssx.struct
[ class tree: com.arcadiangarden.ssx.struct ] [ index: com.arcadiangarden.ssx.struct ] [ all elements ]
Packages:
com.arcadiangarden.ssx.calendar
com.arcadiangarden.ssx.logbook
com.arcadiangarden.ssx.struct
core
pure.db.datasource
pure.db.oci8
pure.db.util
pure.fw.brownie
pure.fw.filter.final
pure.fw.rss
pure.fw.taglib
pure.sendmail
pure.session
pure.util


Files:
StructDirectory.inc
StructDocument.inc
StructDocumentList.inc
StructDocumentNavigator.inc
StructLink.inc
StructNavigator.inc

Classes:
Struct_Directory
Struct_Document
Struct_DocumentList
Struct_DocumentNavigator
Struct_Link
Struct_Navigator

Class: Struct_Link

Source Location: /package/com/arcadiangarden/ssx/struct/StructLink.inc

Class Overview

PURE_Class
   |
   --Struct_Link

リンクの情報を保持するクラスです。

Methods

Class Details

[line 34]
リンクの情報を保持するクラスです。

リンクの情報は、Structクラスで管理されるナビゲーションの起点からの相対リンクで保持されます。 Struct_Linkクラスは"up"や"prev"などのリンクの性質(rel属性)、リンク先URL(href属性)ともそのキャプションで構成されます。 AエレメントやLINKエレメントを生成する能力を持ちます。




[ Top ]

Class Methods

constructor __construct [line 64]

Struct_Link __construct( string $rel, string $href, string $caption)

コンストラクタです。



Tags:

access:  public


Parameters:

string   $rel   リンク先の論理的位置属性を表すrel属性の値
string   $href   リンク先リソースを表すhref属性の値
string   $caption   リンク先リソースのキャプション

[ Top ]

method getCaption [line 116]

string getCaption( )

リンク先リソースのキャプションを取得します。



Tags:

return:  リンク先リソースのキャプション
access:  public


[ Top ]

method getHref [line 96]

string getHref( )

リンク先リソースを表すhref属性の値を取得します。



Tags:

return:  リンク先リソースを表すhref属性の値
access:  public


[ Top ]

method getRel [line 76]

string getRel( )

リンク先の論理的位置属性を表すrel属性の値の値を取得します。



Tags:

return:  リンク先の論理的位置属性を表すrel属性の値
access:  public


[ Top ]

method makeAnchor [line 142]

string makeAnchor( [bool $excludeIndexFile = true])

アンカーを作成して返します。

返される値はhref属性値にリンクするアンカーで、<A href="*">～</A>の形式になります。 href属性値、キャプション共に設定されていない場合には空の文字列を返します。 href属性値のみが設定されている場合にはアンカー修飾されるキャプションもhref属性値になります。 キャプションのみが設定されている場合にはアンカー修飾されずにキャプションのみを返します。




Tags:

return:  作成したアンカー
access:  public


Parameters:

bool   $excludeIndexFile   パスの末尾から標準のドキュメントのファイル名を削除するか否か

[ Top ]

method makeLink [line 171]

string makeLink( [bool $excludeIndexFile = true])

リンクを作成して返します。

返される値はhref属性値へのリンクで、<LINK rel="*" href="*" title="～">の形式になります。 href属性値が設定されていない場合には空の文字列を返します。 rel属性値が設定されいない場合には"alternate"が設定されます。 キャプションが設定されていない場合にはtitle属性は出力されません。




Tags:

return:  作成したリンク
access:  public


Parameters:

bool   $excludeIndexFile   パスの末尾から標準のドキュメントのファイル名を削除するか否か

[ Top ]

method setCaption [line 126]

void setCaption( string $caption)

リンク先リソースのキャプションを設定します。



Tags:

access:  public


Parameters:

string   $caption   リンク先リソースのキャプション

[ Top ]

method setHref [line 106]

void setHref( string $href)

リンク先リソースを表すhref属性の値を設定します。



Tags:

access:  public


Parameters:

string   $href   リンク先リソースを表すhref属性の値

[ Top ]

method setRel [line 86]

void setRel( string $rel)

リンク先の論理的位置属性を表すrel属性の値の値を設定します。



Tags:

access:  public


Parameters:

string   $rel   リンク先の論理的位置属性を表すrel属性の値

[ Top ]

Documentation generated on Sun, 06 Jan 2008 01:33:31 +0900 by phpDocumentor 1.3.2