Find-Movies.ps1

something exciting

Some information about the exciting thing

Table of contents generated with markdown-toc


Script

function Find-Movies
{
	<#
	.SYNOPSIS
		A function to search for files

	.DESCRIPTION
		A function to search for files.

		Searches are performed by passing the parameters to Get-Childitem which will then
		recursively search through your specified file path and then perform a sort to output
		the most recently amended files at the top of the list.

		Outputs inlcude the Name,DirectoryName and FullName

		Name                        DirectoryName                                       FullName
		----                        -------------                                       --------
		Get-PublicDnsRecord.ps1     C:\GitRepos\scripts-blog\PowerShell\functions\dns   C:\GitRepos\scripts-blog\PowerShell\functions\dns\Get-PublicDnsRecord.ps1

		If the extension is not provided it defaults to searching for PS1 files (PowerShell Scripts).

		Using the switch you can choose to search the start or end of the file or selecting wild,
		will perform a wildcard search using your searchterm.

	.PARAMETER Path
		Species the search path. The search will perform a recursive search on the specified folder path.

	.PARAMETER SearchTerm
		Specifies the search string. This will define the text that the search will use to locate your files. Wildcard chars are not allowed.

	.PARAMETER SearchType
		Specifies the type of search perfomed. Options are Start, End or Wild. This will search either the beginning, end or somewhere inbetween. If no option is selected, it will default to performing a wildcard search.

	.PARAMETER Extension
		Specifies the extension. ".ps1" is the default. You can tab complete through the suggested list or you can enter your own file extension e.g. ".jpg"

	.EXAMPLE
		Search-Scripts -Path .\scripts-blog\PowerShell\ -SearchTerm dns -SearchType Wild -Extension .ps1

		Name                        DirectoryName                                       FullName
		----                        -------------                                       --------
		Get-PublicDnsRecord.ps1     C:\GitRepos\scripts-blog\PowerShell\functions\dns   C:\GitRepos\scripts-blog\PowerShell\functions\dns\Get-PublicDnsRecord.ps1

		Recursively scans the folder path looking for all files containing the searchterm and lists the files located in the output

	.OUTPUTS
		System.String. Search-Scripts returns a string with the extension or file name.

		Name                        DirectoryName                                       FullName
		----                        -------------                                       --------
		Get-PublicDnsRecord.ps1     C:\GitRepos\scripts-blog\PowerShell\functions\dns   C:\GitRepos\scripts-blog\PowerShell\functions\dns\Get-PublicDnsRecord.ps1

	.NOTES
		Author:     Luke Leigh
		Website:    https://scripts.lukeleigh.com/
		LinkedIn:   https://www.linkedin.com/in/lukeleigh/
		GitHub:     https://github.com/BanterBoy/
		GitHubGist: https://gist.github.com/BanterBoy

	.INPUTS
		You can pipe objects to these perameters.

		- Path [string]
		- SearchTerm [string]
		- Extension [string]
		- SearchType [string]

	.LINK
		https://github.com/BanterBoy/scripts-blog
		Get-Childitem
		Select-Object
#>
	[CmdletBinding(DefaultParameterSetName = 'Default',
				   PositionalBinding = $true,
				   SupportsShouldProcess = $true)]
	[OutputType([string], ParameterSetName = 'Default')]
	[OutputType([string])]
	param
	(
		[Parameter(ParameterSetName = 'Default',
				   Mandatory = $true,
				   ValueFromPipeline = $true,
				   ValueFromPipelineByPropertyName = $true,
				   Position = 0,
				   HelpMessage = 'Enter the base path you would like to search.')]
		[ValidateNotNullOrEmpty()]
		[Alias('PSPath')]
		[string]$Path,
		[Parameter(ParameterSetName = 'Default',
				   Mandatory = $true,
				   ValueFromPipeline = $true,
				   ValueFromPipelineByPropertyName = $true,
				   Position = 1,
				   HelpMessage = 'Enter the text you would like to search for.')]
		[ValidateNotNullOrEmpty()]
		[string]$SearchTerm,
		[Parameter(ParameterSetName = 'Default',
				   Mandatory = $false,
				   ValueFromPipeline = $true,
				   ValueFromPipelineByPropertyName = $true,
				   Position = 2,
				   HelpMessage = 'Select the type of search. You can select Start/End/Wild to perform search for a file.')]
		[ValidateSet('Start', 'End', 'Wild')]
		[string]$SearchType
	)
	BEGIN
	{
	}
	PROCESS
	{
		if ($PSCmdlet.ShouldProcess("$($Path)", "Searching for files"))
		{
			try
			{
				switch ($SearchType)
				{
					Start {
						Get-ChildItem -Path $Path -Filter "$SearchTerm*" -Include '*.mp4', '*.avi', '*.mkv' -Recurse |
						Select-Object -Property Name, DirectoryName, FullName
					}
					End {
						Get-ChildItem -Path $Path -Filter "*$SearchTerm" -Include '*.mp4', '*.avi', '*.mkv' -Recurse |
						Select-Object -Property Name, DirectoryName, FullName
					}
					Wild {
						Get-ChildItem -Path $Path -Filter "*$SearchTerm*" -Include '*.mp4', '*.avi', '*.mkv' -Recurse |
						Select-Object -Property Name, DirectoryName, FullName
					}
					Default {
						Get-ChildItem -Path $Path -Filter "*$SearchTerm*" -Include '*.mp4', '*.avi', '*.mkv' -Recurse |
						Select-Object -Property Name, DirectoryName, FullName
					}
				}
			}
			catch
			{
				Write-Error "Unable to locate files on path $Path"
			}
		}
	}
	END
	{
	}
}

Back to Top

Download

Please feel free to copy parts of the script or if you would like to download the entire script, simple click the download button. You can download the complete repository in a zip file by clicking the Download link in the menu bar on the left hand side of the page.


Report Issues

You can report an issue or contribute to this site on GitHub. Simply click the button below and add any relevant notes. I will attempt to respond to all issues as soon as possible.

Issue


Back to Top