autoindex
in package
PX Commands "autoindex"
Table of Contents
- $func_data_memos : mixed
- 機能別に値を記憶する領域
- $options : mixed
- プラグインオプション
- $px : mixed
- Picklesオブジェクト
- __construct() : mixed
- constructor
- apply_autoindex() : string
- ページ内の目次をソースに反映する。
- exec() : mixed
- extensions function
Properties
$func_data_memos
機能別に値を記憶する領域
private
mixed
$func_data_memos
= '\\<\\!\\-\\-\\s*autoindex\\s*\\-\\-\\>'
$options
プラグインオプション
private
mixed
$options
$px
Picklesオブジェクト
private
mixed
$px
Methods
__construct()
constructor
public
__construct(object $px, mixed $options) : mixed
Parameters
- $px : object
-
Picklesオブジェクト
- $options : mixed
Return values
mixed —apply_autoindex()
ページ内の目次をソースに反映する。
public
apply_autoindex(string $content) : string
マーク文字列 <!-- autoindex --> を、自動生成した目次に置き換えます。
目次は、<hx> タグを検出し、自動的に生成されます。
マーク文字列が検出されない場合は、何も行わず処理をスキップします。
Parameters
- $content : string
-
予告状態の コンテンツ HTMLソース
Return values
string —目次が反映されたHTMLソース
exec()
extensions function
public
static exec([object $px = null ][, object $options = null ]) : mixed
Parameters
- $px : object = null
-
Picklesオブジェクト
- $options : object = null
-
オプション